> ## Documentation Index
> Fetch the complete documentation index at: https://wundergraphinc-brendan-add-sof-link.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration

> Here you can set all available environment variables of the Control Plane.

Check the [WunderGraph Demo](https://github.com/wundergraph/cosmo) for a [setup configuration](https://github.com/wundergraph/cosmo/blob/main/controlplane/.env.example).

| Environment variable         | Description                                                                                                         | Default                                                                          | Required                     |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------- |
| HOST                         | The host of the server                                                                                              | localhost                                                                        | <Icon icon="square" />       |
| DATABASE\_URL                | The connection URL of the database                                                                                  | postgresql://postgres:changeme\@localhost:5432/controlplane                      | <Icon icon="square-check" /> |
| PORT                         | The port on which the controlplane runs                                                                             | 3001                                                                             | <Icon icon="square-check" /> |
| ALLOWED\_ORIGINS             | The controlplane url                                                                                                | [http://localhost:3000](http://localhost:3000)                                   | <Icon icon="square-check" /> |
| LOG\_LEVEL                   | Configures the log level                                                                                            | info                                                                             | <Icon icon="square-check" /> |
| DEBUG\_SQL                   | Configures the logs of SQL                                                                                          | false                                                                            | <Icon icon="square-check" /> |
| CLICKHOUSE\_DSN              | The connection URL of clickhouse                                                                                    | ""                                                                               | <Icon icon="square-check" /> |
| AUTH\_REDIRECT\_URI          | The authorized redirect URLs                                                                                        | [http://localhost:3001/v1/auth/callback](http://localhost:3001/v1/auth/callback) | <Icon icon="square-check" /> |
| WEB\_BASE\_URL               | The URL of studio                                                                                                   | ""                                                                               | <Icon icon="square-check" /> |
| AUTH\_JWT\_SECRET            | The JWT secret used for verifying and signing JWTs (32 characters)                                                  | ""                                                                               | <Icon icon="square-check" /> |
| OPENAI\_API\_KEY             | The api key of OPEN API                                                                                             | ""                                                                               | <Icon icon="square-check" /> |
| KC\_LOGIN\_REALM             | The realm of the login credentials                                                                                  | "master"                                                                         | <Icon icon="square" />       |
| KC\_REALM                    | The keycloak realm of your Client                                                                                   | ""                                                                               | <Icon icon="square-check" /> |
| KC\_CLIENT\_ID               | The keycloak client ID                                                                                              | ""                                                                               | <Icon icon="square-check" /> |
| KC\_ADMIN\_USER              | The admin username                                                                                                  | ""                                                                               | <Icon icon="square-check" /> |
| KC\_ADMIN\_PASSWORD          | The admin password                                                                                                  | ""                                                                               | <Icon icon="square-check" /> |
| KC\_API\_URL                 | The URL to your keycloak API endpoint. Used internally for administration                                           | ""                                                                               | <Icon icon="square-check" /> |
| KC\_FRONTEND\_URL            | The public URL of your keycloak instance. Used for redirects                                                        | ""                                                                               | <Icon icon="square-check" /> |
| WEBHOOK\_URL                 | The endpoint to which you want to fire platform webhooks                                                            | ""                                                                               | <Icon icon="square" />       |
| WEBHOOK\_SECRET              | The secret key to verify webhook requests                                                                           | ""                                                                               | <Icon icon="square" />       |
| DB\_URL                      | Postgres connection string                                                                                          | ""                                                                               | <Icon icon="square-check" /> |
| DB\_CERT\_PATH               | Path to certificate file                                                                                            | ""                                                                               | <Icon icon="square" />       |
| DB\_CA\_PATH                 | Path to the CA file                                                                                                 | ""                                                                               | <Icon icon="square" />       |
| DB\_KEY\_PATH                | Path to the private key file                                                                                        | ""                                                                               | <Icon icon="square" />       |
| GITHUB\_APP\_CLIENT\_ID      | GitHub App client id                                                                                                | ""                                                                               | <Icon icon="square" />       |
| GITHUB\_APP\_CLIENT\_SECRET  | GitHub App client secret                                                                                            | ""                                                                               | <Icon icon="square" />       |
| GITHUB\_APP\_ID              | GitHub App id                                                                                                       | ""                                                                               | <Icon icon="square" />       |
| GITHUB\_APP\_PRIVATE\_KEY    | Private key of your GitHub App                                                                                      | ""                                                                               | <Icon icon="square" />       |
| GITHUB\_APP\_WEBHOOK\_SECRET | Webhook secret of your GitHub App                                                                                   | ""                                                                               | <Icon icon="square" />       |
| SLACK\_APP\_CLIENT\_ID       | Slack app client id                                                                                                 | ""                                                                               | <Icon icon="square" />       |
| SLACK\_APP\_CLIENT\_SECRET   | Slack app client secret                                                                                             | ""                                                                               | <Icon icon="square" />       |
| S3\_STORAGE\_URL             | URL to your s3 storage provider (either include credentials or use S3\_ACCESS\_KEY\_ID and S3\_SECRET\_ACCESS\_KEY) | ""                                                                               | <Icon icon="square-check" /> |
| S3\_REGION                   | The region to be used for the s3 bucket                                                                             | "auto"                                                                           | <Icon icon="square" />       |
| S3\_ENDPOINT                 | The endpoint to be used falls back to url.Origin                                                                    | ""                                                                               | <Icon icon="square" />       |
| S3\_ACCESS\_KEY\_ID          | Access key id for the bucket (AWS\_ACCESS\_KEY\_ID)                                                                 | ""                                                                               | <Icon icon="square" />       |
| S3\_SECRET\_ACCESS\_KEY      | Secress Access key for the bucket (AWS\_SECRET\_ACCESS\_KEY)                                                        | ""                                                                               | <Icon icon="square" />       |
| S3\_FORCE\_PATH\_STYLE       | Used to enforce path style url resolution                                                                           | true                                                                             | <Icon icon="square" />       |
| SMTP\_ENABLED                | Enable the smtp integration                                                                                         | false                                                                            | <Icon icon="square" />       |
| SMTP\_USERNAME               | Smtp username                                                                                                       | ""                                                                               | <Icon icon="square" />       |
| SMTP\_PASSWORD               | Smtp password                                                                                                       | ""                                                                               | <Icon icon="square" />       |
| SMTP\_PORT                   | The port the smtp server listens to                                                                                 |                                                                                  | <Icon icon="square" />       |
| SMTP\_HOST                   | The host to connect to                                                                                              | ""                                                                               | <Icon icon="square" />       |
| SMTP\_SECURE                 | Defines if the connection should use SSL                                                                            |                                                                                  | <Icon icon="square" />       |
| SMTP\_REQUIRE\_TLS           | Forces the client to use STARTTLS                                                                                   |                                                                                  | <Icon icon="square" />       |
| STRIPE\_SECRET\_KEY          | Stripe secret                                                                                                       | ""                                                                               | <Icon icon="square" />       |
| STRIPE\_WEBHOOK\_SECRET      | Stripe webhook secret                                                                                               | ""                                                                               | <Icon icon="square" />       |
| DEFAULT\_PLAN                | Based on your custom plans, the name of the default plan                                                            | ""                                                                               | <Icon icon="square" />       |
