mirror of
https://github.com/directus/directus.git
synced 2026-04-25 03:00:53 -04:00
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>
101 lines
5.0 KiB
Markdown
101 lines
5.0 KiB
Markdown
---
|
||
description: How to get support for your Directus project.
|
||
readTime: 4 min read
|
||
---
|
||
|
||
# Help & Support
|
||
|
||
> If you have questions while working with Directus, there are many resources to help you get up-and-running smoothly.
|
||
|
||
## Troubleshooting Steps
|
||
|
||
If you're experiencing issues or think you have found a problem in Directus, be sure to follow these steps before
|
||
[Reporting a Bug](/contributing/introduction#bug-reporting):
|
||
|
||
1. Ensure your server and database meet the [minimum requirements](/self-hosted/docker-guide#supported-databases).
|
||
2. Ensure you’re on the [latest version](https://github.com/directus/directus/releases/latest) of Directus.
|
||
3. Stop `CTRL+C` and restart the server `npx directus start`.
|
||
4. Run the database migration script: `directus database migrate:latest`\
|
||
_Note: backup your database first._
|
||
5. Disable any data-caching within your project.
|
||
6. Test any app issues with both browser extensions and caching disabled _(i.e. Incognito Mode)_.
|
||
7. Confirm the issue is not related to your own custom code.
|
||
8. Check for [existing Issues](https://github.com/directus/directus/issues?q=is%3Aissue) (and
|
||
[Discussions](https://github.com/directus/directus/discussions)) that match your problem.
|
||
|
||
If you're still experiencing a problem after completing the above steps, you can chat through things on our
|
||
[community support](#community-support) or [report a bug](/contributing/introduction#bug-reporting).
|
||
|
||
## Support Tiers
|
||
|
||
### Community Support
|
||
|
||
[GitHub Discussions](https://github.com/directus/directus/discussions) is a 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 Community](https://directus.chat) is another great way to get assistance. Please keep all questions in the
|
||
help channels, be considerate, and remember that you are getting free help from the community.
|
||
|
||
::: warning No Guaranteed Response Time
|
||
|
||
While the Directus Core Team plays an active and engaged role in community discussions, 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.
|
||
|
||
Cloud customers and Self-Hosted 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 (supports 80% of our user's common use cases) 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](https://directus.io/contact) for a quote.
|
||
|
||
## Frequently Asked Questions
|
||
|
||
### 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 of "faking" a relational structure in a
|
||
non-structured environment like Mongo doesn't make a lot of sense. We do 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 an open-source project, maintained by a small core team and community contributors who have limited time and
|
||
resources.
|
||
|
||
Our platform is feature-rich, however we strictly adhere to our
|
||
[80/20 Rule](/contributing/introduction#feature-requests) 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 need, you can contact us about [sponsoring expedited fixes](#expedited-fixes) or
|
||
[commissioning new features](#commissioned-features). You can also
|
||
[submit a pull request](https://github.com/directus/directus/pulls) — 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.
|
||
|
||
### 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](#basic-and-premium-support), [sponsoring expedited fixes](#expedited-fixes) or
|
||
[commissioning new features](#commissioned-features).
|