Skip to main content

Directus Logo

​
Introduction to Directus

Directus is a real-time API and App dashboard for managing SQL database content. Built on Node.js, it instantly layers a blazingly fast API on top of any SQL database, providing a beautiful no-code dashboard for managing your data.

​
What is Directus?

Directus wraps your database with a dynamic API and provides an intuitive admin app for managing content. It works with new or existing SQL databases, requiring no migration.

Quick Start

Get up and running with Directus in under 5 minutes

Installation Guide

Detailed installation instructions for Docker, npm, and pnpm

API Reference

Explore the REST and GraphQL API endpoints

SDK Documentation

Learn how to use the TypeScript SDK for API clients

​
Key Features

Directus automatically generates a complete REST and GraphQL API on top of your SQL database. The API is:
  • Blazingly fast - Built on Node.js with optimized queries
  • Real-time - WebSocket support for live data updates
  • Fully documented - Auto-generated OpenAPI specifications
  • Extensible - Custom endpoints and middleware support
Directus supports all major SQL databases out of the box:
  • PostgreSQL - Full support including PostGIS for geospatial data
  • MySQL - Versions 5.7+ and 8.x
  • SQLite - Perfect for development and small deployments
  • MariaDB - Full compatibility
  • MS SQL Server - Enterprise database support
  • OracleDB - Oracle database integration
  • CockroachDB - Distributed SQL database support
A modern Vue.js dashboard that’s safe and intuitive for non-technical users:
  • No training required - Clean, intuitive interface
  • 45+ field interfaces - Rich input types for every data type
  • 21 display renderers - Beautiful data visualization
  • 8 layout views - Table, cards, calendar, map, and more
  • Fully customizable - White-label and extend with custom components
Built to white-label and customize:
  • Custom interfaces - Create your own field input types
  • Custom layouts - Build unique data views
  • Custom endpoints - Add your own API routes
  • Hooks & operations - Extend business logic with flows
  • Storage drivers - Support for S3, Azure, GCS, Cloudinary, and more
Deploy Directus anywhere:
  • Self-hosted - Full control over your infrastructure
  • Docker - Easy containerized deployment
  • Directus Cloud - Managed hosting starting at $15/month
  • One-click deploy - Railway, and other platforms
Production-ready features:
  • Authentication - Local, OAuth, LDAP, SAML, OpenID support
  • Granular permissions - Role-based access control
  • Rate limiting - Built-in protection and quotas
  • Caching - Redis integration for performance
  • Webhooks & flows - Automation and integrations
  • Audit logs - Complete activity tracking

​
Architecture

Directus is a pnpm monorepo containing:
  • @directus/api - Node.js backend with REST & GraphQL APIs (Express.js, Knex.js)
  • @directus/app - Vue 3 dashboard application (Vite, Pinia)
  • @directus/sdk - TypeScript SDK for Directus API clients
  • 35+ shared packages - Types, utilities, storage drivers, extensions, and more

​
Requirements

Node.js

Node.js 22 or higher is required to run Directus

Database

Any supported SQL database: PostgreSQL, MySQL, SQLite, MariaDB, MS SQL, Oracle, or CockroachDB

​
Deployment Options

The fastest way to get started. Directus Cloud offers:
  • 90-second provisioning - Create projects instantly
  • Everything included - Database, storage, auto-scaling, CDN
  • Global regions - Choose your deployment location
  • Starting at $15/month - Managed by the Directus team
Create a Directus Cloud Project →

​
License

Directus is licensed under the Business Source License (BSL) 1.1 with a permissive additional use grant.
Free for most users: If your organization has less than $5M in annual revenue and/or funding combined, you can use Directus freely in any way you’d like.
Enterprise usage: For larger organizations (>$5M in annual revenue/funding) using Directus in production, a commercial license is required.

​
Community & Support

Documentation

Comprehensive guides and API reference

Community Forum

Ask questions and join discussions

Discord

Real-time community chat

GitHub

Report bugs and request features

YouTube

Video tutorials and demos

Twitter

Latest news and updates

​
Next Steps

1

Quick Start

Follow the Quick Start guide to get Directus running in under 5 minutes
2

Install Directus

Read the detailed Installation guide for production deployments
3

Explore the API

Learn about the REST and GraphQL API endpoints
4

Build with the SDK

Use the TypeScript SDK to integrate Directus into your applications

Build docs developers (and LLMs) love

Get started for freeTalk to us