0c54f5a9ef
* items semi complete
* updated items page to use snippet toggler and migrated endpoint docs to use it
* updated files page to use snippet toggler and migrated REST and GraphQL endpoint docs to it
* updated activity page to use snippet toggler and migrated REST and GraphQL endpoint doc to it
* updated collections page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* updated dashboards page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated extensions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated fields page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated flows page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated folders page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated notifications page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated operations page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated panels page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated permissions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated presets page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated relations page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated revisions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated roles page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Made headlines consistant with the rest of the doc pages
* Updated server page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated settings page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated shares page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated translations page to use snippet togglers and migrated REST endpoint docs to them
* Updated users page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated utilities page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated webhooks page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated authentication page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated Global Parameters page to use snippet togglers where there are adjacent REST and GraphQL Examples
* Added SDK code snippets to items page and made generic variables consistant
* Added SDK code snippets to files page and made generic variables consistant
* Few lang changes for files page
* Added SDK code snippets to activity page and made generic variables consistant
* Added SDK code snippets to collections page and made generic variables consistant
* Added SDK code snippets to dashboards page and made generic variables consistant
* removed query word from query parameter objects
* Added SDK code snippets to fields page and made generic variables consistant
* SnippetToggler border
* Used dynamic border color for snippettoggler heading
* Spacing top and bottom of snippet toggler in docs
* Removed extra HRs
* Remove manual TOC in query reference
* Small code styling change in items page
* Updated users page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* dashboards fixed up property names
* Small copy update on extensions page
* Updated keys in delete mult notifications REST
* Updated keys in operations
* Update keys in panel delete many
* Update keys in permissions
* Added quotes around generic example ID strings
* Added code formatting to final example in share public info
* Format files
* Refined sidebar
* Insert newline before ending template tags
* Fixed extra closing tags, causing an error, un users ref
* Text Formatting Users
* Put GQL related notes inside toggler
* Added SDK code snippets to flows page and made generic variables consistant
* Added SDK code snippets to folder page and made generic variables consistant
* fixing whitepsace for flows and folders page
* Consistent newlines in SnippetToggler usages
* Run prettier
* Fix 'alwaysDark' definition
* Home page snippet toggler style fixes
* Fix snippet toggler lang hover color in light mode
* Introduce different code theme for light mode
* Added SDK code snippets to notifications page and made generic variables consistant
* Switch to 'material-theme-lighter'
* Format file
* Fix tip
* Fix tip in sdk ref
* Consistent spacing for custom containers
* Added SDK code snippets to operations page and made generic variables consistant
* Lint & format code blocks
* Lint & format operations
* Added SDK code snippets to panels page and made generic variables consistant
* Added SDK code snippets to permissions page and made generic variables consistant
* Added SDK code snippets to presets page and made generic variables consistant
* Added SDK code snippets to relations page and made generic variables consistant
* Added SDK code snippets to revisions page and made generic variables consistant
* Added SDK code snippets to roles page and made generic variables consistant
* Added SDK code snippets to server page and made generic variables consistant
* Added SDK code snippets to settings page and made generic variables consistant
* app_url -> directus_project_url
* Omitted auth details in delete multiple files
* Added quotes to values in roles
* Upload a file snippets
* Pluralization for upload/import files
* More files functions typos
* Added SDK code snippets to shares page (still missing createShare(s) as endpoint not functioning currently) and made generic variables consistant
* Added SDK code snippets to translations page (missing delete endponts because not working) and made generic variables consistant
* Added SDK code snippets to users page and made generic variables consistant
* Added SDK code snippets to webhooks page and made generic variables consistant
* Added SDK code snippets to utilites page (except cleaning cache, will be tested and added in later commit) and made generic variables consistant
* Added SDK code snippets to auth page (not login, refresh, and logout though due to errors)
* Added SDK code snippets for utilsExport and clearCache
* added github username be7DOTis to contributors
* Omit auth commands in updateComment
* utilsImport
* rename app_url generic value
* changed instances of updated*operation* to update*Operation*
* missed some 'updated' changse
* Added SDK Snippets to Query Parameters page
* Add section on file security
* added create(s)Shares SDK snippet to shares page
* added console.log to create snippets
* Added delete(s)Webhook SDK snippet to webhooks page
* Added SDK snippets to extensions page
* Added create/updateSingleton section to items page
* Links in files security
* Added SDK Snippets to Schema page
* Added GQL Generic examples to snippet togglers and removed snippet toggler from Login Using SSO Providers
* Added create(s)Presets SDK Snippets to presets page
* replaced fields query in generics snippets for a more generic
* replaced fields query in generics snippets for a more generic
* Use storage value only if valid choice
* Sync snippet togglers across page
* Update docs/reference/system/activity.md
* Update docs/reference/system/activity.md
* Update docs/reference/system/extensions.md
* Update docs/reference/system/revisions.md
* Update docs/reference/system/settings.md
* Update docs/reference/system/revisions.md
* Update docs/reference/system/settings.md
* Update docs/reference/system/activity.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/schema.md
* Update docs/reference/system/server.md
* Update docs/reference/system/shares.md
* Replace all directus_project_url placeholders
* Revert "Sync snippet togglers across page"
This reverts commit 8b36f0d778.
* Update docs/reference/system/shares.md
* Update docs/reference/system/webhooks.md
* Clarify singleton section
* Consistent newlines between SnippetToggler templates
* Format files
* Remove console.log(result) statements from snippet
* Add examples for shares & users
Co-authored-by: Brainslug <tim@brainslug.nl>
* Fix hash GraphQL example
* Clarify update singleton section
* Add auth examples
Co-authored-by: Brainslug <tim@brainslug.nl>
* Final run on consistent newlines between SnippetToggler
* Switch to github themes
* The "Last One"
Co-authored-by: Brainslug <tim@brainslug.nl>
* The "Big One"
* Fix dead links
---------
Co-authored-by: Bevis Halsey-Perry <hi@be7.is>
Co-authored-by: Kevin Lewis <kvn@lws.io>
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Brainslug <br41nslug@users.noreply.github.com>
Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
Co-authored-by: Brainslug <tim@brainslug.nl>
9.0 KiB
description, readTime
| description | readTime |
|---|---|
| A glossary of terms specific to Directus Cloud. | 10 min read |
Glossary
Asset Storage
Directus Core allows asset storage for any type of file. This applies to all Cloud Projects. However, on Directus Cloud, certain hard technical limits apply to file uploads, such as limits on size per asset and total asset storage per Project. For more details, see Cloud Policies.
Automatic Updates
Software updates on any app can be a time-consuming chore, taking developer energy and focus away from core business logic. Cloud Projects are updated every two weeks in rolling releases (i.e. done with no downtime). These updates keep your Project on the latest version and fully up to date with all Cloud Exclusives, dependencies and security patches.
::: tip Version-locking
Version-locking is available on Enterprise Projects.
:::
Backups
By default, file assets and databases are backed up once per day on all Standard and Enterprise Projects. Additionally, Enterprise customers can work with our team for more tailored backup solutions. In the event of an emergency, such as your project crashing, don't worry! Your data will be safe. If you need access to your backed-up data, contact us.
Caching
Caching is enabled on Cloud Projects. Public data is cached in the CDN for a short period of time. All Directus Cloud Projects are running behind a Global CDN, but Enterprise Projects offer advanced caching strategies, as well.
Data Portability
Directus Core is totally detached from the database. Data can be cleanly imported and exported on Projects with the API via the schema endpoints.
::: tip Enterprise Clients
The Directus Team will help you work through this process on all Enterprise Projects.
:::
Datacenter Regions
The location you choose to host your Project in can have a measurable impact. To help optimize your Project and meet any local data compliance laws such as GDPR, Standard and Enterprise offer multiple Datacenter regions to host from. There are 19 regions available for Enterprise Projects, and 3 for Standard Projects:
| Region | Enterprise | Standard |
|---|---|---|
| United States, East | ✅ | ✅ |
| Europe, Frankfurt | ✅ | ✅ |
| Asia Pacific, Singapore | ✅ | ✅ |
| United States, West | ✅ | |
| Africa, Cape Town | ✅ | |
| Asia Pacific, Hong Kong | ✅ | |
| Asia Pacific, Jakarta | ✅ | |
| Asia Pacific, Mumbai | ✅ | |
| Asia Pacific, Osaka | ✅ | |
| Asia Pacific, Seoul | ✅ | |
| Asia Pacific, Sydney | ✅ | |
| Asia Pacific, Tokyo | ✅ | |
| Canada, Central | ✅ | |
| Europe, Ireland | ✅ | |
| Europe, London | ✅ | |
| Europe, Paris | ✅ | |
| Europe, Stockholm | ✅ | |
| Middle East, Bahrain | ✅ | |
| South America, São Paulo | ✅ |
Encryption and Security
Asset Storage, data storage and in-transit encryption are included on all Cloud Projects. All data at rest remains encrypted, and HTTPS/TLS protocols are enabled on all in-transit data. Cloud Projects are created with secure and safe tenancy architectures.
::: tip Directus Core Security Features
Directus core comes with even more security features out-of-the-box, including IP address whitelabeling, MFA enabling, SSO options, customization for Password Rule requirements and the flexibility to use any access token paradigm desired.
:::
Extensions
The term Extension refers to any feature or component that adds to the functionality of Directus Core. Directus has been architected to be completely modular and extensible to ensure you will never hit a hard feature ceiling within the platform.
Enterprise Projects have the option to implement their own custom Extensions as needed.
Global CDN
A Global CDN is provided for all Cloud Projects, out-of-the-box, with over 300 cache locations. This means assets and data will be delivered with the lowest possible latency.
Infrastructure
In the context of these docs, Infrastructure refers to the hardware running your Project, including the database, asset storage and global CDN. Infrastructure differs by Project tier. Please refer to Projects as well as the Infrastructure section on the Pricing page for side-by-side comparisons.
Rate Limiting
Rate limiting refers to technical limitations within Directus Cloud as well as Cloud Projects. You will encounter the following API request limits:
| Tier | Limit |
|---|---|
| Standard | 50 requests per second per IP |
| Enterprise | 100 requests per second per IP |
::: tip Learn More
For details on other limitations, please see Cloud Policies.
:::
Support Options
There are three types of support for Directus:
Community Support
Because Directus is an open-source Project, you're encouraged to reach out to the Community for help on Projects, and of course help others as well. Find us on GitHub and Discord to join the thousands of other developers all discussing and guiding the future of the Directus platform. Most common questions have already been asked and answered and can be easily searched.
::: warning No Guaranteed Response Time
While the Directus Core Team plays an active and engaged role in community discussions and aims to answer questions within a few days, there is no guaranteed response time for Community Support.
:::
Basic and Premium Support
Basic and Premium Support offer direct communication with the Directus Core Team. Basic support is included on all Enterprise Projects, and Premium Support adds 24/7 response times for critical software issues only.
::: tip Add-on Support
Looking for Basic or Premium Support on a self-hosted Project? Contact Sales.
:::
System Status
Click check in the Dashboard Header to navigate to the System Status page. This page is where to find out what happened in the super rare event that the network slows down or goes offline. Here you can view the current connectivity status of Directus Cloud, the status on individual Projects by URL and a daily Incidents log. For more information, see Cloud Policies.
Multi-tenancy
Tenancy refers to how client data is stored within a database. In single-tenancy architecture, a database stores data from only one tenant. In multi-tenancy architecture, a database stores data from multiple tenants, with mechanisms in place to protect data privacy. In the context of Directus Cloud, each Project represents a tenant.
Standard
Standard Projects are created using a multi-tenant architecture. However, if your neighbor's Project gets busy, it will not
impact your Project, because each Standard Project is scoped to one container per Project with dedicated minimum resources.
Projects also have the ability to scale beyond this minimum allocation based on currently available resources within the
multitenant pool. However, these additional resources are not guaranteed and are offered on a dynamic first-come, first-serve
basis. For end-to-end, single-tenant infrastructure with fully dedicated resources, contact us about our Enterprise Tier
Enterprise
Databases on Enterprise Projects are single-tenant, 100% dedicated to your Project - no neighbors! Ready to upgrade to Enterprise?
Contact us
::: tip
This section refers to how your Cloud Project is stored alongside other Cloud Projects and has nothing to do with how you design your Project's data model. You can implement single or multi-tenant architecture within any Directus Cloud Project.
:::