document new auth env vars

NASA-AMMOS · Dec 8, 2023 · 7237373 · 7237373
1 parent abc0751
commit 7237373
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/docs/ENVIRONMENT.md b/docs/ENVIRONMENT.md
@@ -5,11 +5,13 @@ This document provides detailed information about environment variables for the
 | Name                        | Description                                                                                          | Type     | Default                                        |
 | --------------------------- | ---------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------- |
 | `ALLOWED_ROLES`             | Allowed roles when authentication is enabled.                                                        | `array`  | ["user", "viewer"]                             |
-| `ALLOWED_ROLES_NO_AUTH`     | Allowed roles when authentication is disabled.                                                       | `array`  | ["aerie_admin", "user", "viewer"]                    |
+| `ALLOWED_ROLES_NO_AUTH`     | Allowed roles when authentication is disabled.                                                       | `array`  | ["aerie_admin", "user", "viewer"]              |
 | `AUTH_TYPE`                 | Mode of authentication. Set to `cam` to enable CAM authentication.                                   | `string` | none                                           |
-| `AUTH_URL`                  | URL of CAM REST API. Used if the given `AUTH_TYPE` is set to `cam`.                                  | `string` | https://atb-ocio-12b.jpl.nasa.gov:8443/cam-api |
+| `AUTH_URL`                  | URL of Auth provider's REST API. Used if the given `AUTH_TYPE` is not set to `none`.                 | `string` | https://atb-ocio-12b.jpl.nasa.gov:8443/cam-api |
+| `AUTH_UI_URL`               | URL of Auth provider's login UI. Returned to the UI if SSO token is invalid, so user is redirected   | `string` | https://atb-ocio-12b.jpl.nasa.gov:8443/cam-ui  |
+| `AUTH_SSO_TOKEN_NAME`       | The name of the SSO token the Gateway should parse cookies for. Likely found in auth provider docs.  | `string` | iPlanetDirectoryPro                            |
 | `DEFAULT_ROLE`              | Default role when authentication is enabled.                                                         | `array`  | user                                           |
-| `DEFAULT_ROLE_NO_AUTH`      | Default role when authentication is disabled.                                                        | `array`  | aerie_admin                                          |
+| `DEFAULT_ROLE_NO_AUTH`      | Default role when authentication is disabled.                                                        | `array`  | aerie_admin                                    |
 | `GQL_API_URL`               | URL of GraphQL API for the GraphQL Playground.                                                       | `string` | http://localhost:8080/v1/graphql               |
 | `GQL_API_WS_URL`            | URL of GraphQL WebSocket API for the GraphQL Playground.                                             | `string` | ws://localhost:8080/v1/graphql                 |
 | `HASURA_GRAPHQL_JWT_SECRET` | The JWT secret. Also in Hasura. **Required** even if auth off in Hasura.                             | `string` |                                                |