Skip to content
This repository has been archived by the owner on May 27, 2024. It is now read-only.

Commit

Permalink
chore: remove unused env vars (#21)
Browse files Browse the repository at this point in the history
* fix: remove employee number from shib attrs

- we aren't receiving this from JHU's IDP and we don't seem to be using it in pass-core AND it's breaking authentication

* remove additional unused env vars from readme

* add back employeenumber

- we do use it, central it is adding it
  • Loading branch information
jaredgalanis authored Aug 4, 2023
1 parent e09e170 commit ef14870
Showing 1 changed file with 17 additions and 27 deletions.
44 changes: 17 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,34 +23,24 @@ This will create a new `ghcr.io/eclipse-pass/pass-auth` image with a tag matchin

Environment variables are as follows:

* `AUTH_PORT` - port to serve the express server on,
* `AUTH_LOGIN` - express route that generates an authn request to the IDP (default: "/login/:idpId"),
* `AUTH_LOGIN_SUCCESS` - pass-ui route this service will redirect to after a successful authentication,
* `AUTH_LOGIN_FAILURE` - URL this service will redirect to after an unsuccessful authentication,
* `AUTH_LOGOUT` - express route that destroys the express session,
* `AUTH_LOGOUT_REDIRECT` - URL this service will redirect to after a logout,
* `PASS_CORE_API_URL` - URI of pass-core,
* `PASS_CORE_NAMESPACE` - name space of pass-core,
* `PASS_UI_URL` - base URL of pass-ui,
* `PASS_UI_ROOT_URL` - root URL of pass-ui,
* `FCREPO_URL` - base URL of FCREPO,
* `USER_SERVICE_URL` - base URL of the user service,
* `ELASTIC_SEARCH_URL` - base URL of the elastic search service,
* `SCHEMA_SERVICE_URL` - base URL of the schema service,
* `POLICY_SERVICE_URL` - base URL of the policy service,
* `DOI_SERVICE_URL` - base URL of the DOI service,
* `DOWNLOAD_SERVICE_URL` - base URL of the download service,
* `PASSPORT_STRATEGY` - the passport strategy,
* `SAML_ENTRY_POINT` - the IDP's url at which authn requests can be fired,
* `SIGNING_CERT_IDP` - the IDP's cert used to sign SAML requests,
* `ACS_URL` - the assertion consumer service URL where the IDP will fire SAML requests (default: "/Shibboleth.sso/SAML2/POST/:idpId"),
* `METADATA_URL` - the URL where the SP metadata can be retrieved (default: "/metadata/:idpId"),
* `IDENTIFIER_FORMAT` - identifierFormat: optional name identifier format to request from identity provider (default: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress),
* `SAML_ISSUER` - identifier for the issuer/SP provided to the IDP,
* `SIGNING_CERT_SP` - the certificate used by the SP to sign SAML requests,
* `FORCE_AUTHN` - the initial SAML request from the service provider specifies that the IdP should force re-authentication of the user, even if they possess a valid session (default: true)
- `AUTH_PORT` - port to serve the express server on,
- `AUTH_LOGIN` - express route that generates an authn request to the IDP (default: "/login/:idpId"),
- `AUTH_LOGIN_SUCCESS` - pass-ui route this service will redirect to after a successful authentication,
- `AUTH_LOGIN_FAILURE` - URL this service will redirect to after an unsuccessful authentication,
- `AUTH_LOGOUT` - express route that destroys the express session,
- `AUTH_LOGOUT_REDIRECT` - URL this service will redirect to after a logout,
- `PASS_CORE_API_URL` - URI of pass-core,
- `PASS_CORE_NAMESPACE` - name space of pass-core,
- `PASS_UI_URL` - base URL of pass-ui,
- `PASS_UI_ROOT_URL` - root URL of pass-ui,
- `PASSPORT_STRATEGY` - the passport strategy,
- `SAML_ENTRY_POINT` - the IDP's url at which authn requests can be fired,
- `ACS_URL` - the assertion consumer service URL where the IDP will fire SAML requests (default: "/Shibboleth.sso/SAML2/POST/:idpId"),
- `METADATA_URL` - the URL where the SP metadata can be retrieved (default: "/metadata/:idpId"),
- `IDENTIFIER_FORMAT` - identifierFormat: optional name identifier format to request from identity provider (default: urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress),
- `SAML_ISSUER` - identifier for the issuer/SP provided to the IDP,
- `FORCE_AUTHN` - the initial SAML request from the service provider specifies that the IdP should force re-authentication of the user, even if they possess a valid session (default: true)

## License

Licensed under the Apache license

0 comments on commit ef14870

Please sign in to comment.