* 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>
8.3 KiB
description, readTime
| description | readTime |
|---|---|
| This is where you can adjust all of the **global** settings for your project. Changes saved here are instantly reflected throughout the platform. | 4 min read |
Project Settings
This is where you can adjust all of the global settings for your project, such as project name, default language, custom CSS, password policies, and more! Changes saved here are instantly reflected throughout your project.
::: tip Learn More
To manage your project settings programmatically, see our API documentation on settings.
:::
Configure Project Settings
To configure Project Settings, follow these steps.
- Navigate to Settings > Project Settings.
- Configure settings as desired.
- Click check to confirm.
All configuration options are described in detail below.
General
- Project Name — Sets the name on the Navigation Bar, as well as login and public pages.
- Project Descriptor — Sets the descriptor shown below the Project Name.
- Project URL — Sets URL when clicking the logo at the top of the Module Bar.
- Default Language — Sets the default language used within the app.
Branding & Style
- Project Color — Sets color on the project logo, FavIcon and login/public pages.
- Project Logo — Adds a 40x40px logo at the top of the Module Bar and on the login/public pages. The image is inset within a 64x64px square filled with the project color. We recommend using a PNG file for optimal compatibility.
- Public Foreground — Adds image on the public page's right-pane (max-width 400px).
- Public Background — Adds image displayed behind the public foreground image, shown full-bleed within the public page's right-pane. When a public background image is not set, the project color is used instead.
- Public Note — A helpful note displayed at the bottom of the public page's right-pane, supports markdown for rich-text formatting.
- Custom CSS — Applies custom CSS rules to override the Data Studio's default styling. Be aware that the Data Studio's core code, and therefore its DOM selectors, can change at any time. These updates are not considered a breaking change.
::: tip Browser FavIcon & Title
The Project Color is also used to set a dynamic FavIcon and the Project Name is used in the browser's page title, making it easier to identify different Directus projects.
:::
Modules
- Module Bar — Allows the following customization of links displayed in the
Module Bar.
- Toggle Visibility — Toggle check_box_outline_blank to set module link visibility in the Navigation Bar.
- Manually Sort Modules — Click drag_handle and drag to reorder module links as desired.
- Add Link — To add a new custom link, click Add Link and fill in the details below.
- Name — Sets the title of the module link, also shown in a tooltip on hover.
- Icon — Selects an icon for the module button.
- URL — Should start with a
/for links within the Directus Data Studio.
Security
- Auth Password Policy — Sets a policy requirement for all user's passwords via a JavaScript regex. Supports the
following options:
- None — Not recommended.
- Weak — Minimum of 8 characters.
- Strong — Uppercase, lowercase, numbers, and special characters.
- Other — Set custom policy with JavaScript regex.
- Auth Login Attempts — Sets the number of failed login attempts allowed before a user's account is locked. Once locked, an Admin user is required to unlock the account.
Files & Storage
The platform's file middleware allows for cropping and transforming image assets on the fly. This means you can simply request an original image, include any desired parameters, and you'll be served the new asset as a response.
To help stop malicious users from using up your storage by requesting a large number of random sizes, you can use the following options to limit what transformations are possible.
- Allowed Transformations — For enabling, disabling, or limiting image transformations.
- Default Folder — Sets the default folder where new assets are added. This does not affect existing files. Be aware that fields may override this value.
- Transformation Presets — Sets a specific image transformation configuration to simplify requests or limit usage.
- Key — Sets unique identifier allowing faster and easier image transformation requests.
- Fit — Contain (keeps aspect ratio), Cover (exact size), Fit Inside, or Fit Outside.
- Width — Sets the width of the image.
- Height — Sets the height of the image.
- Quality — Adjusts the compression or quality of the image.
- Upscaling — When enabled, images won't be upscaled.
- Format — Changes the output format.
- Additional Transformations — Adds additional transformations using Sharp.
::: tip How to Use Transformation Presets
To learn more, please see the API guide on transformation presets.
:::
Mapping
- Mapbox Access Token — Create a Mapbox Access Token and enter it here to improve the platform's mapping experience.
- Basemaps — Click Create New to set a custom tile configuration that overrides the Mapbox defaults.
- Name — Sets a custom name to identify the basemap preset.
- Type — Sets tile type. Choose from Raster, Raster TileJSON, or Mapbox Style.
- Tile Size — Sets a tile size (in pixels).
- URL — Sets the URL to request your tiles from.
- Attribution — Sets attribution information.
Image Editor
- Custom Aspect Ratios — Adds custom aspect ratios in the
image editor.
- Text — Sets a name to identify the aspect ratio.
- Value — Sets the aspect ratio with a fraction.
For example, if you want a 16:10 aspect ratio, you would type in 1.6, which is derived from 16/10, which equals 1.6.
If the intended aspect ratio is 16:9, the value would be 16 divided by 9, rounded to 1.7778.


