Skip to content

Mention EXTENSIONS_LOCATION corresponds with STORAGE_LOCATIONS #394

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.

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
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
25 changes: 13 additions & 12 deletions content/configuration/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,27 @@ description: Configuration for extensions and the Directus Marketplace.

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

| Variable | Description | Default Value |
| -------------------------------------- | ------------------------------------------------------------------------------- | -------------- |
| `EXTENSIONS_PATH`<sup>[1]</sup> | Path to your local extensions directory. | `./extensions` |
| `EXTENSIONS_MUST_LOAD` | Exit the server when any API extension fails to load. | `false` |
| `EXTENSIONS_AUTO_RELOAD`<sup>[2], [3]</sup> | Automatically reload extensions when they have changed. | `false` |
| `EXTENSIONS_CACHE_TTL`<sup>[4]</sup> | How long custom app Extensions get cached by browsers. | |
| `EXTENSIONS_LOCATION`<sup>[5]</sup> | What configured storage location to use for extensions. | |
| `EXTENSIONS_LIMIT` | Maximum number of extensions you allow to be installed through the Marketplace. | |
| Variable | Description | Default Value |
| ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| `EXTENSIONS_PATH`<sup>[1]</sup> | Path to your local extensions directory, or subdirectory within the configured storage location when `EXTENSIONS_LOCATION` is set. | `./extensions` |
| `EXTENSIONS_MUST_LOAD` | Exit the server when any API extension fails to load. | `false` |
| `EXTENSIONS_AUTO_RELOAD`<sup>[2], [3]</sup> | Automatically reload extensions when they have changed. | `false` |
| `EXTENSIONS_CACHE_TTL`<sup>[4]</sup> | How long custom app Extensions get cached by browsers. | |
| `EXTENSIONS_LOCATION`<sup>[5], [6]</sup> | Key of the configured [storage locations](/configuration/files) to load extensions from a specific storage location. | |
| `EXTENSIONS_LIMIT` | Maximum number of extensions you allow to be installed through the Marketplace. | |

<sup>[1]</sup> If `EXTENSIONS_LOCATION` is configured, this is the path to the extensions directory within the selected
storage location.
<sup>[1]</sup> When EXTENSIONS_LOCATION is set, this defines the path inside the selected storage location where extensions reside.

<sup>[2]</sup> `EXTENSIONS_AUTO_RELOAD` will not work when the `EXTENSION_LOCATION` environment variable is set.
<sup>[2]</sup> `EXTENSIONS_AUTO_RELOAD` will not work when the `EXTENSIONS_LOCATION` environment variable is set.

<sup>[3]</sup> `EXTENSIONS_AUTO_RELOAD` will likely not work on Windows machines without also setting the `CHOKIDAR_USEPOLLING` environment variable to `true`.

<sup>[4]</sup> The `EXTENSIONS_CACHE_TTL` environment variable controls for how long [app extensions](/guides/extensions/app-extensions) are cached by browsers. By default, extensions are not cached.
<sup>[4]</sup> The `EXTENSIONS_CACHE_TTL` environment variable controls how long [app extensions](/guides/extensions/app-extensions) are cached by browsers. By default, extensions are not cached.

<sup>[5]</sup> By default extensions are loaded from the local file system. `EXTENSIONS_LOCATION` can be used to load extensions from a storage location instead.

<sup>[6]</sup> The value of `EXTENSIONS_LOCATION` must correspond to a key defined in your `STORAGE_LOCATIONS` environment variable.

## Marketplace

| Variable | Description | Default Value |
Expand Down