Directus 7 Docker — Official Container for Directus
Branch: master
Clone or download

README.md

Directus Logo

 

The All-New Directus 7
Future-Proof Headless CMS

WebsiteDocsAPI ReferenceUser GuideDemoContribute

 

Warning: docker support is experimental and we're still gathering some more feedback from the community. You can raise issues or ping us in #docker channel on Slack.

Overview

Directus docker images can be found in docker hub under directus username. Images are pushed automatically each time a new release is created in api or app repositories.

API Container

Requirements

  • MySQL compatible database container running

Configuration

API can be configured via environment variables. These are some of the supported variables.

General variables

Environment Required Default Description
APP_TIMEZONE   America/New_York The API server timezone

Authentication variables

Environment Required Default Description
ADMIN_EMAIL Yes*   The admin email
ADMIN_PASSWORD   generated** The admin password

* If there's no directus tables on the database, the auto-installation process will require you to provide the initial admin email, thus requiring the ADMIN_EMAIL variable in order to seed the initial user into the database.

** The installation process will not require the ADMIN_PASSWORD to be set, and if it doesn't detect it, it will generate a new password and output the credentials in the logs when it finishes seeding.

Database variables

Environment Required Default Description
DATABASE_HOST Yes   The database hostname/address
DATABASE_USERNAME Yes   The database username
DATABASE_PASSWORD Yes   The database password
DATABASE_PORT   3306 The database port
DATABASE_NAME   directus The database name
DATABASE_TYPE   mysql The database type
DATABASE_ENGINE   InnoDB The database engine
DATABASE_CHARSET   utfmb4 The database charset

API Container

Configuration

API can be configured via environment variables. These are some of the supported variables.

General variables

Environment Required Default Description
API_ENDPOINT[_NAME] At least once   The supported `api` endpoints.
Should follow the format "Name; url"

You can manage multiple api endpoints using only one instance of app container. For example, if you want to manage two instances, you should set two variables that starts with API_ENDPOINT_

API_ENDPOINT_STAGING="Staging; http://staging.server.com/_/"
API_ENDPOINT_PRODUCTION="Production; http://production.server.com/_/"

Examples

You can check examples under the examples folder on GitHub.

 


Directus is released under the GPLv3 license. RANGER Studio LLC owns all Directus trademarks and logos on behalf of our project's community. Copyright © 2006-2018, RANGER Studio LLC.