Installing Manually

::: tip Automation We've created a little CLI tool you can run that does this process automatically. For more info, check the doc on installing through the CLI. :::

1. Setup a Project Folder

And add a package.json by running the following command.

npm init -y

We recommend aliasing the start script to Directus' start for easier deployments to services like AWS or DigitalOcean App Platform.

{
	"scripts": {
		"start": "directus start"
	}
}

2. Install Directus

npm install directus

3. Install one of the Database Drivers

Choose the database vendor you will be working with, and install its driver.

npm install pg

4. Install Optional Dependencies

At this point you have the option of installing other dependencies. If you're planning on utilizing Redis/Memcached, make sure to install ioredis/memcached respectively.

5. Setup a Configuration File

Finally, you'll need to setup your .env file, or configure the environment variables through other means, such as Docker, etc.

See Environment Variables for all available variables.

1.3 KiB Raw Blame History