mirror of
https://github.com/directus/directus.git
synced 2026-04-25 03:00:53 -04:00
Make default values have consistent formatting (#8067)
This commit is contained in:
Azri Kahar
@@ -16,25 +16,25 @@
|
||||
| `LOG_STYLE` | Render the logs human readable (pretty) or as JSON. One of `pretty`, `raw`. | `pretty` |
|
||||
| `MAX_PAYLOAD_SIZE` | Controls the maximum request body size. Accepts number of bytes, or human readable string. | `100kb` |
|
||||
| `ROOT_REDIRECT` | Where to redirect to when navigating to `/`. Accepts a relative path, absolute URL, or `false` to disable. | `./admin` |
|
||||
| `SERVE_APP` | Whether or not to serve the Admin App under `/admin`. | true |
|
||||
| `SERVE_APP` | Whether or not to serve the Admin App under `/admin`. | `true` |
|
||||
|
||||
<sup>[1]</sup> The PUBLIC_URL value is used for things like oAuth redirects, forgot-password emails, and logos that
|
||||
needs to be publicly available on the internet.
|
||||
|
||||
## Database
|
||||
|
||||
| Variable | Description | Default Value |
|
||||
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- |
|
||||
| `DB_CLIENT` | **Required**. What database client to use. One of `pg` or `postgres`, `mysql`, `oracledb`, `mssql`, or `sqlite3`. | -- |
|
||||
| `DB_HOST` | Database host. **Required** when using `pg`, `mysql`, `oracledb`, or `mssql`. | -- |
|
||||
| `DB_PORT` | Database port. **Required** when using `pg`, `mysql`, `oracledb`, or `mssql`. | -- |
|
||||
| `DB_DATABASE` | Database name. **Required** when using `pg`, `mysql`, `oracledb`, or `mssql`. | -- |
|
||||
| `DB_USER` | Database user. **Required** when using `pg`, `mysql`, `oracledb`, or `mssql`. | -- |
|
||||
| `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_POOL_*` | Pooling settings. Passed on to [the `tarn.js`](https://github.com/vincit/tarn.js#usage) library. | -- |
|
||||
| `DB_EXCLUDE_TABLES` | CSV of tables you want Directus to ignore completely | spatial_ref_sys |
|
||||
| Variable | Description | Default Value |
|
||||
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
|
||||
| `DB_CLIENT` | **Required**. What database client to use. One of `pg` or `postgres`, `mysql`, `oracledb`, `mssql`, or `sqlite3`. | -- |
|
||||
| `DB_HOST` | Database host. **Required** when using `pg`, `mysql`, `oracledb`, or `mssql`. | -- |
|
||||
| `DB_PORT` | Database port. **Required** when using `pg`, `mysql`, `oracledb`, or `mssql`. | -- |
|
||||
| `DB_DATABASE` | Database name. **Required** when using `pg`, `mysql`, `oracledb`, or `mssql`. | -- |
|
||||
| `DB_USER` | Database user. **Required** when using `pg`, `mysql`, `oracledb`, or `mssql`. | -- |
|
||||
| `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_POOL_*` | Pooling settings. Passed on to [the `tarn.js`](https://github.com/vincit/tarn.js#usage) library. | -- |
|
||||
| `DB_EXCLUDE_TABLES` | CSV of tables you want Directus to ignore completely | `spatial_ref_sys` |
|
||||
|
||||
::: tip Additional Database Variables
|
||||
|
||||
@@ -57,8 +57,8 @@ All the `DB_POOL_` prefixed options are passed [to `tarn.js`](https://github.com
|
||||
| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |
|
||||
| `KEY` | Unique identifier for the project. | -- |
|
||||
| `SECRET` | Secret string for the project. | -- |
|
||||
| `ACCESS_TOKEN_TTL` | The duration that the access token is valid. | 15m |
|
||||
| `REFRESH_TOKEN_TTL` | The duration that the refresh token is valid, and also how long users stay logged-in to the App. | 7d |
|
||||
| `ACCESS_TOKEN_TTL` | The duration that the access token is valid. | `15m` |
|
||||
| `REFRESH_TOKEN_TTL` | The duration that the refresh token is valid, and also how long users stay logged-in to the App. | `7d` |
|
||||
| `REFRESH_TOKEN_COOKIE_DOMAIN` | Which domain to use for the refresh cookie. Useful for development mode. | -- |
|
||||
| `REFRESH_TOKEN_COOKIE_SECURE` | Whether or not to use a secure cookie for the refresh token in cookie mode. | `false` |
|
||||
| `REFRESH_TOKEN_COOKIE_SAME_SITE` | Value for `sameSite` in the refresh token cookie when in cookie mode. | `lax` |
|
||||
@@ -262,7 +262,7 @@ Based on your configured driver, you must also provide the following configurati
|
||||
| `STORAGE_<LOCATION>_SECRET` | User secret | -- |
|
||||
| `STORAGE_<LOCATION>_BUCKET` | S3 Bucket | -- |
|
||||
| `STORAGE_<LOCATION>_REGION` | S3 Region | -- |
|
||||
| `STORAGE_<LOCATION>_ENDPOINT` | S3 Endpoint | "s3.amazonaws.com" |
|
||||
| `STORAGE_<LOCATION>_ENDPOINT` | S3 Endpoint | `s3.amazonaws.com` |
|
||||
| `STORAGE_<LOCATION>_ACL` | S3 ACL | -- |
|
||||
|
||||
### Azure (`azure`)
|
||||
@@ -272,7 +272,7 @@ Based on your configured driver, you must also provide the following configurati
|
||||
| `STORAGE_<LOCATION>_CONTAINER_NAME` | Azure Storage container | -- |
|
||||
| `STORAGE_<LOCATION>_ACCOUNT_NAME` | Azure Storage account name | -- |
|
||||
| `STORAGE_<LOCATION>_ACCOUNT_KEY` | Azure Storage key | -- |
|
||||
| `STORAGE_<LOCATION>_ENDPOINT` | Azure URL | "https://{ACCOUNT_KEY}.blob.core.windows.net" |
|
||||
| `STORAGE_<LOCATION>_ENDPOINT` | Azure URL | `https://{ACCOUNT_KEY}.blob.core.windows.net` |
|
||||
|
||||
### Google Cloud Storage (`gcs`)
|
||||
|
||||
@@ -293,9 +293,9 @@ STORAGE_LOCAL_ROOT="./uploads"
|
||||
| Variable | Description | Default Value |
|
||||
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------- |
|
||||
| `ASSETS_CACHE_TTL` | How long assets will be cached for in the browser. Sets the `max-age` value of the `Cache-Control` header. | `30m` |
|
||||
| `ASSETS_TRANSFORM_MAX_CONCURRENT` | How many file transformations can be done simultaneously | 4 |
|
||||
| `ASSETS_TRANSFORM_IMAGE_MAX_DIMENSION` | The max pixel dimensions size (width/height) that is allowed to be transformed | 6000 |
|
||||
| `ASSETS_TRANSFORM_MAX_OPERATIONS` | The max number of transform operations that is allowed to be processed (excludes saved presets) | 5 |
|
||||
| `ASSETS_TRANSFORM_MAX_CONCURRENT` | How many file transformations can be done simultaneously | `4` |
|
||||
| `ASSETS_TRANSFORM_IMAGE_MAX_DIMENSION` | The max pixel dimensions size (width/height) that is allowed to be transformed | `6000` |
|
||||
| `ASSETS_TRANSFORM_MAX_OPERATIONS` | The max number of transform operations that is allowed to be processed (excludes saved presets) | `5` |
|
||||
|
||||
Image transformations can be fairly heavy on memory usage. If you're using a system with 1GB or less available memory,
|
||||
we recommend lowering the allowed concurrent transformations to prevent you from overflowing your server.
|
||||
@@ -363,7 +363,7 @@ Based on the `EMAIL_TRANSPORT` used, you must also provide the following configu
|
||||
| ----------------------- | --------------------------------------------------------------------------------- | ----------------- |
|
||||
| `EMAIL_MAILGUN_API_KEY` | Your Mailgun API key. | -- |
|
||||
| `EMAIL_MAILGUN_DOMAIN` | A domain from [your Mailgun account](https://app.mailgun.com/app/sending/domains) | -- |
|
||||
| `EMAIL_MAILGUN_HOST` | Allows you to specify a custom host. | 'api.mailgun.net' |
|
||||
| `EMAIL_MAILGUN_HOST` | Allows you to specify a custom host. | `api.mailgun.net` |
|
||||
|
||||
## Admin Account
|
||||
|
||||
@@ -383,7 +383,7 @@ environment variable:
|
||||
|
||||
| Variable | Description | Default Value |
|
||||
| ----------- | ----------------------------------------------------------------- | ------------- |
|
||||
| `TELEMETRY` | Allow Directus to collect anonymized data about your environment. | true |
|
||||
| `TELEMETRY` | Allow Directus to collect anonymized data about your environment. | `true` |
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user