Skip to content

Commit 54b2487

Browse files
MdreWMdreW
committed
Update documentation
1 parent cbd29f2 commit 54b2487

1 file changed

Lines changed: 24 additions & 22 deletions

File tree

‎README-Setup.md‎

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ Comment/uncomment the following statement in the proxy_configuration to enable i
7474

7575
You can override the configuration of the proxy by settings one or more of the following environment variables:
7676

77-
| **Environment var** | **Description** | **Example Value** |
78-
|--------------------------------------------------|-----------------------------------------------------------|------------------------------------------------------------|
77+
| **Environment var** | **Description** | **Example Value** |
78+
|--------------------------------------------------|------------------------------------------------------------|------------------------------------------------------------|
7979
| **BASE_DIR** | Base directory for satosa proxy | /satosa_proxy |
8080
| **SATOSA_BY_DOCKER** | Satosa configuration when run by Docker | 1 |
8181
| **SATOSA_BASE** | Base URL of Satosa server | https://$HOSTNAME |
@@ -85,37 +85,39 @@ You can override the configuration of the proxy by settings one or more of the f
8585
| **MONGODB_PASSWORD** | MongoDB password for oidc_op frontend | ${MONGO_DBPASSWORD} |
8686
| **MONGODB_USERNAME** | MongoDB username for oidc_op frontend | ${MONGO_DBUSER} |
8787
| **SATOSA_CONTACT_PERSON_EMAIL_ADDRESS** | Metadata Contact person email | support.example@organization.org |
88-
| **SATOSA_CONTACT_PERSON_TELEPHONE_NUMBER** | Metadata Contact person telephone number for SPID / CIE Backend | +3906123456789 |
89-
| **SATOSA_CONTACT_PERSON_FISCALCODE** | Metadata Contact person fiscal code for SPID / CIE Backend | 01234567890 |
90-
| **SATOSA_CONTACT_PERSON_GIVEN_NAME** | Metadata Contact person name | Name |
91-
| **SATOSA_CONTACT_PERSON_IPA_CODE** | Metadata Contact person IPA code for SPID / CIE Backend | ipa00c |
92-
| **SATOSA_CONTACT_PERSON_MUNICIPALITY** | Metadata Contact person municipality code for CIE Backend | H501 |
88+
| **SATOSA_CONTACT_PERSON_TELEPHONE_NUMBER** | Metadata Contact person telephone number for SPID / CIE Backend | +3906123456789 |
89+
| **SATOSA_CONTACT_PERSON_FISCALCODE** | Metadata Contact person fiscal code for SPID / CIE Backend | 01234567890 |
90+
| **SATOSA_CONTACT_PERSON_GIVEN_NAME** | Metadata Contact person name | Name |
91+
| **SATOSA_CONTACT_PERSON_IPA_CODE** | Metadata Contact person IPA code for SPID / CIE Backend | ipa00c |
92+
| **SATOSA_CONTACT_PERSON_MUNICIPALITY** | Metadata Contact person municipality code for CIE Backend | H501 |
9393
| **SATOSA_ENCRYPTION_KEY** | Encryption key for state | CHANGE_ME! |
94-
| **SATOSA_ORGANIZATION_DISPLAY_NAME_EN** | Metadata English organization display name | Resource provided by Example Organization |
95-
| **SATOSA_ORGANIZATION_DISPLAY_NAME_IT** | Metadata Italian organization display name | Resource provided by Example Organization |
94+
| **SATOSA_ORGANIZATION_DISPLAY_NAME_EN** | Metadata English organization display name | Resource provided by Example Organization |
95+
| **SATOSA_ORGANIZATION_DISPLAY_NAME_IT** | Metadata Italian organization display name | Resource provided by Example Organization |
9696
| **SATOSA_ORGANIZATION_NAME_EN** | Metadata English full organization name | Resource provided by Example Organization |
97-
| **SATOSA_ORGANIZATION_NAME_IT** | Metadata Italian full organization name | Resource provided by Example Organization |
97+
| **SATOSA_ORGANIZATION_NAME_IT** | Metadata Italian full organization name | Resource provided by Example Organization |
9898
| **SATOSA_ORGANIZATION_URL_EN** | Metadata English organization URL | https://example_organization.org |
99-
| **SATOSA_ORGANIZATION_URL_IT** | Metadata Italian organization URL | https://example_organization.org |
100-
| **SATOSA_PRIVATE_KEY** | Private key for SAML2 / SPID backends | ${KEYS_FOLDER}/privkey.pem |
101-
| **SATOSA_PUBLIC_KEY** | Public key for SAML2 / SPID backends | ${KEYS_FOLDER}/cert.pem |
102-
| **SATOSA_SALT** | Encryption salt | CHANGE_ME! |
99+
| **SATOSA_ORGANIZATION_URL_IT** | Metadata Italian organization URL | https://example_organization.org |
100+
| **SATOSA_PRIVATE_KEY** | Private key for SAML2 / SPID backends | ${KEYS_FOLDER}/privkey.pem |
101+
| **SATOSA_PUBLIC_KEY** | Public key for SAML2 / SPID backends | ${KEYS_FOLDER}/cert.pem |
102+
| **SATOSA_SALT** | Encryption salt | CHANGE_ME! |
103103
| **SATOSA_STATE_ENCRYPTION_KEY** | State encryption key | CHANGE_ME! |
104104
| **SATOSA_UI_DESCRIPTION_EN** | Metadata English UI description | Resource description |
105105
| **SATOSA_UI_DESCRIPTION_IT** | Metadata Italian UI description | Resource description |
106-
| **SATOSA_UI_DISPLAY_NAME_EN** | Metadata English UI display name | Resource Display Name |
107-
| **SATOSA_UI_DISPLAY_NAME_IT** | Metadata Italian UI display name | Resource Display Name |
108-
| **SATOSA_UI_INFORMATION_URL_EN** | Metadata English UI information URL | https://example_organization.org/information_url_en |
109-
| **SATOSA_UI_INFORMATION_URL_IT** | Metadata Italian UI information URL | https://example_organization.org/information_url_en |
110-
| **SATOSA_UI_LOGO_HEIGHT** | Metadata logo height | 60 |
111-
| **SATOSA_UI_LOGO_URL** | Metadata Logo URL | https://example_organization.org/logo.png |
112-
| **SATOSA_UI_LOGO_WIDTH** | Metadata Logo width | 80 |
106+
| **SATOSA_UI_DISPLAY_NAME_EN** | Metadata English UI display name | Resource Display Name |
107+
| **SATOSA_UI_DISPLAY_NAME_IT** | Metadata Italian UI display name | Resource Display Name |
108+
| **SATOSA_UI_INFORMATION_URL_EN** | Metadata English UI information URL | https://example_organization.org/information_url_en |
109+
| **SATOSA_UI_INFORMATION_URL_IT** | Metadata Italian UI information URL | https://example_organization.org/information_url_en |
110+
| **SATOSA_UI_LOGO_HEIGHT** | Metadata logo height | 60 |
111+
| **SATOSA_UI_LOGO_URL** | Metadata Logo URL | https://example_organization.org/logo.png |
112+
| **SATOSA_UI_LOGO_WIDTH** | Metadata Logo width | 80 |
113113
| **SATOSA_UI_PRIVACY_URL_EN** | Metadata English UI privacy URL | https://example_organization.org/privacy_en |
114114
| **SATOSA_UI_PRIVACY_URL_IT** | Metadata Italian UI privacy URL | https://example_organization.org/privacy_en |
115115
| **SATOSA_USER_ID_HASH_SALT** | User ID hash salt | CHANGE_ME! |
116116
| **SATOSA_REQUESTED_ATTRIBUTES** | Requested attributes | [] |
117-
| **GET_IDEM_MDQ_KEY** | Flag for getting idem MDQ key | true |
117+
| **SATOSA_GET_IDEM_MDQ_KEY** | Flag for getting idem MDQ key | true |
118118
| **GET_SPID_IDP_METADATA** | Flag for getting SPID IDP metadata | true |
119+
| **GET_CIE_IDP_METADATA** | Flag for getting CIE IDP metadata | true |
120+
| **GET_FICEP_IDP_METADATA** | Flag for getting ficep (eIDAS) IDP metadata | true |
119121
| **SATOSA_SAML2_REQUESTED_ATTRIBUTES** | SAML2 required attributes | name, surname |
120122
| **SATOSA_SPID_REQUESTED_ATTRIBUTES** | SPID required attributes | spidCode, name, familyName, fiscalNumber, email |
121123

0 commit comments

Comments
 (0)