Skip to content

docs: document EXTENSIONS_SYNC_MAX_CONCURRENCY #789

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
dstockton wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document EXTENSIONS_SYNC_MAX_CONCURRENCY #789

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 15 additions & 12 deletions content/configuration/extensions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,16 @@ description: Configuration for extensions and the Directus Marketplace.
For guidance on restricting who can install or manage extensions, see [Security Best Practices](/guides/security/best-practices#extensions).
::

| 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. | |
| `EXTENSIONS_ROLLDOWN` | Enable use of [Rolldown](https://rolldown.rs/) to optimize extensions bundling. | `false` |
| 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. | |
| `EXTENSIONS_ROLLDOWN` | Enable use of [Rolldown](https://rolldown.rs/) to optimize extensions bundling. | `false` |
| `EXTENSIONS_SYNC_MAX_CONCURRENCY`<sup>[7]</sup> | Maximum number of concurrent downloads when syncing extensions from the configured storage location. | `20` |

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

Expand All @@ -32,11 +33,13 @@ For guidance on restricting who can install or manage extensions, see [Security

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

<sup>[7]</sup> `EXTENSIONS_SYNC_MAX_CONCURRENCY` only applies when `EXTENSIONS_LOCATION` is set, as extensions are then downloaded from the storage location on startup.

## Marketplace

| Variable | Description | Default Value |
| ---------------------- | ------------------------------------------------- | ------------------------------ |
| `MARKETPLACE_TRUST` | One of `sandbox`, `all` | `sandbox` |
| Variable | Description | Default Value |
| ---------------------- | ------------------------------------------------- | ------------------------------- |
| `MARKETPLACE_TRUST` | One of `sandbox`, `all` | `sandbox` |
| `MARKETPLACE_REGISTRY` | The registry to use for the Directus Marketplace. | `https://registry.directus.com` |

::callout{icon="i-lucide-info"}
Expand Down
Loading