Directus Documentation

Learn how to get started and implement Directus through our developer resources.
This documentation is brand new and we'd love your feedback while we finish the details.
On each page you'll find a and button with the chance to share more feedback or open an issue directly on the directus/docs repo. Thanks in advance!

Try a Demo

Run Docker locally and use the following command to start the project.

docker run -p 8055:8055 directus/directus

This project has no persistence. All data will be lost when the container is stopped. Read our Create a Project guide to learn how to create a project with persistence.

The initial admin user's credentials will be visible on the terminal.

Try our hosted demo project. This is a public demo project that is occasionally reset but please don't input sensitive data.

Getting Started

Platform Overview

Get starting with using Directus.

Directus Academy

Learn to use Directus in our video series.

Features

Data Engine

APIs and developer tools for your data.

Connect Realtime Auth Automate

Data Studio

A data web app your whole team will love.

Explore Editor Insights Files

Directus APIs

Quickstart

Learn to connect with Directus.

API Reference

Learn how to use the Directus API.

SDK

Official JavaScript and TypeScript library.

Tutorials

Integrate Your Frontend

Learn how to build a website using Directus as a Headless CMS using various frameworks.

Build Projects with Directus

Learn from a variety of different usecases you can build using Directus.

Tips and Tricks

Small concepts and techniques to get the most from Directus.

Migrate

Techniques and considerations when migrating from other platforms to Directus.

Extensions

Learn to build extensions from examples that amplify Directus' functionality.

Workflows

Learn to set up common patterns to build complex workflows and integrations.
See All Tutorials

Releases

GitHub Releases

See the complete and latest updates and release notes for Directus.

Breaking Changes

Breaking changes may require action on your part before upgrading.

Changelog

A monthly summary of what's new from the Directus team.

Community-Maintained Tooling

Python SDK

Interact with Directus using Python.

Go SDK

Interact with Directus using Go.

Dart SDK

Interact with Directus using Dart.

Nuxt Module

Easily connect your Nuxt application to your Directus project.

Helm Chart

Community-maintained Helm Charts repository for Directus.
These are built and maintained by our awesome community. If you are building tooling and want to include it here, please open a pull request on GitHub.

Advanced Concepts

Environment Variables

Configure Directus at an advanced level.

Building Extensions

Learn to build Extensions for Directus.

Self-Hosting

Learn to self-host Directus in your infrastructure.