docs: environment and env file

Docker-compose/.env.example

@@ -0,0 +1,49 @@
+HOSTNAME=localhost
+
+# MongoDB authentication
+MONGO_DBUSER=satosa
+MONGO_DBPASSWORD=thatpassword
+
+# The path containing your secrets
+KEYS_FOLDER=./pki
+# Keys filename
+SATOSA_PRIVATE_KEY_FILENAME=privkey.pem
+SATOSA_PUBLIC_KEY=cert.pem
+
+# BE CAREFUL HERE!
+SATOSA_SALT=CHANGE_ME!
+SATOSA_ENCRYPTION_KEY=CHANGE_ME!
+SATOSA_STATE_ENCRYPTION_KEY=CHANGE_ME!
+SATOSA_USER_ID_HASH_SALT=CHANGE_ME!
+
+# Contact person data
+SATOSA_CONTACT_PERSON_EMAIL_ADDRESS=[email protected]
+SATOSA_CONTACT_PERSON_TELEPHONE_NUMBER=+3906123456789
+SATOSA_CONTACT_PERSON_FISCALCODE=01234567890
+SATOSA_CONTACT_PERSON_GIVEN_NAME=Name
+SATOSA_CONTACT_PERSON_IPA_CODE=ipa00c
+SATOSA_CONTACT_PERSON_MUNICIPALITY=H501
+
+# Organization data
+SATOSA_ORGANIZATION_DISPLAY_NAME_EN="Example Organization"
+SATOSA_ORGANIZATION_DISPLAY_NAME_IT="Example Organization"
+SATOSA_ORGANIZATION_NAME_EN="example_organization"
+SATOSA_ORGANIZATION_NAME_IT="example_organization"
+SATOSA_ORGANIZATION_URL_EN="https://example_organization.org"
+SATOSA_ORGANIZATION_URL_IT="https://example_organization.org/it"
+
+SATOSA_UI_DESCRIPTION_EN="Resource description"
+SATOSA_UI_DESCRIPTION_IT="Resource description"
+SATOSA_UI_DISPLAY_NAME_EN="Resource Display Name"
+SATOSA_UI_DISPLAY_NAME_IT="Resource Display Name"
+SATOSA_UI_INFORMATION_URL_EN="https://example_organization.org/information_url"
+SATOSA_UI_INFORMATION_URL_IT="https://example_organization.org/it/information_url"
+SATOSA_UI_LOGO_HEIGHT="60"
+SATOSA_UI_LOGO_WIDTH="80"
+SATOSA_UI_LOGO_URL="https://example_organization.org/logo.png"
+SATOSA_UI_PRIVACY_URL_EN="https://example_organization.org/privacy"
+SATOSA_UI_PRIVACY_URL_IT="https://example_organization.org/it/privacy"
+SATOSA_REQUESTED_ATTRIBUTES=[]
+
+# If set to true, satosa downloads IDEM's keys and IDPs from registry.spid.gov.it
+GET_IDEM_MDQ_KEY=true

Docker-compose/README.md

@@ -109,11 +109,10 @@ See [mongo readme](../README.mongo.md) to have some example of demo data.
 
 ## Env file
 
-```
-# cat .env
-MONGO_DBUSER=satosa
-MONGO_DBPASSWORD=thatpassword
-HOSTNAME=localhost
-```
+Customize the environment variables using the [.env](.env) file.
+The file [.env.example](.env.example) provides an example with all the environment variables you can set.
+The variables not set in the `.env` file will fallback on a default value defined in the [docker-compose.yml](docker-compose.yml).
+
+> :warning: Be careful when deploying your solution since some environment variables are **security-related**.
 
 See [mongo readme](../README.mongo.md) for explanation of environment variables of MongoDB.

Docker-compose/docker-compose.yml

@@ -79,6 +79,7 @@ services:
       - SATOSA_CONTACT_PERSON_GIVEN_NAME=${SATOSA_CONTACT_PERSON_GIVEN_NAME:-Contact Me}
       - SATOSA_CONTACT_PERSON_IPA_CODE=${SATOSA_CONTACT_PERSON_IPA_CODE:-ipa00c}
       - SATOSA_CONTACT_PERSON_MUNICIPALITY=${SATOSA_CONTACT_PERSON_MUNICIPALITY:-H501}
+
       - SATOSA_ENCRYPTION_KEY=${SATOSA_ENCRYPTION_KEY:-CHANGE_ME!}
 
       - SATOSA_ORGANIZATION_DISPLAY_NAME_EN=${SATOSA_ORGANIZATION_DISPLAY_NAME_EN:-Example Organization}
@@ -87,10 +88,13 @@ services:
       - SATOSA_ORGANIZATION_NAME_IT=${SATOSA_ORGANIZATION_NAME_IT:-example_organization}
       - SATOSA_ORGANIZATION_URL_EN=${SATOSA_ORGANIZATION_URL_EN:-https://example_organization.org}
       - SATOSA_ORGANIZATION_URL_IT=${SATOSA_ORGANIZATION_URL_IT:-https://example_organization.org/it}
+
       - SATOSA_PRIVATE_KEY=${KEYS_FOLDER}/${SATOSA_PRIVATE_KEY_FILENAME:-privkey.pem}
       - SATOSA_PUBLIC_KEY=${KEYS_FOLDER}/${SATOSA_CERT_FILENAME:-cert.pem}
       - SATOSA_SALT=${SATOSA_SALT:-CHANGE_ME!}
+
       - SATOSA_STATE_ENCRYPTION_KEY=${SATOSA_STATE_ENCRYPTION_KEY:-CHANGE_ME!}
+
       - SATOSA_UI_DESCRIPTION_EN=${SATOSA_UI_DESCRIPTION_EN:-Resource description}
       - SATOSA_UI_DESCRIPTION_IT=${SATOSA_UI_DESCRIPTION_IT:-Resource description}
       - SATOSA_UI_DISPLAY_NAME_EN=${SATOSA_UI_DISPLAY_NAME_EN:-Resource Display Name}