mirror of
https://github.com/directus/directus.git
synced 2026-02-15 14:05:13 -05:00
8b39c49da3
* created self-hosted section, moved installation guides, and re-edited first draft of the cloud quickstart guide
* refactored step 1 into two steps
* added media
* pre-mgmt submission proofread
* pulled down on wrong branch.
Revert "pre-mgmt submission proofread"
This reverts commit dfd678d083.
* proof-edited
* forgot to save before last comit
* fixed italic issue where I started with _ and ended with *
* tiny tweaks
* tiny tweak 2.0
* tiny tweak 4
* tiny tweak 5
91 lines
2.9 KiB
Markdown
91 lines
2.9 KiB
Markdown
# Installing from CLI
|
|
|
|
## 1. Confirm Minimum Requirements
|
|
|
|
Directus requires two things to run: [Node.js](https://nodejs.dev) and a Database. For both these system requirements,
|
|
we aim to support the current LTS release (and newer).
|
|
|
|
To run Directus, you currently need Node 12.20 or newer, and one of the following databases:
|
|
|
|
| Database | Version |
|
|
| ------------------------------------- | ----------- |
|
|
| PostgreSQL | 10+ |
|
|
| MySQL <sup>[1]</sup> | 5.7.8+ / 8+ |
|
|
| SQLite | 3+ |
|
|
| MS SQL Server | 13+ |
|
|
| MariaDB <sup>[2]</sup> | 10.2.7+ |
|
|
| CockroachDB <sup>[2]</sup> | 21.1.13+ |
|
|
| OracleDB<sup>[2]</sup> <sup>[3]</sup> | 19+ |
|
|
|
|
<sup>[1]</sup> MySQL 8+ requires
|
|
[mysql_native_password](https://dev.mysql.com/doc/refman/8.0/en/upgrading-from-previous-series.html#upgrade-caching-sha2-password-compatible-connectors)
|
|
to be enabled\
|
|
<sup>[2]</sup> Older versions may work, but aren't officially supported. Use at your own risk. \
|
|
<sup>[3]</sup> Make sure to install `node-oracledb` and it's system dependencies when using OracleDB
|
|
|
|
::: tip Variants
|
|
|
|
In addition to the databases above, other variants are also supported, including **AWS Aurora** (MySQL), **AWS
|
|
Redshift** (PostgreSQL), **Azure SQL** (MS SQL).
|
|
|
|
:::
|
|
|
|
::: tip Apple Silicon
|
|
|
|
When installing Directus on an Apple-made ARM CPU, make sure you have `libvips` installed. See
|
|
[Apple M1](https://sharp.pixelplumbing.com/install#apple-m1).
|
|
|
|
:::
|
|
|
|
## 2. Create a Project
|
|
|
|
Navigate to the directory where you wish to create a new Directus project. The new project and directory will be created
|
|
inside the current directory. Create a new Directus project by running the following npm command.
|
|
|
|
```bash
|
|
npm init directus-project my-project
|
|
```
|
|
|
|
::: warning
|
|
|
|
Except for SQLite, the database must already be running before creating your Directus project.
|
|
|
|
:::
|
|
|
|
## 3. Start your Project
|
|
|
|
To start Directus, navigate to the project directory, _my-project_.
|
|
|
|
```bash
|
|
cd my-project
|
|
```
|
|
|
|
Run the following command in your project directory.
|
|
|
|
```bash
|
|
npx directus start
|
|
```
|
|
|
|
## 4. View your Project
|
|
|
|
The default port used by Directus is 8055. To view your project locally, go to
|
|
[http://localhost:8055](http://localhost:8055) in your browser.
|
|
|
|
::: tip Changing Port
|
|
|
|
If you want to use a different port, use [the `PORT` environment variable](/configuration/config-options/#general).
|
|
|
|
:::
|
|
|
|
::: tip .env Permissions
|
|
|
|
By default, the `create-directus-project` tool will set the file permissions of the generated `.env` to `-rw-r-----`
|
|
(0640). If you run Directus from a separate user on your machine, make sure these permissions are correct.
|
|
|
|
:::
|
|
|
|
## Configure / Update / Upgrade your Project
|
|
|
|
See the [Updates & Migrations](/configuration/upgrades-migrations/) to learn how to maintain your project moving
|
|
forward.
|