Directus is developed and tested on the LAMP stack, and therefore this is the only officially supported environment. Alternate stacks (NGINX, Caddy, MariaDB, Percona, etc) may also work but you should proceed at your own risk. Please ensure your server meets the following requirements:
- MySQL 5.7+
- A Database (empty or existing)
- A Database User (with access to database)
- PHP 7.1+
Alternate SQL Vendors
In theory, Directus should work with MySQL drop-in alternatives such as MariaDB (
10.2+) or Percona Server. However, these are not officially supported so you should proceed at your own risk.
View our detailed requirements page to learn more about these requirements, necessary permissions, and other server-specific prerequisites.
Running the following
git command from your server's command line is the preferred method of installing the platform.
git clone https://github.com/directus/directus.git
Other Install Methods
Alternatively, you can choose from one of these other installation methods.
If you are using Apache, make sure
AllowOverride are enabled. Read more
- Set your document root to the
- Navigate your browser to the App at
- Follow the prompts to complete configuration (see below)
|Project Name||The name of your project|
|Project Key||The key that used in the URL of API endpoints|
|Admin Email||The email address of your first administrator|
|Admin Password||The password for your first administrator|
|Host||The server/host of your database|
|Port||The port for the database (default is 3306)|
|Database User||The database user|
|Database Password||The database user's password|
|Database Name||The name of the database|
|Database Type||As of now, Directus only supports MySQL|
Alternatively, you can manually configure Directus.
Once you've completed the installer you will automatically be taken to the login page of the Directus App. You can then login with the credentials you provided during configuration.
👍 You've successfully installed Directus! Now you're ready to add your first collection.
If you experience any issues after installation and/or setup, please first consult our Setup Checklist.