Skip to content

Commit

Permalink
Clarify HASURA_API_URL envvar in docs (#119)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mythicaeda authored Jan 6, 2025
1 parent 5c616b4 commit 9426e56
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/ENVIRONMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This document provides detailed information about environment variables for the gateway.

| 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"] |
| `AUTH_GROUP_ROLE_MAPPINGS` | JSON object that maps auth provider groups to Aerie roles. See [SSO authentication docs][SSO authn] | `JSON` | {} |
Expand All @@ -15,7 +15,7 @@ This document provides detailed information about environment variables for the
| `DEFAULT_ROLE_NO_AUTH` | Default role when authentication is disabled. | `string` | 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_API_URL` | URL of Hasura APIs. | `string` | http://hasura:8080/ |
| `HASURA_API_URL` | URL of the base Hasura API. | `string` | http://hasura:8080/ |
| `HASURA_GRAPHQL_JWT_SECRET` | The JWT secret. Also in Hasura. **Required** even if auth off in Hasura. | `string` | |
| `JWT_ALGORITHMS` | List of [JWT signing algorithms][algorithms]. Must include algorithm in `HASURA_GRAPHQL_JWT_SECRET`. | `array` | ["HS256"] |
| `JWT_EXPIRATION` | Amount of time until JWT expires. | `string` | 36h |
Expand Down

0 comments on commit 9426e56

Please sign in to comment.