Skip to content

Add license key management disabled config #759

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AlexGaillard wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add license key management disabled config #759

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9dc2ccc
Revert "Update Cloud Domain (#756)"
AlexGaillard Jun 29, 2026
7766623
Add LICENSE_KEY_MANAGEMENT_ENABLED to configuration page
AlexGaillard Jun 30, 2026
9f210e1
Merge branch 'main' into add-license-key-management-disabled-config
AlexGaillard Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 27 additions & 28 deletions content/configuration/1.general.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,24 @@ title: General
description: Configuration for the general system, server, first admin user, and telemetry.
---


:partial{content="config-env-vars"}

| Variable | Description | Default Value |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| `CONFIG_PATH` | Where your config file is located. See [Deploying Directus](/self-hosting/deploying). | `.env` |
| `HOST` | IP or host the API listens on. | `0.0.0.0` |
| `PORT` | What port to run the API under. | `8055` |
| `UNIX_SOCKET_PATH` | The Unix socket the API listens on, `PORT` and `HOST` will be ignored if this is provided. | |
| `PUBLIC_URL` | URL where your API can be reached on the web. used for things like OAuth redirects, forgot-password emails, and publicly-accessible logos. | `/` |
| `ROOT_REDIRECT` | Redirect the root of the application `/` to a specific route. Accepts a relative path, absolute URL, or `false` to disable. | `./admin` |
| `SERVE_APP` | Whether or not to serve the Data Studio web application. | `true` |
| `OPENAPI_ENABLED` | Whether or not to enable OpenAPI Specification output. | `true` |
| `GRAPHQL_INTROSPECTION` | Whether or not to enable GraphQL Introspection. | `true` |
| `GRAPHQL_SCHEMA_CACHE_CAPACITY` | How many user GraphQL schemas to store in memory. | `100` |
| `GRAPHQL_SCHEMA_GENERATION_MAX_CONCURRENT` | How many GraphQL schemas can be generated simultaneously. | `5` |
| `ROBOTS_TXT` | What the `/robots.txt` endpoint should return. | `User-agent: *\nDisallow: /` |
| `TEMP_PATH` | Where Directus' temporary files should be managed. | `./node_modules/.directus` |
| `PROJECT_OWNER` | Registered owner and primary contact responsible for your Directus instance. | |

| Variable | Description | Default Value |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------- |
| `CONFIG_PATH` | Where your config file is located. See [Deploying Directus](/self-hosting/deploying). | `.env` |
| `HOST` | IP or host the API listens on. | `0.0.0.0` |
| `PORT` | What port to run the API under. | `8055` |
| `UNIX_SOCKET_PATH` | The Unix socket the API listens on, `PORT` and `HOST` will be ignored if this is provided. | |
| `PUBLIC_URL` | URL where your API can be reached on the web. used for things like OAuth redirects, forgot-password emails, and publicly-accessible logos. | `/` |
| `ROOT_REDIRECT` | Redirect the root of the application `/` to a specific route. Accepts a relative path, absolute URL, or `false` to disable. | `./admin` |
| `SERVE_APP` | Whether or not to serve the Data Studio web application. | `true` |
| `OPENAPI_ENABLED` | Whether or not to enable OpenAPI Specification output. | `true` |
| `GRAPHQL_INTROSPECTION` | Whether or not to enable GraphQL Introspection. | `true` |
| `GRAPHQL_SCHEMA_CACHE_CAPACITY` | How many user GraphQL schemas to store in memory. | `100` |
| `GRAPHQL_SCHEMA_GENERATION_MAX_CONCURRENT` | How many GraphQL schemas can be generated simultaneously. | `5` |
| `ROBOTS_TXT` | What the `/robots.txt` endpoint should return. | `User-agent: *\nDisallow: /` |
| `TEMP_PATH` | Where Directus' temporary files should be managed. | `./node_modules/.directus` |
| `PROJECT_OWNER` | Registered owner and primary contact responsible for your Directus instance. | |

::callout{icon="i-lucide-triangle-alert" color="warning"}
`PUBLIC_URL` must be a qualified URL when using [licensing](/licensing/overview) features beyond Core Plan and/or when configuring [SSO](/configuration/auth-sso)
Expand All @@ -33,10 +31,11 @@ description: Configuration for the general system, server, first admin user, and

See [Licensing](/licensing/overview) for a full explanation of license keys, license tokens and source precedence.

| Variable | Description | Default Value |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `LICENSE_KEY` | License key in the format `DXXXX-XXXXX-XXXXX-XXXXX-XXXXC`. Activated against the Directus licensing service on first use and revalidated periodically. Takes precedence over `LICENSE_TOKEN` and any key set through the Studio. | |
| `LICENSE_TOKEN` | Pre-issued license token for offline use. Validated locally on each startup and never contacts the licensing service. Mutually exclusive with `LICENSE_KEY` — setting both is a configuration error and Directus will refuse to start. | |
| Variable | Description | Default Value |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `LICENSE_KEY` | License key in the format `DXXXX-XXXXX-XXXXX-XXXXX-XXXXC`. Activated against the Directus licensing service on first use and revalidated periodically. Takes precedence over `LICENSE_TOKEN` and any key set through the Studio. | |
| `LICENSE_TOKEN` | Pre-issued license token for offline use. Validated locally on each startup and never contacts the licensing service. Mutually exclusive with `LICENSE_KEY` — setting both is a configuration error and Directus will refuse to start. | |
| `LICENSE_KEY_MANAGEMENT_ENABLED` | Disables the management of license keys both within the studio and also via the api. When disabled, licenses cannot be activated, updated or deactivated. | true |

::callout{icon="i-lucide-info"}
When `LICENSE_KEY` or `LICENSE_TOKEN` is set in the environment, any license key management actions are disabled. To change the license, update the environment variable and restart Directus.
Expand All @@ -51,6 +50,7 @@ When `LICENSE_KEY` or `LICENSE_TOKEN` is set in the environment, any license key
| `SERVER_SHUTDOWN_TIMEOUT` | Timeout in milliseconds before the server is forcefully shut down. | 1000 |

### Additional Server Variables

All `SERVER_*` environment variables are merged with `server` instance properties created from [http.Server](https://github.com/nodejs/node/blob/master/doc/api/http.md#class-httpserver). This allows to configure server behind a proxy, a load balancer, etc. Be careful to not override methods of this instance otherwise you may incur into unexpected behaviors.

## First Admin User
Expand All @@ -63,16 +63,15 @@ The following commands set details for the first admin user created when the pro
| `ADMIN_PASSWORD` | The password of the first user that's automatically created during bootstrapping. | |
| `ADMIN_TOKEN` | The API token of the first user that's automatically created during bootstrapping. | |


## Telemetry

To more accurately gauge the frequency of installation, version fragmentation, and general size of the user base, Directus collects usage data about your environment.

| Variable | Description | Default Value |
| ------------------------- | ----------------------------------------------------------------- | -------------------------------- |
| `TELEMETRY` | Allow Directus to collect usage data about your environment. Whether it can be disabled depends on your license. See [Telemetry](/licensing/telemetry) for more information. | `true` |
| `TELEMETRY_URL` | URL that the usage report is submitted to. | `https://telemetry.directus.io` |
| `TELEMETRY_AUTHORIZATION` | Optional authorization header value. | |
| Variable | Description | Default Value |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
| `TELEMETRY` | Allow Directus to collect usage data about your environment. Whether it can be disabled depends on your license. See [Telemetry](/licensing/telemetry) for more information. | `true` |
| `TELEMETRY_URL` | URL that the usage report is submitted to. | `https://telemetry.directus.io` |
| `TELEMETRY_AUTHORIZATION` | Optional authorization header value. | |

::callout{icon="i-lucide-book-open" color="primary" to="/licensing/telemetry"}
For a full breakdown of what is collected, when it is sent, and how to opt out, see [Telemetry](/licensing/telemetry).
Expand Down
Loading