From ee9dd077348fa1120a79c9c105e21bcc473d27e1 Mon Sep 17 00:00:00 2001 From: Antonio Djigo <31393623+djigoio@users.noreply.github.com> Date: Wed, 29 Jul 2026 13:45:44 +0100 Subject: [PATCH 1/2] Make metrics tokens and services variables easier to understand --- content/configuration/metrics.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/configuration/metrics.md b/content/configuration/metrics.md index 7a9ae309..7450493e 100644 --- a/content/configuration/metrics.md +++ b/content/configuration/metrics.md @@ -10,8 +10,8 @@ To enable performance and error measurement of connected services, Directus can | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------ | | `METRICS_ENABLED` | Whether or not to enable metrics. | `false` | | `METRICS_SCHEDULE` | The cron schedule at which to generate the metrics, the default is every minute | `*/1 * * * *` | -| `METRICS_TOKENS` | A CSV of tokens to allow access to via a `Authorization: Metrics ` header. By default it is restricted to admins | -- | -| `METRICS_SERVICES` | A CSV of directus services to observe metrics for. Currently `database`, `cache`, `redis` and `storage` are supported | `database,cache,redis,storage` | +| `METRICS_TOKENS` | A comma-separated list of tokens (e.g. `token1,token2`) to allow access via an `Authorization: Metrics ` header. By default it is restricted to admins | -- | +| `METRICS_SERVICES` | A comma-separated list of directus services to observe metrics for. Currently `database`, `cache`, `redis` and `storage` are supported | `database,cache,redis,storage` | | `METRICS_NAME_PREFIX` | Prefix applied to all Prometheus metric names. | `directus_` | | `METRICS_HEALTH_CHECK_PREFIX` | Prefix for health check keys used in cache, Redis, and storage checks. | `directus-metric-` | From 373c1ef42b23e7d0ac9212aadc3f20bc1b504396 Mon Sep 17 00:00:00 2001 From: daedalus <44623501+ComfortablyCoding@users.noreply.github.com> Date: Wed, 29 Jul 2026 16:13:11 -0400 Subject: [PATCH 2/2] improve consistency --- content/community/3.codebase/3.testing.md | 2 +- content/configuration/database.md | 2 +- content/configuration/files.md | 2 +- content/configuration/metrics.md | 16 ++++++++-------- content/configuration/security-limits.md | 18 +++++++++--------- .../8.visual-editor/1.frontend-library.md | 2 +- 6 files changed, 21 insertions(+), 21 deletions(-) diff --git a/content/community/3.codebase/3.testing.md b/content/community/3.codebase/3.testing.md index 561bdbce..8e090311 100644 --- a/content/community/3.codebase/3.testing.md +++ b/content/community/3.codebase/3.testing.md @@ -75,7 +75,7 @@ pnpm --filter tests-blackbox test --project db ### Testing Specific Database Vendors -Provide a CSV of database vendors via the `TEST_DB` environment variable to target only a specific subset: +Provide a comma-separated list of database vendors via the `TEST_DB` environment variable to target only a specific subset: ```bash # Example targeting multiple vendors diff --git a/content/configuration/database.md b/content/configuration/database.md index be76d456..f18324cb 100644 --- a/content/configuration/database.md +++ b/content/configuration/database.md @@ -17,7 +17,7 @@ description: Configuration for database connections. | `DB_PASSWORD` | Database user's password. Required when using `pg`, `mysql`, `oracledb`, or `mssql`. | | | `DB_FILENAME` | Where to read/write the SQLite database. Required when using `sqlite3`. | | | `DB_CONNECTION_STRING` | When using `pg`, you can submit a connection string instead of individual properties. Using this will ignore any of the other connection settings. | | -| `DB_EXCLUDE_TABLES` | CSV of tables you want Directus to ignore completely | `spatial_ref_sys,sysdiagrams` | +| `DB_EXCLUDE_TABLES` | A comma-separated list of tables for Directus to ignore completely. | `spatial_ref_sys,sysdiagrams` | | `DB_CHARSET` / `DB_CHARSET_NUMBER` | Charset/collation to use in the connection to MySQL[1](https://dev.mysql.com/doc/refman/8.0/en/charset-mysql.html)/MariaDB[2](https://mariadb.com/docs/server/reference/data-types/string-data-types/character-sets/supported-character-sets-and-collations). | `UTF8_GENERAL_CI` | | `DB_VERSION` | Database version, in case you use the PostgreSQL adapter to connect a non-standard database. Not usually required. | | | `DB_HEALTHCHECK_THRESHOLD` | Healthcheck timeout threshold in milliseconds. | `150` | diff --git a/content/configuration/files.md b/content/configuration/files.md index df031bb4..57cc6a01 100644 --- a/content/configuration/files.md +++ b/content/configuration/files.md @@ -18,7 +18,7 @@ In the Data Studio, files will automatically be uploaded to the first configured | Variable | Description | Default Value | | ------------------- | --------------------------------------------------------------------------------------------- | ------------- | -| `STORAGE_LOCATIONS` | A comma separated list of storage locations. You can use any names you'd like for these keys. | `local` | +| `STORAGE_LOCATIONS` | A comma-separated list of storage locations. You can use any names you'd like for these keys. | `local` | For each of the storage locations listed, you must provide the following configuration (variable name must be uppercase in these options): diff --git a/content/configuration/metrics.md b/content/configuration/metrics.md index 7450493e..8f6d1776 100644 --- a/content/configuration/metrics.md +++ b/content/configuration/metrics.md @@ -6,14 +6,14 @@ description: Configuration for metrics. To enable performance and error measurement of connected services, Directus can provide Prometheus metrics. -| Variable | Description | Default Value | -| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| `METRICS_ENABLED` | Whether or not to enable metrics. | `false` | -| `METRICS_SCHEDULE` | The cron schedule at which to generate the metrics, the default is every minute | `*/1 * * * *` | -| `METRICS_TOKENS` | A comma-separated list of tokens (e.g. `token1,token2`) to allow access via an `Authorization: Metrics ` header. By default it is restricted to admins | -- | -| `METRICS_SERVICES` | A comma-separated list of directus services to observe metrics for. Currently `database`, `cache`, `redis` and `storage` are supported | `database,cache,redis,storage` | -| `METRICS_NAME_PREFIX` | Prefix applied to all Prometheus metric names. | `directus_` | -| `METRICS_HEALTH_CHECK_PREFIX` | Prefix for health check keys used in cache, Redis, and storage checks. | `directus-metric-` | +| Variable | Description | Default Value | +| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | +| `METRICS_ENABLED` | Whether or not to enable metrics. | `false` | +| `METRICS_SCHEDULE` | The cron schedule at which to generate the metrics. | `*/1 * * * *` | +| `METRICS_TOKENS` | A comma-separated list of tokens (e.g. `token1,token2`) that grant access via the `Authorization: Metrics ` header. By default, access is restricted to admins. | -- | +| `METRICS_SERVICES` | A comma-separated list of Directus services to observe metrics for. Supported values: `database`, `cache`, `redis`, `storage`. | `database,cache,redis,storage` | +| `METRICS_NAME_PREFIX` | Prefix applied to all Prometheus metric names. | `directus_` | +| `METRICS_HEALTH_CHECK_PREFIX` | Prefix for health check keys used in cache, Redis, and storage checks. | `directus-metric-` | ::callout{icon="i-lucide-triangle-alert" color="warning"} **Metric Aggregation** diff --git a/content/configuration/security-limits.md b/content/configuration/security-limits.md index 44f51df5..a67150ad 100644 --- a/content/configuration/security-limits.md +++ b/content/configuration/security-limits.md @@ -68,15 +68,15 @@ Modifying `HASH_MEMORY_COST` and/or `HASH_PARALLELISM` will affect the amount of ## CORS -| Variable | Description | Default Value | -| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| `CORS_ENABLED` | Whether or not to enable the CORS headers. | `false` | -| `CORS_ORIGIN` | Value for the `Access-Control-Allow-Origin` header. Use `true` to match the Origin header, or provide a domain or a CSV of domains for specific access. | `false` | -| `CORS_METHODS` | Value for the `Access-Control-Allow-Methods` header. | `GET,POST,PATCH,DELETE` | -| `CORS_ALLOWED_HEADERS` | Value for the `Access-Control-Allow-Headers` header. | `Content-Type,Authorization` | -| `CORS_EXPOSED_HEADERS` | Value for the `Access-Control-Expose-Headers` header. | `Content-Range` | -| `CORS_CREDENTIALS` | Whether or not to send the `Access-Control-Allow-Credentials` header. | `true` | -| `CORS_MAX_AGE` | Value for the `Access-Control-Max-Age` header. | `18000` | +| Variable | Description | Default Value | +| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------- | +| `CORS_ENABLED` | Whether or not to enable the CORS headers. | `false` | +| `CORS_ORIGIN` | Value for the `Access-Control-Allow-Origin` header. Use `true` to match the Origin header, or provide a domain or a comma-separated list of domains for specific access. | `false` | +| `CORS_METHODS` | Value for the `Access-Control-Allow-Methods` header. | `GET,POST,PATCH,DELETE` | +| `CORS_ALLOWED_HEADERS` | Value for the `Access-Control-Allow-Headers` header. | `Content-Type,Authorization` | +| `CORS_EXPOSED_HEADERS` | Value for the `Access-Control-Expose-Headers` header. | `Content-Range` | +| `CORS_CREDENTIALS` | Whether or not to send the `Access-Control-Allow-Credentials` header. | `true` | +| `CORS_MAX_AGE` | Value for the `Access-Control-Max-Age` header. | `18000` | For more details about each configuration variable, please see the [CORS package documentation](https://www.npmjs.com/package/cors#configuration-options). diff --git a/content/guides/02.content/8.visual-editor/1.frontend-library.md b/content/guides/02.content/8.visual-editor/1.frontend-library.md index 275bfdf0..1fac6812 100644 --- a/content/guides/02.content/8.visual-editor/1.frontend-library.md +++ b/content/guides/02.content/8.visual-editor/1.frontend-library.md @@ -52,7 +52,7 @@ The generated attribute will be: ``` ::callout{icon="i-lucide-info"} -The `fields` property in the `setAttr` function can also accept an array of strings, which will render a comma separated list like: `data-directus="collection:posts;item:12;fields:title,subtitle,slug"` +The `fields` property in the `setAttr` function can also accept an array of strings, which will render a comma-separated list like: `data-directus="collection:posts;item:12;fields:title,subtitle,slug"` :: | Option | Type | Description |