directus-extension-environment-lock

This bundle extension adds the ability to lock schema changes in a specific environment, and includes a panel that displays the status of the environment lock.

[!CAUTION] This extension is still work in progress, and have not been extensively tested. Use with caution!

Features

• Lock schema changes in a specific environment
• Display the status of the environment lock in a panel
• Exclude specific filters from the environment lock
• Whitelist specific roles from the environment lock

Installation

Install the extension from the Directus Marketplace. See the Official Guide for more information.

Or if you prefer to install manually:

npm install directus-extension-environment-lock

Usage

Environment Variables

| Variable | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | DIRECTUS_ENV_LOCKED | A comma-separated list of environments that are locked. | | DIRECTUS_ENV_WHITELISTED_ROLES | A comma-separated list of role UUIDS that are allowed to make schema changes and bypass the environment lock. | | DIRECTUS_ENV_WHITELISTED_TOKENS | A comma-separated list of tokens that are allowed to make schema changes and bypass the environment lock. | | DIRECTUS_ENV_INCLUDE_FILTERS | A comma-separated list of filters that are included in the environment lock. Will merge with the defaults. | | DIRECTUS_ENV_EXCLUDE_FILTERS | A comma-separated list of filters that are excluded from the environment lock. |

DIRECTUS_ENV_LOCKED

A comma-separated list of environments that are locked.

Default: null

Example:

DIRECTUS_ENV_LOCKED="development,staging"

DIRECTUS_ENV_WHITELISTED_ROLES

A comma-separated list of role UUIDS that are allowed to make schema changes and bypass the environment lock.

Default: null

Example:

DIRECTUS_ENV_WHITELISTED_ROLES="123e4567-e89b-12d3-a456-426614174000,123e4567-e89b-12d3-a456-426614174001"

DIRECTUS_ENV_WHITELISTED_TOKENS

A comma-separated list of tokens that are allowed to make schema changes and bypass the environment lock.

Default: null

Example:

DIRECTUS_ENV_WHITELISTED_TOKENS="123e4567-e89b-12d3-a456-426614174000,123e4567-e89b-12d3-a456-426614174001"

DIRECTUS_ENV_INCLUDE_FILTERS

A comma-separated list of filters that are included in the environment lock. Will merge with the defaults.

Default: See available filters

Example:

DIRECTUS_ENV_INCLUDE_FILTERS="fields.create,fields.update,fields.delete"

DIRECTUS_ENV_EXCLUDE_FILTERS

A comma-separated list of filters that are excluded from the environment lock.

Default: null

Example:

DIRECTUS_ENV_EXCLUDE_FILTERS="fields.create,fields.update,fields.delete"

Available filters

The following filters are active by default. You can exclude specific filters from the environment lock by setting the DIRECTUS_ENV_EXCLUDE_FILTERS environment variable, or include others by setting the DIRECTUS_ENV_INCLUDE_FILTERS environment variable.

List of all available filters

| Filter | Description | | ------------------ | --------------------------- | | fields.create | Creation of any fields | | fields.update | Updates to any fields | | fields.delete | Deletion of any fields | | collections.create | Creation of any collections | | collections.update | Updates to any collections | | collections.delete | Deletion of any collections | | relations.create | Creation of any relations | | relations.update | Updates to any relations | | settings.update | Updates to any settings | | roles.create | Creation of any roles | | roles.update | Updates to any roles | | roles.delete | Deletion of any roles | | policies.create | Creation of any policies | | policies.update | Updates to any policies | | policies.delete | Deletion of any policies |

Panel

The extension includes a panel that displays the status of the environment lock.

Hooks

The extension includes hooks that are used to lock schema changes in a specific environment.

Development

Setup

1. Load Extension volume in your project and clone the repository to it

2. Install dependencies:

cd extensions/directus-extension-environment-lock

npm install

3. Build the extension with auto rebuild on changes:

npm run dev

Make sure you've set EXTENSIONS_AUTO_RELOAD in your .env file.

You might need to restart your Directus instance for the extension to be loaded.

Building

npm run build