Configure
Environment Variables
Describe how to configure the Hoop Gateway via environment variables
Basic configuration
None of these values are required If you are running our AWS Stack setup. They are already set and configured for you.
Environment | Description |
---|---|
POSTGRES_DB_URI | The postgres connection string to connect in the database. |
API_URL | API URL address, usually where your DNS will be pointed to |
IDP_URI | OIDC & Oauth2 configuration in URI format: <scheme>://<client-id>:<client-secret>@<issuer-host>?<options> |
The <options>
could be used for further configuration by passing them as query strings.
Option | Description |
---|---|
scopes | Additional Oauth2 scopes to append to the request. Default values are openid , profile and email . |
groupsclaim | The name of the claim to consider as configuration to propagate groups. Default to https://app.hoop.dev/groups |
_userinfo | When this option is set to 1 it forces to authenticate using the userinfo endpoint. |
Extra configuration
All fields below are not required but can give you some extra configuration options to attend your needs.
Environment | Default Value | Description |
---|---|---|
IDP_AUDIENCE | Identity Provider Audience (Oauth2) | |
GRPC_URL | {API_URL}:8443 | The gRPC URL to advertise to clients. |
STATIC_UI_PATH | /app/ui/public | The path where the UI assets resides |
PLUGIN_AUDIT_PATH | /opt/hoop/sessions | The path where the temporary sessions are stored |
PLUGIN_INDEX_PATH | /opt/hoop/indexes | The path where the temporary indexes are stored |
GIN_MODE | release | Turn on (debug) logging of routes |
LOG_ENCODING | json | The encoding of output logs (console) |
LOG_LEVEL | info | The verbosity of logs (debug,info,warn,error) |
LOG_GRPC | “1” enables logging gRPC protocol | |
ORG_MULTI_TENANT | Enable organization multi-tenancy | |
ASK_AI_CREDENTIALS | The ChatGPT credentials in URL format: <scheme>://_:<apikey>@<api-host> | |
GOOGLE_APPLICATION_CREDENTIALS_JSON | GCP DLP credentials | |
DLP_PROVIDER | It can be empty, mspresidio or gcp | |
MSPRESIDIO_ANALYZER_URL | Host and port for MS Presidio Analyzer <host-to-analyzer:port> | |
MSPRESIDIO_ANONYMIZER_URL | Host and port for MS Presidio Anonymizer<host-to-anonymizer:port> | |
WEBHOOK_APPKEY | The application key to send messages to the webhook provider. | |
ADMIN_USERNAME | admin | Changes the name of the group to act as the admin role |