diff --git a/README.md b/README.md index 68b8976..18e9a82 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,7 @@ By default, pass-core-main will run with a typical production configuration. In Environment variables: | Environment Variable | Default Value | Description | |--------------------------------------------------|------------------------------|-------------------------------------------------------------------------------------------------------------------------| -| `PASS_CORE_APP_LOCATION` | classpath:app/ | IP address or host name of the server running the SWORD protocol version 2 endpoint | -| `PASS_CORE_APP_CSP` | | TCP port exposing the SWORD protocol version 2 endpoint | +| `PASS_CORE_APP_LOCATION` | classpath:app/ | Location where requests are resolved | | `PASS_CORE_DATABASE_URL` | | Connection URL to database | | `PASS_CORE_DATABASE_USERNAME` | | Username for database login | | `PASS_CORE_DATABASE_PASSWORD` | | Password for database login | @@ -53,22 +52,23 @@ Environment variables: | `PASS_CORE_SUBMISSION_QUEUE` | pass-submission | Name of submission queue | | `PASS_CORE_DEPOSIT_QUEUE` | pass-deposit | Name of deposit queue | | `PASS_CORE_SUBMISSION_EVENT_QUEUE` | pass-submission-event | Name of submission event queue | -| `PASS_CORE_SP_ID` | | SAML SP ID [SAML configuration](#saml-configuration) | -| `PASS_CORE_SP_ACS` | | SAML SP ACS [SAML configuration](#saml-configuration) | -| `PASS_CORE_SP_KEY` | | Location of SAML SP private key pem file [SAML configuration](#saml-configuration) | -| `PASS_CORE_SP_CERT` | | Location of SAML SP public certificate pem file [SAML configuration](#saml-configuration) | -| `PASS_CORE_IDP_METADATA` | | Location of SAML IDM Metadata file [SAML configuration](#saml-configuration) | -| `PASS_CORE_DEAULT_LOGIN_SUCCESS` | | Path to redirect to after login success [SAML configuration](#saml-configuration) | -| `PASS_CORE_LOGIN_PROCESSING_PATH` | | Path to handle login from SAML IDP [SAML configuration](#saml-configuration) | -| `PASS_CORE_LOGOUT_SUCCESS` | | Path to redirect to after SAML logout [SAML configuration](#saml-configuration) | -| `PASS_CORE_LOGOUT_DELETE_COOKIES` | | Name of cookies to delete as part of SAML logout [SAML configuration](#saml-configuration) | -| `PASS_CORE_USERTOKEN_KEY` | | If not present, one is generated. See the [user service](pass-core-user-service/README.md) for how to create manually. | +| `PASS_CORE_SP_ID` | | SAML SP ID [SAML configuration](#saml-configuration) | +| `PASS_CORE_SP_ACS` | | SAML SP ACS [SAML configuration](#saml-configuration) | +| `PASS_CORE_SP_KEY` | | Location of SAML SP private key pem file [SAML configuration](#saml-configuration) | +| `PASS_CORE_SP_CERT` | | Location of SAML SP public certificate pem file [SAML configuration](#saml-configuration) | +| `PASS_CORE_IDP_METADATA` | | Location of SAML IDM Metadata file [SAML configuration](#saml-configuration) | +| `PASS_CORE_APP_CSP` | | The Content Security Policy definition | +| `PASS_CORE_DEAULT_LOGIN_SUCCESS` | | Path to redirect to after login success [SAML configuration](#saml-configuration) | +| `PASS_CORE_LOGIN_PROCESSING_PATH` | | Path to handle login from SAML IDP [SAML configuration](#saml-configuration) | +| `PASS_CORE_LOGOUT_SUCCESS` | | Path to redirect to after SAML logout [SAML configuration](#saml-configuration) | +| `PASS_CORE_LOGOUT_DELETE_COOKIES` | | Name of cookies to delete as part of SAML logout [SAML configuration](#saml-configuration) | +| `PASS_CORE_USERTOKEN_KEY` | | If not present, one is generated. See the [user service](pass-core-user-service/README.md) for how to create manually. | | `PASS_CORE_JAVA_OPTS` | | Used by the Docker image to pass arguments to Java. | | `PASS_CORE_BASE_URL` | | Used when services send URLs to the client such as relationship links. | -| `PASS_CORE_FILE_SERVICE_TYPE` | FILE_SYSTEM | The port to expose for pass-core API | -| `PASS_CORE_FILE_SERVICE_ROOT_DIR` | | Path to log directory | -| `PASS_CORE_S3_BUCKET_NAME` | pass-core-file | Default user name for pass-core | -| `PASS_CORE_S3_REPO_PREFIX` | pass-core-file | Default user password for pass-core | +| `PASS_CORE_FILE_SERVICE_TYPE` | FILE_SYSTEM | The type of File Service, FILE_SYSTEM or S3 | +| `PASS_CORE_FILE_SERVICE_ROOT_DIR` | | Path to File Service root directory | +| `PASS_CORE_S3_BUCKET_NAME` | pass-core-file | If File Service is S3, the S3 bucket name | +| `PASS_CORE_S3_REPO_PREFIX` | pass-core-file | If File Service is S3, the prefix of S3 keys in the bucket | | `PASS_CORE_POLICY_INSTITUTION` | | Name of the institution | | `PASS_CORE_POLICY_INSTITUTIONAL_POLICY_TITLE` | | Title of the institutional policy | | `PASS_CORE_POLICY_INSTITUTIONAL_REPOSITORY_NAME` | | Name of institutional repository |