Skip to content

Latest commit

 

History

History
96 lines (63 loc) · 3.52 KB

install.md

File metadata and controls

96 lines (63 loc) · 3.52 KB
Raw

Installing the Directus Suite

The easiest way to get up-and-running with Directus is with our combined release, which includes the Directus API, the Directus Application, and all required dependencies. Check that your server meets the requirements, then choose one of the three ways to install the combined release.

Requirements

  • HTTP/Web Server
  • MySQL 5.2+
    • Database (empty or existing)
    • Database User (with access to database)
  • PHP 5.6+
    • pdo + mysql
    • curl
    • gd
    • fileinfo
    • mbstring

:::warning Important Click here to learn more about these system requirements, neccesary permissions, and other important and server-specific prerequisites. :::

Install Using Git

The preferred method of installing is through Git by running the following command from your server's command line.

git clone https://github.com/directus/directus.git

:::tip Don't have git? You can install it with one command. :::

Install Manually

If you don't have access to the command line or would rather do things manually, you can download the static bundle manually as a zip or tar file from our releases page.

:::tip If your server doesn't have gzip then you can usually install it by running sudo apt-get install zip. :::

Zip File

# Get the zip file from GitHub
wget https://github.com/directus/directus/archive/master.zip

# Decompress the file
unzip master.zip

Tar File

# Get the zip file from GitHub
wget https://github.com/directus/directus/archive/master.tar.gz

# Decompress the file
tar -xzf master.tar.gz

Using FTP

If you don't have access to the command line then you'll need to decompress the files on your local computer before uploading to the remote server, though this will take much longer.

Install Using Docker

@TODO

Our Docker image goes a few steps further by including the database and server setup. It's the most fool-proof way to install Directus.

Download a copy of the latest release from the Releases Page, cd into the directory and run

$ docker build . -t directus

Once the image has been built, you can run it with

$ docker run -it -d -e API_URL=<url> -p <port>:80 <name>

Replace <url> with the API URL you'd like to connect to, <port> with the port you want the application to be exposed on, and <name> with a name of your choosing which Docker will use internally.

Other Options

Install Individually

If you prefer, you can choose to only install the Directus API, or only install the Directus App. This is useful for multitenancy, such as when you need many instances of the API but only one App to manage them all.

Install from Source

If you would like to extend or make contributions to the core codebase then you can install the Directus API Source, or install the Directus App Source. This process involves more steps, so we recommend using the combined build for normal usage.