mirror of
https://github.com/directus/directus.git
synced 2026-04-25 03:00:53 -04:00
Format md
This commit is contained in:
rijkvanzanten
@@ -1,26 +1,36 @@
|
||||
# Backing Directus
|
||||
|
||||
> Directus is both _premium_ and _free_ — two things that don't often go together. It takes significant resources to maintain and advance the platform. If you'd like to help keep Directus active and open-source please consider supporting it through one of the methods below.
|
||||
> Directus is both _premium_ and _free_ — two things that don't often go together. It takes
|
||||
> significant resources to maintain and advance the platform. If you'd like to help keep Directus
|
||||
> active and open-source please consider supporting it through one of the methods below.
|
||||
|
||||
## Financial Support
|
||||
|
||||
Talented full-time and part-time staff, infrastructure, and third-party services are just some of our organization's expenses, and revenue from our Cloud services and donations from sponsors dosen't fully cover those costs. Below are a few ways to help us keep the lights on and move towards self-sufficiency.
|
||||
Talented full-time and part-time staff, infrastructure, and third-party services are just some of
|
||||
our organization's expenses, and revenue from our Cloud services and donations from sponsors dosen't
|
||||
fully cover those costs. Below are a few ways to help us keep the lights on and move towards
|
||||
self-sufficiency.
|
||||
|
||||
### GitHub Sponsors
|
||||
|
||||
Monthly donations via [GitHub Sponsors](#) are the most reliable form of financial support, and donations made directly to our core developers are currently **doubled** by GitHub's matching program!
|
||||
Monthly donations via [GitHub Sponsors](#) are the most reliable form of financial support, and
|
||||
donations made directly to our core developers are currently **doubled** by GitHub's matching
|
||||
program!
|
||||
|
||||
* [rijkvanzanten](https://github.com/rijkvanzanten) — Technical Lead
|
||||
* [WoLfulus](https://github.com/WoLfulus) — DevOps
|
||||
* [Nitwel](https://github.com/Nitwel) — Developer
|
||||
- [rijkvanzanten](https://github.com/rijkvanzanten) — Technical Lead
|
||||
- [WoLfulus](https://github.com/WoLfulus) — DevOps
|
||||
- [Nitwel](https://github.com/Nitwel) — Developer
|
||||
|
||||
### Sponsored Work
|
||||
|
||||
[Commissioned Features](#) and [Expedited Fixes](#) are great ways to financially support the development of Directus, and improve the codebase for the community.
|
||||
[Commissioned Features](#) and [Expedited Fixes](#) are great ways to financially support the
|
||||
development of Directus, and improve the codebase for the community.
|
||||
|
||||
### Merch
|
||||
|
||||
Our merchandise is a great way to support Directus — you get some swag, and we get some financial support and advertising. Simply make an appropriate financial donation through [GitHub Sponsors](#), message us with sizing/shipping details, and we'll get it shipped!
|
||||
Our merchandise is a great way to support Directus — you get some swag, and we get some financial
|
||||
support and advertising. Simply make an appropriate financial donation through [GitHub Sponsors](#),
|
||||
message us with sizing/shipping details, and we'll get it shipped!
|
||||
|
||||
## Other Contributions
|
||||
|
||||
@@ -28,20 +38,30 @@ Below are several ways anyone can help improve our ecosystem.
|
||||
|
||||
### Code Pull Requests
|
||||
|
||||
Squashing bugs, optimizing the codebase, increasing test coverage, and adding new features, are all extremely valuable. Not technical? We have plenty of documentation that can always use some extra attention. Learn more in our [Contributors Guide](#).
|
||||
Squashing bugs, optimizing the codebase, increasing test coverage, and adding new features, are all
|
||||
extremely valuable. Not technical? We have plenty of documentation that can always use some extra
|
||||
attention. Learn more in our [Contributors Guide](#).
|
||||
|
||||
### Translations
|
||||
|
||||
Every translation enables users in new languages to use our international platform. Our [Crowdin integration](#) makes polishing existing translations or creating new ones a breeze.
|
||||
Every translation enables users in new languages to use our international platform. Our
|
||||
[Crowdin integration](#) makes polishing existing translations or creating new ones a breeze.
|
||||
|
||||
### Bug Reporting
|
||||
|
||||
If you encounter an issue within Directus, no matter how small, we would love to hear about it. Proper bug reporing helps our team assess the platform's stability. [Report a bug](#)
|
||||
If you encounter an issue within Directus, no matter how small, we would love to hear about it.
|
||||
Proper bug reporing helps our team assess the platform's stability. [Report a bug](#)
|
||||
|
||||
### Brand Advocacy
|
||||
|
||||
You can create _perfect_ software, but if no one knows about it, it's all for naught. Marketing and advertising are expensive, but you can help us avoid these costs with the following quick options:
|
||||
You can create _perfect_ software, but if no one knows about it, it's all for naught. Marketing and
|
||||
advertising are expensive, but you can help us avoid these costs with the following quick options:
|
||||
|
||||
* **GitHub Stars** — The primary metric by which we measure our success. It only takes five seconds to head to [directus/directus](#) and click the star — enough in a short period of time and Directus gets featured on GitHub's trending page!
|
||||
* **Social Posts** — A quick post mentioning [@directus](https://twitter.com/directus) goes a long way, and we re-tweet the team's favorite shout-outs to our 30K+ followers.
|
||||
* **Testimonials** — _One sentence._ Even that was a sentence, and it was only two words! If you're a fan of Directus, we'd love to hear why with a short endorsement. Shoot us an [email](#), [Tweet](#), or [Discord](#) message with your name, title, and company.
|
||||
- **GitHub Stars** — The primary metric by which we measure our success. It only takes five
|
||||
seconds to head to [directus/directus](#) and click the star — enough in a short period of time
|
||||
and Directus gets featured on GitHub's trending page!
|
||||
- **Social Posts** — A quick post mentioning [@directus](https://twitter.com/directus) goes a long
|
||||
way, and we re-tweet the team's favorite shout-outs to our 30K+ followers.
|
||||
- **Testimonials** — _One sentence._ Even that was a sentence, and it was only two words! If
|
||||
you're a fan of Directus, we'd love to hear why with a short endorsement. Shoot us an
|
||||
[email](#), [Tweet](#), or [Discord](#) message with your name, title, and company.
|
||||
|
||||
@@ -1,32 +1,48 @@
|
||||
# Contributing
|
||||
|
||||
> Our team truly appreciates every single pull-request, bug report, and feature request made by our community. If you have _any_ questions along the way, please reach out to our Core team on [Discord](https://directus.chat).
|
||||
> Our team truly appreciates every single pull-request, bug report, and feature request made by our
|
||||
> community. If you have _any_ questions along the way, please reach out to our Core team on
|
||||
> [Discord](https://directus.chat).
|
||||
|
||||
## Node Monorepo
|
||||
|
||||
Our Node.js repository is located at `directus/directus` and houses the Admin App (vue.js 3), Node.js API, project documentation (markdown), and API Specification (OpenAPI). Directus follows a monorepo design similar to React or Babel — to learn more about our monorepo's design and structure, see our [Codebase Overview](#) below.
|
||||
Our Node.js repository is located at `directus/directus` and houses the Admin App (vue.js 3),
|
||||
Node.js API, project documentation (markdown), and API Specification (OpenAPI). Directus follows a
|
||||
monorepo design similar to React or Babel — to learn more about our monorepo's design and structure,
|
||||
see our [Codebase Overview](#) below.
|
||||
|
||||
To contribute to the project, please follow the instructions located within our GitHub repoitory's [contributing.md file](#).
|
||||
To contribute to the project, please follow the instructions located within our GitHub repoitory's
|
||||
[contributing.md file](#).
|
||||
|
||||
::: tip PHP API Port
|
||||
While the Node.js version of Directus defines the official specification and is our team's primary focus, we also support a community-lead PHP API port in Laravel. This secondary codebase is located in a separate git repository at [`directus/php`](#).
|
||||
:::
|
||||
::: tip PHP API Port While the Node.js version of Directus defines the official specification and is
|
||||
our team's primary focus, we also support a community-lead PHP API port in Laravel. This secondary
|
||||
codebase is located in a separate git repository at [`directus/php`](#). :::
|
||||
|
||||
## Feature Requests
|
||||
|
||||
Feature requests are a great way to let our team know what should be prioritized next. You can [submit a feature request](https://github.com/directus/directus/discussions/category_choices) or upvote [existing submissions](https://github.com/directus/directus/discussions) all via our GitHub Discussions board.
|
||||
Feature requests are a great way to let our team know what should be prioritized next. You can
|
||||
[submit a feature request](https://github.com/directus/directus/discussions/category_choices) or
|
||||
upvote [existing submissions](https://github.com/directus/directus/discussions) all via our GitHub
|
||||
Discussions board.
|
||||
|
||||
::: warning The 80/20 Rule
|
||||
To keep the Directus codebase as clean and simple as possible, we will only consider approving features that we feel at least 80% of our user-base will find valuable. If your feature request falls within the 20% range, it is considered an edge-case and should be implemented as an extension.
|
||||
:::
|
||||
::: warning The 80/20 Rule To keep the Directus codebase as clean and simple as possible, we will
|
||||
only consider approving features that we feel at least 80% of our user-base will find valuable. If
|
||||
your feature request falls within the 20% range, it is considered an edge-case and should be
|
||||
implemented as an extension. :::
|
||||
|
||||
## RFCs
|
||||
|
||||
Some Directus features/fixes may require additional design, strategy, and/or discussion before beginning work. For these notable pull-requests, you should first submit an RFC (Request For Comments) to our core team via [Discord](https://directus.chat). This process is relatively informal, but ensures proper alignment, and helps avoid squandered development time by contributors.
|
||||
Some Directus features/fixes may require additional design, strategy, and/or discussion before
|
||||
beginning work. For these notable pull-requests, you should first submit an RFC (Request For
|
||||
Comments) to our core team via [Discord](https://directus.chat). This process is relatively
|
||||
informal, but ensures proper alignment, and helps avoid squandered development time by contributors.
|
||||
|
||||
## Bug Reporting
|
||||
|
||||
Reporting any bugs you come across is an invaluable part of helping keep Directus stable. After confirming a similar issue doesn't already exist, you can [submit a bug report](https://github.com/directus/directus/issues/new) via GitHub Issues. Please ensure the following for all submissions:
|
||||
Reporting any bugs you come across is an invaluable part of helping keep Directus stable. After
|
||||
confirming a similar issue doesn't already exist, you can
|
||||
[submit a bug report](https://github.com/directus/directus/issues/new) via GitHub Issues. Please
|
||||
ensure the following for all submissions:
|
||||
|
||||
- You are experiencing an actual bug, not a configuration issue
|
||||
- You are not asking a question or requesting a new feature
|
||||
@@ -41,20 +57,30 @@ Reporting any bugs you come across is an invaluable part of helping keep Directu
|
||||
|
||||
## Reporting Security Vulnerabilities
|
||||
|
||||
If you believe you have discovered a security issue within a Directus product or service, please reach out to us directly over email: [support@directus.io](mailto:support@directus.io). We will then open a [GitHub Security Advisory](https://github.com/directus/directus/security/advisories) for tracking the fix.
|
||||
If you believe you have discovered a security issue within a Directus product or service, please
|
||||
reach out to us directly over email: [support@directus.io](mailto:support@directus.io). We will then
|
||||
open a [GitHub Security Advisory](https://github.com/directus/directus/security/advisories) for
|
||||
tracking the fix.
|
||||
|
||||
We value the members of the independent security research community who find security vulnerabilities and work with our team so that proper fixes can be issued to users. Our policy is to credit all researchers in the fix's release notes. In order to receive credit, security researchers must follow responsible disclosure practices, including:
|
||||
We value the members of the independent security research community who find security
|
||||
vulnerabilities and work with our team so that proper fixes can be issued to users. Our policy is to
|
||||
credit all researchers in the fix's release notes. In order to receive credit, security researchers
|
||||
must follow responsible disclosure practices, including:
|
||||
|
||||
- They do not publish the vulnerability prior to the Directus team releasing a fix for it
|
||||
- They do not divulge exact details of the issue, for example, through exploits or proof-of-concepts
|
||||
- They do not divulge exact details of the issue, for example, through exploits or
|
||||
proof-of-concepts
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
The Directus [Code of Conduct](https://github.com/directus/directus/blob/main/code_of_conduct.md) is one of the ways we put our values into practice. We expect all of our staff, contractors and contributors to know and follow this code.
|
||||
The Directus [Code of Conduct](https://github.com/directus/directus/blob/main/code_of_conduct.md) is
|
||||
one of the ways we put our values into practice. We expect all of our staff, contractors and
|
||||
contributors to know and follow this code.
|
||||
|
||||
## Development Workflow
|
||||
|
||||
Before getting started, ensure you your local environment meets our [minimum requirements](/guides/installation/cli) and you are familiar with Git.
|
||||
Before getting started, ensure you your local environment meets our
|
||||
[minimum requirements](/guides/installation/cli) and you are familiar with Git.
|
||||
|
||||
### 1. Fork the Directus repository
|
||||
|
||||
@@ -80,7 +106,9 @@ npm install
|
||||
|
||||
### 5. Setup the Database & Env File
|
||||
|
||||
For this step, you'll need to already have a SQL database up-and-running, otherwise you can only use the SQLite driver, which will create the database for you. Run the following command from within root of the project:
|
||||
For this step, you'll need to already have a SQL database up-and-running, otherwise you can only use
|
||||
the SQLite driver, which will create the database for you. Run the following command from within
|
||||
root of the project:
|
||||
|
||||
```bash
|
||||
npm run cli -- init
|
||||
@@ -96,7 +124,8 @@ npm run dev
|
||||
|
||||
### 7. Make your fixes/changes
|
||||
|
||||
At this point you are ready to start working on Directus! Before diving in however, it's worth reading through our docs on [submitting a pull-request](#Submitting-a-Pull-Request).
|
||||
At this point you are ready to start working on Directus! Before diving in however, it's worth
|
||||
reading through our docs on [submitting a pull-request](#Submitting-a-Pull-Request).
|
||||
|
||||
## Submitting a Pull-Request
|
||||
|
||||
@@ -106,7 +135,8 @@ Please read our docs on the [RFC process](#rfcs).
|
||||
|
||||
### 2. Update relevant docs
|
||||
|
||||
Before submitting any pull-requests, ensure that any relevant documentation (included in this same repo) is updated.
|
||||
Before submitting any pull-requests, ensure that any relevant documentation (included in this same
|
||||
repo) is updated.
|
||||
|
||||
### 3. Push your changes
|
||||
|
||||
@@ -116,9 +146,12 @@ git push -u origin YOUR-BRANCH-NAME
|
||||
|
||||
### Submit a pull-request
|
||||
|
||||
Once you push the changes to your repo, the "Compare & pull request" button will appear in GitHub. Click it and you'll be taken to a screen where you can fill in the appropriate details. Finally, open the pull request by clicking the "Create pull request" button.
|
||||
Once you push the changes to your repo, the "Compare & pull request" button will appear in GitHub.
|
||||
Click it and you'll be taken to a screen where you can fill in the appropriate details. Finally,
|
||||
open the pull request by clicking the "Create pull request" button.
|
||||
|
||||
Now our core staff will review your contribution and either merge it, or request that you to make changes.
|
||||
Now our core staff will review your contribution and either merge it, or request that you to make
|
||||
changes.
|
||||
|
||||
## Codebase Overview
|
||||
|
||||
|
||||
@@ -1,26 +1,27 @@
|
||||
# Installation
|
||||
|
||||
Directus can be installed in many different ways, on several different stacks. CLI is the recommended method, but there are many ways to get started with our platform depending on your needs.
|
||||
Directus can be installed in many different ways, on several different stacks. CLI is the
|
||||
recommended method, but there are many ways to get started with our platform depending on your
|
||||
needs.
|
||||
|
||||
* [Command Line Interface (CLI)](/guides/installation/cli.md)
|
||||
* [Docker](/guides/installation/docker.md)
|
||||
* [Manually](/guides/installation/manual.md)
|
||||
- [Command Line Interface (CLI)](/guides/installation/cli.md)
|
||||
- [Docker](/guides/installation/docker.md)
|
||||
- [Manually](/guides/installation/manual.md)
|
||||
|
||||
::: tip Development Environment
|
||||
Developers looking to work on the project's source code should follow our [Contributing Guide](/getting-started/contributing).
|
||||
:::
|
||||
::: tip Development Environment Developers looking to work on the project's source code should
|
||||
follow our [Contributing Guide](/getting-started/contributing). :::
|
||||
|
||||
## Deployment Guides
|
||||
|
||||
* [Amazon AWS](#)
|
||||
* [DigitalOcean Droplet](#)
|
||||
* [DigitalOcean One-Click](/guides/installation/digitalocean-one-click.md)
|
||||
* [Google App Engine](#)
|
||||
* [Heroku](/guides/installation/heroku.md)
|
||||
* [Microsoft Azure](#)
|
||||
- [Amazon AWS](#)
|
||||
- [DigitalOcean Droplet](#)
|
||||
- [DigitalOcean One-Click](/guides/installation/digitalocean-one-click.md)
|
||||
- [Google App Engine](#)
|
||||
- [Heroku](/guides/installation/heroku.md)
|
||||
- [Microsoft Azure](#)
|
||||
|
||||
## Optional Setup Guides
|
||||
|
||||
* [Caddy](#)
|
||||
* [Nginx](#)
|
||||
* [HAProxy](#)
|
||||
- [Caddy](#)
|
||||
- [Nginx](#)
|
||||
- [HAProxy](#)
|
||||
|
||||
@@ -1,56 +1,81 @@
|
||||
# 🐰 Welcome to the Directus Docs!
|
||||
|
||||
> These Docs will help get you up-and-running quickly, guide you through advanced features, and explain the concepts that make Directus so unique.
|
||||
> These Docs will help get you up-and-running quickly, guide you through advanced features, and
|
||||
> explain the concepts that make Directus so unique.
|
||||
|
||||
## What is Directus?
|
||||
|
||||
**Directus is an open-source platform that provides a real-time API and intuitive Admin App for your custom database.** Built on node.js and vue.js 3, it allows both administrators and non-technical users to view and manage the content/data stored within pure SQL databases. It can be used as a headless CMS for managing project content, a database client for modeling and viewing raw data, or as a standalone customizable WebApp.
|
||||
**Directus is an open-source platform that provides a real-time API and intuitive Admin App for your
|
||||
custom database.** Built on node.js and vue.js 3, it allows both administrators and non-technical
|
||||
users to view and manage the content/data stored within pure SQL databases. It can be used as a
|
||||
headless CMS for managing project content, a database client for modeling and viewing raw data, or
|
||||
as a standalone customizable WebApp.
|
||||
|
||||
::: details What's in a name?
|
||||
Directus ([duh REKT iss](http://audio.pronouncekiwi.com/Salli/Directus)) is latin for: _laid straight, arranged in lines_. The broadest goal of Directus is to present data in a simple, orderly, and intuitive way.
|
||||
:::
|
||||
::: details What's in a name? Directus
|
||||
([duh REKT iss](http://audio.pronouncekiwi.com/Salli/Directus)) is latin for: _laid straight,
|
||||
arranged in lines_. The broadest goal of Directus is to present data in a simple, orderly, and
|
||||
intuitive way. :::
|
||||
|
||||
## What makes it unique?
|
||||
|
||||
**Directus dynamically generates custom API endpoints based on your SQL database's custom schema in real-time — something we call "Database Mirroring".** Whether you install fresh or on top of an existing database, you always maintain complete control over your actual database... including tables, columns, datatypes, default values, indexes, relationships, etc.
|
||||
**Directus dynamically generates custom API endpoints based on your SQL database's custom schema in
|
||||
real-time — something we call "Database Mirroring".** Whether you install fresh or on top of an
|
||||
existing database, you always maintain complete control over your actual database... including
|
||||
tables, columns, datatypes, default values, indexes, relationships, etc.
|
||||
|
||||
Perhaps one of the biggest advantages of _Database Mirroring_ is that you have direct access to your pure and unaltered data. That means you can even bypass the Directus middleware (API, SDK, App), and connect to your data with proper SQL queries — effectively removing all bottlenecks, additional latency, or proprietary access limitations.
|
||||
Perhaps one of the biggest advantages of _Database Mirroring_ is that you have direct access to your
|
||||
pure and unaltered data. That means you can even bypass the Directus middleware (API, SDK, App), and
|
||||
connect to your data with proper SQL queries — effectively removing all bottlenecks, additional
|
||||
latency, or proprietary access limitations.
|
||||
|
||||
Directus is a simple solution for complex problems. Every aspect of Directus is data-first and guided by the following core principles:
|
||||
Directus is a simple solution for complex problems. Every aspect of Directus is data-first and
|
||||
guided by the following core principles:
|
||||
|
||||
* **Pure** — There is no predefined model or proprietary rules for your agnostic schema, and all system settings are stored separately.
|
||||
* **Open** — Our entire codebase is public and transparent, allowing for end-to-end audits. Nothing is obfuscated or black-boxed.
|
||||
* **Portable** — Data is stored in your bespoke database and can be migrated/exported/backed-up at any time. Absolutely no vendor lock-in.
|
||||
* **Limitless** — Create unlimited users, roles, languages, collections, and items. No arbitrary restrictions or paywall limitations.
|
||||
* **Extensible** — Every aspect of the platform is modular, allowing you to adapt, customize, and infinitely extend the Core engine.
|
||||
* **Unopinionated** — Choose your stack (node or PHP), database (all SQL vendors), API (REST or GraphQL), and infra (self-hosted or Cloud).
|
||||
- **Pure** — There is no predefined model or proprietary rules for your agnostic schema, and all
|
||||
system settings are stored separately.
|
||||
- **Open** — Our entire codebase is public and transparent, allowing for end-to-end audits.
|
||||
Nothing is obfuscated or black-boxed.
|
||||
- **Portable** — Data is stored in your bespoke database and can be migrated/exported/backed-up at
|
||||
any time. Absolutely no vendor lock-in.
|
||||
- **Limitless** — Create unlimited users, roles, languages, collections, and items. No arbitrary
|
||||
restrictions or paywall limitations.
|
||||
- **Extensible** — Every aspect of the platform is modular, allowing you to adapt, customize, and
|
||||
infinitely extend the Core engine.
|
||||
- **Unopinionated** — Choose your stack (node or PHP), database (all SQL vendors), API (REST or
|
||||
GraphQL), and infra (self-hosted or Cloud).
|
||||
|
||||
## The Directus Ecosystem
|
||||
|
||||
### Open-Source Engine
|
||||
|
||||
Completely free and open-source on the GPLv3 license, Directus is publically available within our [npm package](https://www.npmjs.com/package/directus) and main [GitHub repository](https://github.com/directus/directus). It includes our dynamic API engine (node.js), the intuitive Admin App (vue.js 3), this documentation (markdown), and all dependencies.
|
||||
Completely free and open-source on the GPLv3 license, Directus is publically available within our
|
||||
[npm package](https://www.npmjs.com/package/directus) and main
|
||||
[GitHub repository](https://github.com/directus/directus). It includes our dynamic API engine
|
||||
(node.js), the intuitive Admin App (vue.js 3), this documentation (markdown), and all dependencies.
|
||||
|
||||
### On-Demand Cloud
|
||||
|
||||
Our self-service platform for quick and affordable instances of Directus on a multitenant infrastructure.
|
||||
Our self-service platform for quick and affordable instances of Directus on a multitenant
|
||||
infrastructure.
|
||||
|
||||
### Enterprise Cloud
|
||||
|
||||
Dedicated hardware, custom limits, full white-labeling, uptime SLAs, and more are available on this premium managed solution.
|
||||
Dedicated hardware, custom limits, full white-labeling, uptime SLAs, and more are available on this
|
||||
premium managed solution.
|
||||
|
||||
### Documentation
|
||||
|
||||
[Our online documentation](https://docs.directus.io) describes the most version of our platform. They are written in publicly managed markdown files so the community can help keep them clean and up-to-date!
|
||||
[Our online documentation](https://docs.directus.io) describes the most version of our platform.
|
||||
They are written in publicly managed markdown files so the community can help keep them clean and
|
||||
up-to-date!
|
||||
|
||||
* Getting Started: Novice Oriented. For a platform intro and installation.
|
||||
* Concepts: Learning Oriented. For understanding the platfom.
|
||||
* Guides: Problem Oriented. Follow along with steps while working.
|
||||
* Reference: Information Oriented. Look up info and specs while working.
|
||||
- Getting Started: Novice Oriented. For a platform intro and installation.
|
||||
- Concepts: Learning Oriented. For understanding the platfom.
|
||||
- Guides: Problem Oriented. Follow along with steps while working.
|
||||
- Reference: Information Oriented. Look up info and specs while working.
|
||||
|
||||
::: tip Versioned Docs
|
||||
Docs for specific versions of Directus 9+ are available within the individual Project's App Documentation module.
|
||||
:::
|
||||
::: tip Versioned Docs Docs for specific versions of Directus 9+ are available within the individual
|
||||
Project's App Documentation module. :::
|
||||
|
||||
<!-- ### Online Demo
|
||||
|
||||
@@ -64,20 +89,27 @@ The [Status Page](https://status.directus.io) provides up-to-date information on
|
||||
|
||||
### Marketing Website
|
||||
|
||||
Our [marketing site](https://directus.io) provides general information, resources, and team info for the project.
|
||||
Our [marketing site](https://directus.io) provides general information, resources, and team info for
|
||||
the project.
|
||||
|
||||
### Social
|
||||
|
||||
For the latest product info and sneak-peeks into upcoming releases, be sure to follow us on [Twitter](https://twitter.com/directus).
|
||||
For the latest product info and sneak-peeks into upcoming releases, be sure to follow us on
|
||||
[Twitter](https://twitter.com/directus).
|
||||
|
||||
### Community
|
||||
|
||||
Join our growing community of 2,600+ developers on [Discord](https://directus.chat). From community support to seeing where the platform is heading next, it's a great way to get more involved.
|
||||
Join our growing community of 2,600+ developers on [Discord](https://directus.chat). From community
|
||||
support to seeing where the platform is heading next, it's a great way to get more involved.
|
||||
|
||||
### Languages
|
||||
|
||||
In addition to managing multilingual content, the Directus Admin App itself can also be translated into different languages. Our languages are managed through the [Directus CrowdIn](https://locales.directus.io/), which provides a friendly interface and automatically submits pull-requests to the git repository.
|
||||
In addition to managing multilingual content, the Directus Admin App itself can also be translated
|
||||
into different languages. Our languages are managed through the
|
||||
[Directus CrowdIn](https://locales.directus.io/), which provides a friendly interface and
|
||||
automatically submits pull-requests to the git repository.
|
||||
|
||||
### Marketplace
|
||||
|
||||
Coming soon. A library of free and paid Directus extensions created by our core team and community members.
|
||||
Coming soon. A library of free and paid Directus extensions created by our core team and community
|
||||
members.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
# Quickstart
|
||||
|
||||
> If you're looking for the fastest way to get up-and-running with Directus, this guide will walk you through getting things installed, configured, and modeled.
|
||||
> If you're looking for the fastest way to get up-and-running with Directus, this guide will walk
|
||||
> you through getting things installed, configured, and modeled.
|
||||
|
||||
@TODO — Create embedded video overview
|
||||
|
||||
|
||||
@@ -1,51 +1,78 @@
|
||||
# Technical Support
|
||||
|
||||
> Directus is offered completely free and open-source for anyone wishing to self-host the platform. There are many resources, both free and paid, to help you get up-and-running smoothly.
|
||||
> Directus is offered completely free and open-source for anyone wishing to self-host the platform.
|
||||
> There are many resources, both free and paid, to help you get up-and-running smoothly.
|
||||
|
||||
## Community Support
|
||||
|
||||
[Github Discussions](https://github.com/directus/directus/discussions) is great first place to reach out for help. Our community and core developers often check this platform and answer posts. It has the added benefit of being an archival resource for others developers with similar questions.
|
||||
[Github Discussions](https://github.com/directus/directus/discussions) is great first place to reach
|
||||
out for help. Our community and core developers often check this platform and answer posts. It has
|
||||
the added benefit of being an archival resource for others developers with similar questions.
|
||||
|
||||
Our [Discord](https://directus.chat) community is another great way to get assisstance. Please keep all questions on the `#help` channel, be considerate, and remember that you are getting free help for a free product.
|
||||
Our [Discord](https://directus.chat) community is another great way to get assisstance. Please keep
|
||||
all questions on the `#help` channel, be considerate, and remember that you are getting free help
|
||||
for a free product.
|
||||
|
||||
## Premium Support
|
||||
|
||||
Premium support is included with our Enterprise Cloud service. On-Demand Cloud customers and On-Premise users interested in learning more about our monthly retainer agreements should contact us at [support@directus.io](mailto:support@directus.io).
|
||||
Premium support is included with our Enterprise Cloud service. On-Demand Cloud customers and
|
||||
On-Premise users interested in learning more about our monthly retainer agreements should contact us
|
||||
at [support@directus.io](mailto:support@directus.io).
|
||||
|
||||
## Sponsored Work
|
||||
|
||||
### Commissioned Features
|
||||
|
||||
If you need a specific feature added to Directus faster than the normal development timeline, [reach out to us](https://directus.io/contact/) for a quote. Our parent agency will often help subsidize the cost of developing new features if they pass our [80/20 Rule](/getting-started/contributing) and can be merged into the core codebase. Other custom/proprietary development will be built bespoke within our robust extension system.
|
||||
If you need a specific feature added to Directus faster than the normal development timeline,
|
||||
[reach out to us](https://directus.io/contact/) for a quote. Our parent agency will often help
|
||||
subsidize the cost of developing new features if they pass our
|
||||
[80/20 Rule](/getting-started/contributing) and can be merged into the core codebase. Other
|
||||
custom/proprietary development will be built bespoke within our robust extension system.
|
||||
|
||||
### Expedited Fixes
|
||||
|
||||
We triage all reported bugs based on priority and how long the fix is estimated to take. If you need a specific issue resolved sooner, [reach out to us](#) for a quote.
|
||||
We triage all reported bugs based on priority and how long the fix is estimated to take. If you need
|
||||
a specific issue resolved sooner, [reach out to us](#) for a quote.
|
||||
|
||||
## Frequently Asked Questions
|
||||
|
||||
### Does Directus handle deploying or migrating projects?
|
||||
|
||||
Directus includes [export](#) and [backup](#) tools to assist in deploying data changes between environments (eg: from _development_ to _production_), however there is no formal migration workflow.
|
||||
Directus includes [export](#) and [backup](#) tools to assist in deploying data changes between
|
||||
environments (eg: from _development_ to _production_), however there is no formal migration
|
||||
workflow.
|
||||
|
||||
Additionally, since Directus stores all of your data in pure SQL, you can use almost any preexisting workflow or toolkit for this process.
|
||||
Additionally, since Directus stores all of your data in pure SQL, you can use almost any preexisting
|
||||
workflow or toolkit for this process.
|
||||
|
||||
### Does Directus support Mongo/NoSQL?
|
||||
|
||||
Not currently. Directus has been built specifically for wrapping _relational_ databases. While we could force Mongo to use tables, columns, and rows via Mongoose object modeling, that approach to non-structured doesn't make a lot of sense. We realize many users are interested in this feature, and will continue to explore its possibility.
|
||||
Not currently. Directus has been built specifically for wrapping _relational_ databases. While we
|
||||
could force Mongo to use tables, columns, and rows via Mongoose object modeling, that approach to
|
||||
non-structured doesn't make a lot of sense. We realize many users are interested in this feature,
|
||||
and will continue to explore its possibility.
|
||||
|
||||
### Why haven't you added this feature, or fixed that issue yet?
|
||||
|
||||
Directus is primarily a free and open-source project, maintained by a small core team and community contributors who donate their time and resources.
|
||||
Directus is primarily a free and open-source project, maintained by a small core team and community
|
||||
contributors who donate their time and resources.
|
||||
|
||||
Our platform is feature-rich, however we strictly adhere to our [80/20 Rule](/getting-started/contributing) to avoid a messy/bloated codebase. Directus is also quite stable, however new issues still arise, some of which may be triaged with a lower prioritization.
|
||||
Our platform is feature-rich, however we strictly adhere to our
|
||||
[80/20 Rule](/getting-started/contributing) to avoid a messy/bloated codebase. Directus is also
|
||||
quite stable, however new issues still arise, some of which may be triaged with a lower
|
||||
prioritization.
|
||||
|
||||
If you require more expeditious updates, you can contact us regarding [sponsoring expedited fixes](#) or [commissioning new features](#). You can also [submit a pull request](#) — after all, it is open-source!
|
||||
If you require more expeditious updates, you can contact us regarding
|
||||
[sponsoring expedited fixes](#) or [commissioning new features](#). You can also
|
||||
[submit a pull request](#) — after all, it is open-source!
|
||||
|
||||
### Can you give an ETA for this feature/fix?
|
||||
|
||||
If it is [sponsored work](#), then yes, delivery dates are part of our statement of work agreements. Otherwise, most likely not. This is open-source software, work is prioritized internally, and all timelines are subject to change.
|
||||
If it is [sponsored work](#), then yes, delivery dates are part of our statement of work agreements.
|
||||
Otherwise, most likely not. This is open-source software, work is prioritized internally, and all
|
||||
timelines are subject to change.
|
||||
|
||||
### But this is an emergency, my very important project requires it now!
|
||||
|
||||
We understand, and are here to help. If you need something prioritized, you can reach out to us to discuss [premium support](#), [sponsoring expedited fixes](#) or [commissioning new features](#).
|
||||
We understand, and are here to help. If you need something prioritized, you can reach out to us to
|
||||
discuss [premium support](#), [sponsoring expedited fixes](#) or [commissioning new features](#).
|
||||
|
||||
Reference in New Issue
Block a user