Update file .env.sample

rights-engine/.env.sample

-URL=localhost
-WEBSITE=polaris
-DB_PASSWORD=CHANGE_ME
-DJANGO_DEVELOPMENT=false
-DATABASE_NAME=polaris
+URL=localhost # url of the installation for traefik
+WEBSITE=polaris 
+DB_PASSWORD=CHANGE_ME # this should be the same as DATABASE_PASSWORD
+DJANGO_DEVELOPMENT=false # production should be false
+DATABASE_NAME=polaris 
 DATABASE_USER=root
-DATABASE_PASSWORD=CHANGE_ME
-DATABASE_HOST=database
-DEBUG=False
-LRS_HOST=http://learninglocker.digitallearning.gmbh:8080
-LRS_TOKEN=CHANGE_ME
-LRS_CONNECTION_STRING=mongodb://root:CHANGE_ME@127.0.0.1:27017
-LRS_MONGO_DB_NAME=lrs
-DATA_DISCLOSURE_EXPIRATION=30
-DATA_DISCLOSURE_LOCATION=/usr/src/app/backend/data_disclosure_zips
-EMAIL_HOST=
-EMAIL_PORT=
-EMAIL_HOST_USER=
-EMAIL_HOST_PASSWORD=
-REDIS_PASSWORD=CHANGE_ME
-CELERY_BROKER_URL=redis://:CHANGE_ME@redis:6379/0
-JWT_PUBLIC_KEY_PATH=backend/id_rsa.pub
-JWT_PRIVATE_KEY_PATH=backend/id_rsa
-IDP_SERVER=https://aai-test-v3.ruhr-uni-bochum.de
-IDP_ENABLED=false
-SP_HOST=polaris.digitallearning.gmbh
-PROVIDER_CONTEXTS_PULL_ENABLED=False
-PROVIDER_CONTEXTS_PULL_URL=https://example.com
-PROVIDER_CONTEXTS_PULL_TOKEN=CHANGE_ME
+DATABASE_PASSWORD=CHANGE_ME # this should be the same as DB_PASSWORD
+DATABASE_HOST=database 
+DEBUG=False 
+LRS_HOST=http://sample.com:8080 # not needed, if you use mongodb
+LRS_TOKEN=CHANGE_ME # not needed, if you use mongodb
+LRS_CONNECTION_STRING=mongodb://root:CHANGE_ME@127.0.0.1:27017 # connection string to the mongodb
+LRS_MONGO_DB_NAME=lrs # no changes needed
+DATA_DISCLOSURE_EXPIRATION=30 # number of days the data disclosures are deleted
+DATA_DISCLOSURE_LOCATION=/usr/src/app/backend/data_disclosure_zips # folder of the data disclosures in the docker container, no changes needed
+EMAIL_HOST= # host for email notification account
+EMAIL_PORT= # port for email notification account
+EMAIL_HOST_USER= # username for email notification account
+EMAIL_HOST_PASSWORD= # password for email notification account
+REDIS_PASSWORD=CHANGE_ME # redis password
+CELERY_BROKER_URL=redis://:CHANGE_ME@redis:6379/0 # change redis connection string to match REDIS_PASSWORD
+JWT_PUBLIC_KEY_PATH=backend/id_rsa.pub # path for jwt public key; see documentation 
+JWT_PRIVATE_KEY_PATH=backend/id_rsa # path for the jwt private key; see documentation
+IDP_SERVER=https://aai-test-v3.ruhr-uni-bochum.de # shibboleth url
+IDP_ENABLED=false # login via shibboleth
+SP_HOST=polaris.digitallearning.gmbh # redirect back url of the shibboleth 
+PROVIDER_CONTEXTS_PULL_ENABLED=False # if you like to use the feature, that courses or structures are pulled from moodle, enable that option here
+PROVIDER_CONTEXTS_PULL_URL=https://example.com # url of moodle
+PROVIDER_CONTEXTS_PULL_TOKEN=CHANGE_ME # token of the moodle plugin