search

sciapp / sampledb

Sample and Measurement Metadata Database
https://scientific-it-systems.iffgit.fz-juelich.de/SampleDB/
MIT License
21 stars 11 forks source link

Missing configuration options in docker-compose.dist #59

Closed NicolasCARPi closed 8 months ago

NicolasCARPi commented 8 months ago

Hello Florian,

When starting the container, it conveniently informs us that some variables are not set, and such functions are thus disabled.

LDAP authentication will be disabled, because the following configuration values are missing:
 - LDAP_UID_FILTER
 - LDAP_USER_BASE_DN
 - LDAP_OBJECT_DEF
 - LDAP_NAME_ATTRIBUTE
 - LDAP_NAME
 - LDAP_SERVER
 - LDAP_MAIL_ATTRIBUTE
JupyterHub integration will be disabled, because none of following configuration values are defined:
 - JUPYTERHUB_URL
 - JUPYTERHUB_TEMPLATES_URL
Dataverse export will be disabled, because the configuration value DATAVERSE_URL is missing.
SciCat export will be disabled, because the configuration value SCICAT_API_URL is missing.
Download service will be disabled, because the configuration value DOWNLOAD_SERVICE_URL is missing.

I'd suggest adding these (even commented out) to docker-compose.dist file so they can be described, where to get it, with an example value, if it's mandatory or optional, etc...

In fact I'd recommend being super verbose when describing ENV vars in that file, similar to:

https://github.com/elabftw/elabimg/blob/5e44a25ef6b4e496f67273fbe50ee98100d41bbb/src/docker-compose.yml-EXAMPLE#L191-L201

Cheers, ~Nico

FlorianRhiem commented 8 months ago

The README and the docker compose file contain the ones needed to run SampleDB, all others are found in the documentation. I don't think including all of them in the examples for running the docker containers will help more than it might confuse, especially as some features like JupyterHub integration are used by few installations, as far as I'm aware. I want to keep these example files simple, so I'll keep those variables out of there.

As for how to get the values for those, LDAP setups differ too greatly to suggest something specific, so I suppose people will have to ask whoever runs their LDAP server.

NicolasCARPi commented 8 months ago

Oh, I missed that entirely! Then I may suggest adding a link to the documentation in the stdout output.... and of course I realize that it is done already... So I have nothing to add and I'm closing this issue! :)