@directus/app 9.12.2 → 9.13.0

package/dist/assets/roles.9fec37da.js

@@ -1,171 +0,0 @@
-import{a as r,o as h,b as d,w as a,g as s,e as t,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var n={};const i={class:"markdown-body"},p={class:"two-up"},u={class:"left"},_=e("Roles define a specific set of access permissions, and are the primary organizational structure for Users within the platform. "),f=e("Learn more about Roles"),m=e("."),g=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-role-object"},"The Role Object")]),s("li",null,[s("a",{href:"#list-roles"},"List Roles")]),s("li",null,[s("a",{href:"#retrieve-a-role"},"Retrieve a Role")]),s("li",null,[s("a",{href:"#create-a-role"},"Create a Role")]),s("li",null,[s("a",{href:"#create-multiple-roles"},"Create Multiple Roles")]),s("li",null,[s("a",{href:"#update-a-role"},"Update a Role")]),s("li",null,[s("a",{href:"#update-multiple-roles"},"Update Multiple Roles")]),s("li",null,[s("a",{href:"#delete-a-role"},"Delete a Role")]),s("li",null,[s("a",{href:"#delete-multiple-roles"},"Delete Multiple Roles")])])])])],-1),j=s("hr",null,null,-1),y=s("h2",{id:"the-role-object"},[e("The Role Object "),s("a",{class:"header-anchor",href:"#the-role-object"},"#")],-1),b={class:"two-up"},q={class:"left"},x={class:"definitions"},v=s("p",null,[s("code",{class:""},"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the role.")],-1),R=s("p",null,[s("code",{class:""},"name"),e(),s("strong",null,"string"),s("br"),e(" Name of the role.")],-1),E=s("p",null,[s("code",{class:""},"icon"),e(),s("strong",null,"string"),s("br"),e(" Icon for the role. Displayed in the Admin App.")],-1),w=s("p",null,[s("code",{class:""},"description"),e(),s("strong",null,"string"),s("br"),e(" Description for the role. Displayed in the Admin App.")],-1),T=s("p",null,[s("code",{class:""},"ip_access"),e(),s("strong",null,"csv"),s("br"),e(" CSV of IP addresses that have access to this role. Allows you to configure an allowlist of IP addresses.")],-1),P=s("p",null,[s("code",{class:""},"enforce_tfa"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not Two-Factor Authentication is required for users in this role.")],-1),k=s("p",null,[s("code",{class:""},"admin_access"),e(),s("strong",null,"boolean"),s("br"),e(" If this role is considered an admin role. This means that users in this role have full permissions to everything.")],-1),A=s("p",null,[s("code",{class:""},"app_access"),e(),s("strong",null,"boolean"),s("br"),e(" Whether or not users in this role have access to use the Admin App.")],-1),S=s("code",{class:""},"users",-1),I=e(),C=s("strong",null,"one-to-many",-1),D=s("br",null,null,-1),L=e(" The users in this role. One-to-many to "),Q=e("users"),O=e("."),M=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[e(`{
-	`),s("span",{class:"hljs-attr"},'"id"'),e(": "),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Admin"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"supervised_user_circle"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"description"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"ip_access"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"enforce_tfa"'),e(": "),s("span",{class:"hljs-literal"},"false"),e(`,
-	`),s("span",{class:"hljs-attr"},'"admin_access"'),e(": "),s("span",{class:"hljs-literal"},"true"),e(`,
-	`),s("span",{class:"hljs-attr"},'"app_access"'),e(": "),s("span",{class:"hljs-literal"},"true"),e(`,
-	`),s("span",{class:"hljs-attr"},'"users"'),e(": ["),s("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),e(`]
-}
-`)])])],-1),G=s("hr",null,null,-1),B=s("h2",{id:"list-roles"},[e("List Roles "),s("a",{class:"header-anchor",href:"#list-roles"},"#")],-1),U=s("p",null,"List all roles that exist in Directus.",-1),H={class:"two-up"},N={class:"left"},V=s("h3",{id:"query-parameters"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),W=e("Supports all "),z=e("global query parameters"),F=e("."),J=s("h3",{id:"returns"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),K=e("An array of up to "),X=e("limit"),Y=e(),Z=s("a",{href:"#the-role-object"},"role objects",-1),$=e(". If no items are available, data will be an empty array."),ss={class:"right"},es=s("h3",{id:"rest-api"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),as=s("pre",null,[s("code",{class:""},`GET /roles
-SEARCH /roles
-`)],-1),ls=e("Learn more about SEARCH ->"),ts=s("h3",{id:"graphql"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),rs=s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)],-1),ns=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	roles: [directus_roles]
-}
-`)])],-1),os=s("h5",{id:"example"},[e("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),cs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	roles {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])],-1),hs=s("hr",null,null,-1),ds=s("h2",{id:"retrieve-a-role"},[e("Retrieve a Role "),s("a",{class:"header-anchor",href:"#retrieve-a-role"},"#")],-1),is=s("p",null,"List an existing role by primary key.",-1),ps={class:"two-up"},us={class:"left"},_s=s("h3",{id:"query-parameters-2"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),fs=e("Supports all "),ms=e("global query parameters"),gs=e("."),js=s("h3",{id:"returns-2"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),ys=s("p",null,[e("Returns the requested "),s("a",{href:"#the-role-object"},"role object"),e(".")],-1),bs=s("div",{class:"right"},[s("h3",{id:"rest-api-2"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",{class:""},`GET /roles/:id
-`)]),s("h5",{id:"example-2"},[e("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:""},`GET /roles/b4cb3b64-8580-4ad9-a099-eade6da24302
-`)]),s("h3",{id:"graphql-2"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	roles_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_roles
-}
-`)])]),s("h5",{id:"example-3"},[e("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	roles_by_id(id: `),s("span",{class:"hljs-number"},"2"),e(`) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),qs=s("hr",null,null,-1),xs=s("h2",{id:"create-a-role"},[e("Create a Role "),s("a",{class:"header-anchor",href:"#create-a-role"},"#")],-1),vs=s("p",null,"Create a new role.",-1),Rs={class:"two-up"},Es={class:"left"},ws=s("h3",{id:"query-parameters-3"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")],-1),Ts=e("Supports all "),Ps=e("global query parameters"),ks=e("."),As=s("h3",{id:"request-body"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Ss=s("p",null,[e("A partial "),s("a",{href:"#the-role-object"},"role object"),e(".")],-1),Is=s("h3",{id:"returns-3"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")],-1),Cs=s("p",null,[e("Returns the "),s("a",{href:"#the-role-object"},"role object"),e(" for the created role.")],-1),Ds=s("div",{class:"right"},[s("h3",{id:"rest-api-3"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",{class:""},`POST /roles
-`)]),s("h5",{id:"example-4"},[e("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /roles"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Interns"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"verified_user"'),e(`,
-	`),s("span",{class:"hljs-attr"},'"description"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-	`),s("span",{class:"hljs-attr"},'"admin_access"'),e(": "),s("span",{class:"hljs-literal"},"false"),e(`,
-	`),s("span",{class:"hljs-attr"},'"app_access"'),e(": "),s("span",{class:"hljs-literal"},"true"),e(`
-}
-`)])]),s("h3",{id:"graphql-3"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	create_roles_item(data: create_directus_roles_input!): directus_roles
-}
-`)])]),s("h5",{id:"example-5"},[e("Example "),s("a",{class:"header-anchor",href:"#example-5"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	create_roles_item(
-		data: { name: `),s("span",{class:"hljs-string"},'"Interns"'),e(", icon: "),s("span",{class:"hljs-string"},'"verified_user"'),e(", description: "),s("span",{class:"hljs-literal"},"null"),e(", admin_access: "),s("span",{class:"hljs-literal"},"false"),e(", app_access: "),s("span",{class:"hljs-literal"},"true"),e(` }
-	) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),Ls=s("hr",null,null,-1),Qs=s("h2",{id:"create-multiple-roles"},[e("Create Multiple Roles "),s("a",{class:"header-anchor",href:"#create-multiple-roles"},"#")],-1),Os=s("p",null,"Create multiple new roles.",-1),Ms={class:"two-up"},Gs={class:"left"},Bs=s("h3",{id:"query-parameters-4"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-4"},"#")],-1),Us=e("Supports all "),Hs=e("global query parameters"),Ns=e("."),Vs=s("h3",{id:"request-body-2"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-2"},"#")],-1),Ws=s("p",null,[e("An array of partial "),s("a",{href:"#the-role-object"},"role objects"),e(".")],-1),zs=s("h3",{id:"returns-4"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-4"},"#")],-1),Fs=s("p",null,[e("Returns the "),s("a",{href:"#the-role-object"},"role objects"),e(" for the created roles.")],-1),Js=s("div",{class:"right"},[s("h3",{id:"rest-api-4"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",{class:""},`POST /roles
-`)]),s("h5",{id:"example-6"},[e("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /roles"),e(`
-
-[
-	{
-		`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Interns"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"verified_user"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"description"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-		`),s("span",{class:"hljs-attr"},'"admin_access"'),e(": "),s("span",{class:"hljs-literal"},"false"),e(`,
-		`),s("span",{class:"hljs-attr"},'"app_access"'),e(": "),s("span",{class:"hljs-literal"},"true"),e(`
-	},
-	{
-		`),s("span",{class:"hljs-attr"},'"name"'),e(": "),s("span",{class:"hljs-string"},'"Customers"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"person"'),e(`,
-		`),s("span",{class:"hljs-attr"},'"description"'),e(": "),s("span",{class:"hljs-literal"},"null"),e(`,
-		`),s("span",{class:"hljs-attr"},'"admin_access"'),e(": "),s("span",{class:"hljs-literal"},"false"),e(`,
-		`),s("span",{class:"hljs-attr"},'"app_access"'),e(": "),s("span",{class:"hljs-literal"},"false"),e(`
-	}
-]
-`)])]),s("h3",{id:"graphql-4"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	create_roles_items(data: [create_directus_roles_input!]!): [directus_roles]
-}
-`)])]),s("h5",{id:"example-7"},[e("Example "),s("a",{class:"header-anchor",href:"#example-7"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	create_roles_items(
-		data: [
-			{ name: `),s("span",{class:"hljs-string"},'"Interns"'),e(", icon: "),s("span",{class:"hljs-string"},'"verified_user"'),e(", description: "),s("span",{class:"hljs-literal"},"null"),e(", admin_access: "),s("span",{class:"hljs-literal"},"false"),e(", app_access: "),s("span",{class:"hljs-literal"},"true"),e(` }
-			{ name: `),s("span",{class:"hljs-string"},'"Customers"'),e(", icon: "),s("span",{class:"hljs-string"},'"person"'),e(", description: "),s("span",{class:"hljs-literal"},"null"),e(", admin_access: "),s("span",{class:"hljs-literal"},"false"),e(", app_access: "),s("span",{class:"hljs-literal"},"false"),e(` }
-		]
-	) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),Ks=s("hr",null,null,-1),Xs=s("h2",{id:"update-a-role"},[e("Update a Role "),s("a",{class:"header-anchor",href:"#update-a-role"},"#")],-1),Ys=s("p",null,"Update an existing role.",-1),Zs={class:"two-up"},$s={class:"left"},se=s("h3",{id:"query-parameters-5"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-5"},"#")],-1),ee=e("Supports all "),ae=e("global query parameters"),le=e("."),te=s("h3",{id:"request-body-3"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-3"},"#")],-1),re=s("p",null,[e("A partial "),s("a",{href:"#the-role-object"},"role object"),e(".")],-1),ne=s("h3",{id:"returns-5"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-5"},"#")],-1),oe=s("p",null,[e("Returns the "),s("a",{href:"#the-role-object"},"role object"),e(" for the updated role.")],-1),ce=s("div",{class:"right"},[s("h3",{id:"rest-api-5"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),s("pre",null,[s("code",{class:""},`PATCH /roles/:id
-`)]),s("h5",{id:"example-8"},[e("Example "),s("a",{class:"header-anchor",href:"#example-8"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /roles/c86c2761-65d3-43c3-897f-6f74ad6a5bd7"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"attractions"'),e(`
-}
-`)])]),s("h3",{id:"graphql-5"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-5"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	update_roles_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_roles_input): directus_roles
-}
-`)])]),s("h5",{id:"example-9"},[e("Example "),s("a",{class:"header-anchor",href:"#example-9"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	update_roles_item(id: `),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", data: { icon: "),s("span",{class:"hljs-string"},'"attractions"'),e(` }) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),he=s("hr",null,null,-1),de=s("h2",{id:"update-multiple-roles"},[e("Update Multiple Roles "),s("a",{class:"header-anchor",href:"#update-multiple-roles"},"#")],-1),ie=s("p",null,"Update multiple existing roles.",-1),pe={class:"two-up"},ue={class:"left"},_e=s("h3",{id:"query-parameters-6"},[e("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-6"},"#")],-1),fe=e("Supports all "),me=e("global query parameters"),ge=e("."),je=s("h3",{id:"request-body-4"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),ye=s("div",{class:"definitions"},[s("p",null,[s("code",{class:""},"keys"),e(),s("strong",null,"Required"),s("br"),e(" Array of primary keys of the roles you\u2019d like to update.")]),s("p",null,[s("code",{class:""},"data"),e(),s("strong",null,"Required"),s("br"),e(" Any of "),s("a",{href:"#the-role-object"},"the role object"),e("\u2019s properties.")])],-1),be=s("h3",{id:"returns-6"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-6"},"#")],-1),qe=s("p",null,[e("Returns the "),s("a",{href:"#the-role-object"},"role objects"),e(" for the updated roles.")],-1),xe=s("div",{class:"right"},[s("h3",{id:"rest-api-6"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),s("pre",null,[s("code",{class:""},`PATCH /roles
-`)]),s("h5",{id:"example-10"},[e("Example "),s("a",{class:"header-anchor",href:"#example-10"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /roles"),e(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"keys"'),e(": ["),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", "),s("span",{class:"hljs-string"},'"6fc3d5d3-a37b-4da8-a2f4-ed62ad5abe03"'),e(`],
-	`),s("span",{class:"hljs-attr"},'"data"'),e(`: {
-		`),s("span",{class:"hljs-attr"},'"icon"'),e(": "),s("span",{class:"hljs-string"},'"attractions"'),e(`
-	}
-}
-`)])]),s("h3",{id:"graphql-6"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-6"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	update_roles_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_roles_input): [directus_roles]
-}
-`)])]),s("h5",{id:"example-11"},[e("Example "),s("a",{class:"header-anchor",href:"#example-11"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	update_roles_items(
-		ids: [`),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(", "),s("span",{class:"hljs-string"},'"6fc3d5d3-a37b-4da8-a2f4-ed62ad5abe03"'),e(`]
-		data: { icon: `),s("span",{class:"hljs-string"},'"attractions"'),e(` }
-	) {
-		id
-		name
-		users {
-			email
-		}
-	}
-}
-`)])])],-1),ve=s("hr",null,null,-1),Re=s("h2",{id:"delete-a-role"},[e("Delete a Role "),s("a",{class:"header-anchor",href:"#delete-a-role"},"#")],-1),Ee=s("p",null,"Delete an existing role.",-1),we=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"returns-7"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-7"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-7"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /roles/:id
-`)]),s("h5",{id:"example-12"},[e("Example "),s("a",{class:"header-anchor",href:"#example-12"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /roles/c86c2761-65d3-43c3-897f-6f74ad6a5bd7
-`)]),s("h3",{id:"graphql-7"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-7"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	delete_roles_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): delete_one
-}
-`)])]),s("h5",{id:"example-13"},[e("Example "),s("a",{class:"header-anchor",href:"#example-13"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	delete_roles_item(id: `),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`) {
-		id
-	}
-}
-`)])])])],-1),Te=s("hr",null,null,-1),Pe=s("h2",{id:"delete-multiple-roles"},[e("Delete Multiple Roles "),s("a",{class:"header-anchor",href:"#delete-multiple-roles"},"#")],-1),ke=s("p",null,"Delete multiple existing roles.",-1),Ae=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"request-body-5"},[e("Request Body "),s("a",{class:"header-anchor",href:"#request-body-5"},"#")]),s("p",null,"An array of role primary keys"),s("h3",{id:"returns-8"},[e("Returns "),s("a",{class:"header-anchor",href:"#returns-8"},"#")]),s("p",null,"Empty body.")]),s("div",{class:"right"},[s("h3",{id:"rest-api-8"},[e("REST API "),s("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),s("pre",null,[s("code",{class:""},`DELETE /roles
-`)]),s("h5",{id:"example-14"},[e("Example "),s("a",{class:"header-anchor",href:"#example-14"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /roles"),e(`
-[`),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(", "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`]
-`)])]),s("h3",{id:"graphql-8"},[e("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-8"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	delete_roles_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!): delete_many
-}
-`)])]),s("h5",{id:"example-15"},[e("Example "),s("a",{class:"header-anchor",href:"#example-15"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	delete_roles_items(ids: [`),s("span",{class:"hljs-string"},'"653925a9-970e-487a-bfc0-ab6c96affcdc"'),e(", "),s("span",{class:"hljs-string"},'"c86c2761-65d3-43c3-897f-6f74ad6a5bd7"'),e(`]) {
-		ids
-	}
-}
-`)])])])],-1),Se=s("hr",null,null,-1),Ie={title:"Roles",modularExtension:!1,pageClass:"page-reference"},Ce={name:"roles",setup(De,{expose:o}){return o({frontmatter:{title:"Roles",modularExtension:!1,pageClass:"page-reference"}}),(Le,Qe)=>{const l=r("router-link"),c=r("docswrapper");return h(),d(c,{frontmatter:Ie},{default:a(()=>[s("div",i,[s("div",p,[s("div",u,[s("blockquote",null,[s("p",null,[_,t(l,{to:"/docs/getting-started/glossary/#roles"},{default:a(()=>[f]),_:1}),m])])]),g]),j,y,s("div",b,[s("div",q,[s("div",x,[v,R,E,w,T,P,k,A,s("p",null,[S,I,C,D,L,t(l,{to:"/docs/reference/system/users/"},{default:a(()=>[Q]),_:1}),O])])]),M]),G,B,U,s("div",H,[s("div",N,[V,s("p",null,[W,t(l,{to:"/docs/reference/query"},{default:a(()=>[z]),_:1}),F]),J,s("p",null,[K,t(l,{to:"/docs/reference/query/#limit"},{default:a(()=>[X]),_:1}),Y,Z,$])]),s("div",ss,[es,as,s("p",null,[t(l,{to:"/docs/reference/introduction/#search-http-method"},{default:a(()=>[ls]),_:1})]),ts,rs,ns,os,cs])]),hs,ds,is,s("div",ps,[s("div",us,[_s,s("p",null,[fs,t(l,{to:"/docs/reference/query"},{default:a(()=>[ms]),_:1}),gs]),js,ys]),bs]),qs,xs,vs,s("div",Rs,[s("div",Es,[ws,s("p",null,[Ts,t(l,{to:"/docs/reference/query"},{default:a(()=>[Ps]),_:1}),ks]),As,Ss,Is,Cs]),Ds]),Ls,Qs,Os,s("div",Ms,[s("div",Gs,[Bs,s("p",null,[Us,t(l,{to:"/docs/reference/query"},{default:a(()=>[Hs]),_:1}),Ns]),Vs,Ws,zs,Fs]),Js]),Ks,Xs,Ys,s("div",Zs,[s("div",$s,[se,s("p",null,[ee,t(l,{to:"/docs/reference/query"},{default:a(()=>[ae]),_:1}),le]),te,re,ne,oe]),ce]),he,de,ie,s("div",pe,[s("div",ue,[_e,s("p",null,[fe,t(l,{to:"/docs/reference/query"},{default:a(()=>[me]),_:1}),ge]),je,ye,be,qe]),xe]),ve,Re,Ee,we,Te,Pe,ke,Ae,Se])]),_:1})}}};typeof n=="function"&&n(Ce);export{Ce as default,Ie as frontmatter};

package/dist/assets/running-locally.811d0dcc.js

@@ -1,26 +0,0 @@
-import{a as s,o as c,b as h,w as n,g as e,e as a,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var r={};const u={class:"markdown-body"},d=t("This guide explains how to install the "),p=e("em",null,"Development",-1),_=t(" version of Directus locally so that you can work on the platform\u2019s source code. To install the "),m=e("em",null,"Production",-1),g=t(" version locally, please follow to our "),f=t("standard installation guides"),y=t("."),b=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Minimum Requirements"),e("p",null,[t("You will need to have "),e("a",{href:"https://nodejs.org/en/download/current/",target:"_blank",rel:"noopener noreferrer"},"the latest version of Node"),t(" to "),e("em",null,"build"),t(" a Development version of Directus.")]),e("p",null,[t("You can use the JavaScript tool manager "),e("a",{href:"https://volta.sh/",target:"_blank",rel:"noopener noreferrer"},"volta"),t(" to automatically install the current node and npm versions.")])],-1),v=e("h2",{id:"1.-fork-the-directus-repository"},[t("1. Fork the Directus repository "),e("a",{class:"header-anchor",href:"#1.-fork-the-directus-repository"},"#")],-1),k=e("p",null,[t("Go to the "),e("a",{href:"https://github.com/directus/directus",target:"_blank",rel:"noopener noreferrer"},"repository"),t(" and fork it to your GitHub account. A fork is your copy of the Directus repository. Forking the repository allows you to freely experiment with changes without affecting the original project.")],-1),w=e("h2",{id:"2.-clone-from-your-repository"},[t("2. Clone from your repository "),e("a",{class:"header-anchor",href:"#2.-clone-from-your-repository"},"#")],-1),j=e("pre",null,[e("code",{class:"language-bash"},[t("git "),e("span",{class:"hljs-built_in"},"clone"),t(` git@github.com:YOUR-USERNAME/directus.git
-`)])],-1),x=e("h2",{id:"3.-make-a-new-branch"},[t("3. Make a new branch "),e("a",{class:"header-anchor",href:"#3.-make-a-new-branch"},"#")],-1),T=e("pre",null,[e("code",{class:"language-bash"},`git checkout -b YOUR-BRANCH-NAME
-`)],-1),A=e("h2",{id:"4.-install-the-dependencies-and-build-the-project"},[t("4. Install the dependencies and build the project "),e("a",{class:"header-anchor",href:"#4.-install-the-dependencies-and-build-the-project"},"#")],-1),D=e("pre",null,[e("code",{class:"language-bash"},`npm install
-npm run build
-`)],-1),C=e("h2",{id:"5.-create-a-.env-file"},[t("5. Create a "),e("code",{class:""},".env"),t(" file "),e("a",{class:"header-anchor",href:"#5.-create-a-.env-file"},"#")],-1),R=e("p",null,[t("Create an "),e("code",{class:""},".env"),t(" file under the "),e("code",{class:""},"api"),t(" folder using vars from the online "),e("a",{href:"https://docs.directus.io/configuration/config-options/",target:"_blank",rel:"noopener noreferrer"},"config help")],-1),E=e("h2",{id:"6.-initialize-the-database"},[t("6. Initialize the database "),e("a",{class:"header-anchor",href:"#6.-initialize-the-database"},"#")],-1),F=e("p",null,"For this step, you\u2019ll need to already have a SQL database up-and-running, except if you\u2019re using the SQLite driver, which will create the database (file) for you.",-1),N=e("p",null,"To start the initialization run the following command:",-1),S=e("pre",null,[e("code",{class:"language-bash"},[e("span",{class:"hljs-comment"},"# From within the root of the project"),t(`
-npm run cli bootstrap
-
-`),e("span",{class:"hljs-comment"},"# For SQLite you need to run the command in the 'api' context (to ensure the database file is created in the right directory)"),t(`
-npm run cli bootstrap --workspace=api
-`)])],-1),B=e("p",null,"This will set-up the required tables for Directus and make sure all the migrations have run.",-1),L=e("h2",{id:"7.-start-the-development-server"},[t("7. Start the development server "),e("a",{class:"header-anchor",href:"#7.-start-the-development-server"},"#")],-1),I=e("p",null,[t("First you need to choose what packages you want to work on. Then, you should run the "),e("code",{class:""},"dev"),t(" script on that package. You can see their names and list of scripts in their related "),e("code",{class:""},"package.json"),t(". Example of running APP:")],-1),M=e("pre",null,[e("code",{class:"language-bash"},`npm run dev -w @directus/app
-`)],-1),Y=e("p",null,"If you want to work on multiple packages at once, you should create a new instance of your terminal for each package: Example of running Api, App:",-1),q=e("table",null,[e("tr",null,[e("th",null," Terminal 1 [Api] "),e("th",null," Terminal 2 [App] ")]),e("tr",null,[e("td",null,[e("pre",null,[e("code",{class:"language-bash"},`npm run dev -w directus
-`)])]),e("td",null,[e("pre",null,[e("code",{class:"language-bash"},`npm run dev -w @directus/app
-`)])])])],-1),z=e("hr",null,null,-1),H=e("p",null,[t("To work on the Documentation (public website version), you should navigate to the "),e("code",{class:""},"docs"),t(" directory and run the following command:")],-1),G=e("pre",null,[e("code",{class:"language-bash"},`npm install
-`)],-1),P=e("p",null,[e("sup",null,"\u2139 This is necessary because the way vue-server-renderer imports vue")],-1),Q=e("p",null,"Then you should run",-1),U=e("pre",null,[e("code",{class:"language-bash"},`npm run dev:site
-`)],-1),V=e("div",{class:"tip hint"},[e("p",null,"If you encounter errors during this installation process, make sure your node version meets the minimum requirements")],-1),O=e("h2",{id:"8.-make-your-fixes%2Fchanges"},[t("8. Make your fixes/changes "),e("a",{class:"header-anchor",href:"#8.-make-your-fixes%2Fchanges"},"#")],-1),J=t("At this point you are ready to start working on Directus! Before diving in however, it\u2019s worth reading through the introduction to "),W=t("Contributing"),K=t("."),X=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Debugging"),e("p",null,[t("Check our Wiki for a "),e("a",{href:"https://github.com/directus/directus/wiki/debugging",target:"_blank",rel:"noopener noreferrer"},"guide"),t(" on debugging the app and api.")])],-1),Z=e("h2",{id:"9.-running-tests"},[t("9. Running tests "),e("a",{class:"header-anchor",href:"#9.-running-tests"},"#")],-1),$=e("p",null,"Tests run automatically through GitHub Actions. However you may wish to run the tests locally especially when you write tests.",-1),ee=e("p",null,[t("Install "),e("a",{href:"https://docs.docker.com/get-docker/",target:"_blank",rel:"noopener noreferrer"},"Docker"),t(" and ensure that the service is running.")],-1),te=e("pre",null,[e("code",{class:"language-bash"},[e("span",{class:"hljs-comment"},"# Ensure that you are testing on the lastest codebase"),t(`
-npm run build
-
-`),e("span",{class:"hljs-comment"},"# Clean up in case you ran the tests before"),t(`
-docker compose -f tests/docker-compose.yml down -v
-
-`),e("span",{class:"hljs-comment"},"# Start the necessary containers"),t(`
-docker compose -f tests/docker-compose.yml up -d --`),e("span",{class:"hljs-built_in"},"wait"),t(`
-
-`),e("span",{class:"hljs-comment"},"# Run the tests"),t(`
-npm run `),e("span",{class:"hljs-built_in"},"test"),t(`:e2e
-`)])],-1),ne={title:"Running Locally",modularExtension:!1},oe={name:"running-locally",setup(se,{expose:i}){return i({frontmatter:{title:"Running Locally",modularExtension:!1}}),(ae,re)=>{const o=s("router-link"),l=s("docswrapper");return c(),h(l,{frontmatter:ne},{default:n(()=>[e("div",u,[e("blockquote",null,[e("p",null,[d,p,_,m,g,a(o,{to:"/docs/self-hosted/installation/"},{default:n(()=>[f]),_:1}),y])]),b,v,k,w,j,x,T,A,D,C,R,E,F,N,S,B,L,I,M,Y,q,z,H,G,P,Q,U,V,O,e("p",null,[J,a(o,{to:"/docs/contributing/introduction"},{default:n(()=>[W]),_:1}),K]),X,Z,$,ee,te])]),_:1})}}};typeof r=="function"&&r(oe);export{oe as default,ne as frontmatter};

package/dist/assets/security.8e2a8a41.js

@@ -1 +0,0 @@
-import{a as i,o as c,b as n,w as o,g as e,B as a}from"./runtime-core.esm-bundler.b1f35d24.js";var r={};const d=e("div",{class:"markdown-body"},[e("blockquote",null,[e("p",null,"TK")]),e("h2",{id:"https"},[a("HTTPS "),e("a",{class:"header-anchor",href:"#https"},"#")]),e("h2",{id:"password-salting%2Fhashing%2Falgorithm-%26-password-policy"},[a("Password Salting/Hashing/Algorithm & Password Policy "),e("a",{class:"header-anchor",href:"#password-salting%2Fhashing%2Falgorithm-%26-password-policy"},"#")]),e("h2",{id:"static-tokens"},[a("Static Tokens "),e("a",{class:"header-anchor",href:"#static-tokens"},"#")]),e("h2",{id:"encrypted-fields-%26-encrypted-database"},[a("Encrypted Fields & Encrypted Database "),e("a",{class:"header-anchor",href:"#encrypted-fields-%26-encrypted-database"},"#")]),e("h2",{id:"private-file-links"},[a("Private File Links "),e("a",{class:"header-anchor",href:"#private-file-links"},"#")]),e("h2",{id:"mfa-(required)-%26-sso"},[a("MFA (Required) & SSO "),e("a",{class:"header-anchor",href:"#mfa-(required)-%26-sso"},"#")]),e("h2",{id:"granular-access-control-%26-ip-white-listing-%26-app-access"},[a("Granular Access Control & IP WHite-Listing & App Access "),e("a",{class:"header-anchor",href:"#granular-access-control-%26-ip-white-listing-%26-app-access"},"#")]),e("h2",{id:"rate-limiting"},[a("Rate Limiting "),e("a",{class:"header-anchor",href:"#rate-limiting"},"#")]),e("h2",{id:"encrypted"},[a("Encrypted "),e("a",{class:"header-anchor",href:"#encrypted"},"#")]),e("h2",{id:"parameterized-database-queries"},[a("Parameterized Database Queries "),e("a",{class:"header-anchor",href:"#parameterized-database-queries"},"#")])],-1),l={title:"Security",modularExtension:!1},h={name:"security",setup(p,{expose:s}){return s({frontmatter:{title:"Security",modularExtension:!1}}),(f,u)=>{const t=i("docswrapper");return c(),n(t,{frontmatter:l},{default:o(()=>[d]),_:1})}}};typeof r=="function"&&r(h);export{h as default,l as frontmatter};

package/dist/assets/settings.149d1dff.js

@@ -1 +0,0 @@
-import{a as i,o as d,b as c,w as o,g as t,e as n,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var r={};const u={class:"markdown-body"},_=t("blockquote",null,[t("p",null,"The Settings Module is where your entire Project is configured, making it the first place to go after installation. To maintain project safety and integrity, this module is only available to Administrators.")],-1),h=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/app-guide/settings/settings-20220308A/settings-20220308A.mp4",type:"video/mp4"})],-1),g=t("div",{class:"warning hint"},[t("div",{class:"hint-title"},"Administrators Only"),t("p",null,"Only Administrators have access to the Settings Module.")],-1),p=t("p",null,"Settings are split into five distinct sections, each described below.",-1),f=e("Project Settings"),m=e(" \u2014 Setup branding and other global style options."),b=e("Data Model"),y=e(" \u2014 Create and modify "),k=e("Collections"),v=e(", "),w=e("Relationships"),x=e(", form layout, and "),A=e("Fields"),S=e("."),C=e("Roles & Permissions"),q=e(" \u2014 Create and manage access via Roles and Permissions."),B=e("Presets & Bookmarks"),P=e(" \u2014 Set default views of data and configure bookmarks."),j=e("Webhooks"),R=e(" \u2014 Use platform events to trigger external services."),V=t("p",null,"Aside from the above pages, there are three shorthand links:",-1),F=t("li",null,[t("p",null,[t("strong",null,"Report Bug"),t("br"),e(" A direct link to report a bug in the platform. When using this button, helpful debugging information about your project is automatically included, such as: version number, operating system, and environment type.")])],-1),M=t("strong",null,"Request Feature",-1),N=t("br",null,null,-1),T=e(" A direct link to "),D=t("a",{href:"https://github.com/directus/directus/discussions/new",target:"_blank",rel:"noopener noreferrer"},"submit a new feature request",-1),E=e(" on GitHub. Feature requests are a great way to let our team know what should be prioritized next. Learn more about making feature requests in the "),G=e("Contributing > Introduction"),H=e("."),O=t("li",null,[t("p",null,[t("strong",null,"Platform Version"),t("br"),e(" Displays the exact version of your platform. Click this button to go to the GitHub releases page, which includes the full change logs.")])],-1),W={title:"Settings",modularExtension:!1},z={name:"settings",setup(I,{expose:l}){return l({frontmatter:{title:"Settings",modularExtension:!1}}),(L,U)=>{const s=i("router-link"),a=i("docswrapper");return d(),c(a,{frontmatter:W},{default:o(()=>[t("div",u,[_,h,g,p,t("ul",null,[t("li",null,[n(s,{to:"/docs/configuration/project-settings"},{default:o(()=>[f]),_:1}),m]),t("li",null,[n(s,{to:"/docs/configuration/data-model"},{default:o(()=>[b]),_:1}),y,n(s,{to:"/docs/getting-started/glossary/#collections"},{default:o(()=>[k]),_:1}),v,n(s,{to:"/docs/getting-started/glossary/#relationships"},{default:o(()=>[w]),_:1}),x,n(s,{to:"/docs/getting-started/glossary/#fields"},{default:o(()=>[A]),_:1}),S]),t("li",null,[n(s,{to:"/docs/configuration/users-roles-permissions"},{default:o(()=>[C]),_:1}),q]),t("li",null,[n(s,{to:"/docs/configuration/presets-bookmarks"},{default:o(()=>[B]),_:1}),P]),t("li",null,[n(s,{to:"/docs/configuration/webhooks"},{default:o(()=>[j]),_:1}),R])]),V,t("ul",null,[F,t("li",null,[t("p",null,[M,N,T,D,E,n(s,{to:"/docs/contributing/introduction/#feature-requests"},{default:o(()=>[G]),_:1}),H])]),O])])]),_:1})}}};typeof r=="function"&&r(z);export{z as default,W as frontmatter};

package/dist/assets/settings.28abc1f0.js

@@ -1,51 +0,0 @@
-import{a,o as i,b as h,w as e,g as s,e as n,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var o={};const d={class:"markdown-body"},_=s("div",{class:"two-up"},[s("div",{class:"left"},[s("blockquote",null,[s("p",null,"Settings are key-value pairs that are stored in the database, and control different aspects of the project. Only administrators have access to manage Settings.")])]),s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-settings-object"},"The Settings Object")]),s("li",null,[s("a",{href:"#retrieve-settings"},"Retrieve Settings")]),s("li",null,[s("a",{href:"#update-settings"},"Update Settings")])])])])])],-1),p=s("hr",null,null,-1),u=s("h2",{id:"the-settings-object"},[t("The Settings Object "),s("a",{class:"header-anchor",href:"#the-settings-object"},"#")],-1),g={class:"two-up"},f={class:"left"},j={class:"definitions"},m=s("p",null,[s("code",{class:""},"id"),t(),s("strong",null,"uuid"),s("br"),t(" Primary key of the setting.")],-1),b=s("p",null,[s("code",{class:""},"project_name"),t(),s("strong",null,"string"),s("br"),t(" Name of the project, shown in the Admin App.")],-1),y=s("p",null,[s("code",{class:""},"project_descriptor"),t(),s("strong",null,"string"),s("br"),t(" Descriptor of the project, shown in the Admin App.")],-1),v=s("p",null,[s("code",{class:""},"project_url"),t(),s("strong",null,"string"),s("br"),t(" Link to the (public) website that goes with this project.")],-1),w=s("p",null,[s("code",{class:""},"project_color"),t(),s("strong",null,"string"),s("br"),t(" Brand color for the current project.")],-1),x=s("code",{class:""},"project_logo",-1),q=t(),k=s("strong",null,"many-to-one",-1),A=s("br",null,null,-1),S=t(" Primary logo for the current project. Many-to-one to "),T=t("files"),E=t("."),P=s("code",{class:""},"public_foreground",-1),R=t(),C=s("strong",null,"many-to-one",-1),B=s("br",null,null,-1),M=t(" Foreground image for the Admin App\u2019s public pages. Many-to-one to "),O=t("files"),N=t("."),Q=s("code",{class:""},"public_background",-1),D=t(),G=s("strong",null,"many-to-one",-1),H=s("br",null,null,-1),I=t(" Background image for the Admin App\u2019s public pages. Many-to-one to "),L=t("files"),V=t("."),W=s("p",null,[s("code",{class:""},"public_note"),t(),s("strong",null,"string"),s("br"),t(" Note shown on the Admin App\u2019s public pages. Supports Markdown.")],-1),F=s("p",null,[s("code",{class:""},"auth_login_attempts"),t(),s("strong",null,"integer"),s("br"),t(" How often a user is allowed to try to login. After which times the user will be suspended.")],-1),U=s("p",null,[s("code",{class:""},"auth_password_policy"),t(),s("strong",null,"RegEx"),s("br"),t(" What regex passwords must pass in order to be valid.")],-1),z=s("code",{class:""},"storage_asset_transform",-1),J=t(),K=s("strong",null,"string",-1),X=s("br",null,null,-1),Y=t(" If the transform endpoints are allowed to be used on "),Z=t("the assets endpoint"),$=t(". One of "),ss=s("code",{class:""},"all",-1),ts=t(", "),es=s("code",{class:""},"none",-1),ls=t(" or "),ns=s("code",{class:""},"presets",-1),as=t("."),os=s("code",{class:""},"storage_asset_presets",-1),rs=t(),cs=s("strong",null,"array",-1),is=s("br",null,null,-1),hs=t(" What preset keys exist in "),ds=t("the assets endpoint"),_s=t("."),ps=s("p",null,[s("code",{class:""},"custom_css"),t(),s("strong",null,"string"),s("br"),t(" CSS rules to override the App\u2019s default styling.")],-1),us=s("p",null,[s("code",{class:""},"storage_default_folder"),t(),s("strong",null,"uuid"),s("br"),t(" Folder for uploaded files. Does not affect existing files.")],-1),gs=s("p",null,[s("code",{class:""},"basemaps"),t(),s("strong",null,"array"),s("br"),t(" Custom tiles to overriding the Mapbox defaults.")],-1),fs=s("p",null,[s("code",{class:""},"mapbox_key"),t(),s("strong",null,"string"),s("br"),s("a",{href:"https://docs.mapbox.com/help/glossary/access-token/",target:"_blank",rel:"noopener noreferrer"},"Mapbox Access Token"),t(".")],-1),js=s("p",null,[s("code",{class:""},"module_bar"),t(),s("strong",null,"array"),s("br"),t(" What modules are enabled/added globally.")],-1),ms=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[t(`{
-	`),s("span",{class:"hljs-attr"},'"data"'),t(`: {
-		`),s("span",{class:"hljs-attr"},'"id"'),t(": "),s("span",{class:"hljs-number"},"1"),t(`,
-		`),s("span",{class:"hljs-attr"},'"project_name"'),t(": "),s("span",{class:"hljs-string"},'"Directus"'),t(`,
-		`),s("span",{class:"hljs-attr"},'"project_descriptor"'),t(": "),s("span",{class:"hljs-string"},'"Application"'),t(`,
-		`),s("span",{class:"hljs-attr"},'"project_url"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
-		`),s("span",{class:"hljs-attr"},'"project_color"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
-		`),s("span",{class:"hljs-attr"},'"project_logo"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
-		`),s("span",{class:"hljs-attr"},'"public_foreground"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
-		`),s("span",{class:"hljs-attr"},'"public_background"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
-		`),s("span",{class:"hljs-attr"},'"public_note"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
-		`),s("span",{class:"hljs-attr"},'"auth_login_attempts"'),t(": "),s("span",{class:"hljs-number"},"25"),t(`,
-		`),s("span",{class:"hljs-attr"},'"auth_password_policy"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
-		`),s("span",{class:"hljs-attr"},'"storage_asset_transform"'),t(": "),s("span",{class:"hljs-string"},'"all"'),t(`,
-		`),s("span",{class:"hljs-attr"},'"storage_asset_presets"'),t(`: [
-			{ `),s("span",{class:"hljs-attr"},'"key"'),t(": "),s("span",{class:"hljs-string"},'"small"'),t(", "),s("span",{class:"hljs-attr"},'"fit"'),t(": "),s("span",{class:"hljs-string"},'"cover"'),t(", "),s("span",{class:"hljs-attr"},'"width"'),t(": "),s("span",{class:"hljs-number"},"200"),t(", "),s("span",{class:"hljs-attr"},'"height"'),t(": "),s("span",{class:"hljs-number"},"161"),t(", "),s("span",{class:"hljs-attr"},'"quality"'),t(": "),s("span",{class:"hljs-number"},"80"),t(", "),s("span",{class:"hljs-attr"},'"withoutEnlargement"'),t(": "),s("span",{class:"hljs-literal"},"false"),t(` }
-		],
-		`),s("span",{class:"hljs-attr"},'"custom_css"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
-		`),s("span",{class:"hljs-attr"},'"storage_default_folder"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
-		`),s("span",{class:"hljs-attr"},'"basemaps"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
-		`),s("span",{class:"hljs-attr"},'"mapbox_key"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`,
-		`),s("span",{class:"hljs-attr"},'"module_bar"'),t(": "),s("span",{class:"hljs-literal"},"null"),t(`
-	}
-}
-`)])])],-1),bs=s("hr",null,null,-1),ys=s("h2",{id:"retrieve-settings"},[t("Retrieve Settings "),s("a",{class:"header-anchor",href:"#retrieve-settings"},"#")],-1),vs={class:"two-up"},ws={class:"left"},xs=s("h3",{id:"query-parameters"},[t("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")],-1),qs=t("Supports all "),ks=t("global query parameters"),As=t("."),Ss=s("h3",{id:"returns"},[t("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")],-1),Ts=s("p",null,[t("Returns the "),s("a",{href:"#the-settings-object"},"settings object"),t(".")],-1),Es=s("div",{class:"right"},[s("h3",{id:"rest-api"},[t("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")]),s("pre",null,[s("code",{class:""},`GET /settings
-`)]),s("h3",{id:"graphql"},[t("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),t(` {
-	settings: directus_settings
-}
-`)])]),s("h5",{id:"example"},[t("Example "),s("a",{class:"header-anchor",href:"#example"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),t(` {
-	settings {
-		project_name
-	}
-}
-`)])])],-1),Ps=s("hr",null,null,-1),Rs=s("h2",{id:"update-settings"},[t("Update Settings "),s("a",{class:"header-anchor",href:"#update-settings"},"#")],-1),Cs={class:"two-up"},Bs={class:"left"},Ms=s("h3",{id:"query-parameters-2"},[t("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),Os=t("Supports all "),Ns=t("global query parameters"),Qs=t("."),Ds=s("h3",{id:"request-body"},[t("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Gs=s("p",null,[t("A partial "),s("a",{href:"#the-settings-object"},"settings object"),t(".")],-1),Hs=s("h3",{id:"returns-2"},[t("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),Is=s("p",null,[t("Returns the "),s("a",{href:"#the-setting-object"},"settings object"),t(".")],-1),Ls=s("div",{class:"right"},[s("h3",{id:"rest-api-2"},[t("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",{class:""},`PATCH /settings
-`)]),s("h5",{id:"example-2"},[t("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /settings"),t(`
-
-{
-	`),s("span",{class:"hljs-attr"},'"project_url"'),t(": "),s("span",{class:"hljs-string"},'"https://example.com/"'),t(`
-}
-`)])]),s("h3",{id:"graphql-2"},[t("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",{class:""},`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),t(` {
-	update_settings(data: update_directus_settings_input!): directus_settings
-}
-`)])]),s("h5",{id:"example-3"},[t("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),t(` {
-	update_settings(data: { project_url: `),s("span",{class:"hljs-string"},'"https://example.com"'),t(` }) {
-		project_name
-		project_url
-	}
-}
-`)])])],-1),Vs={title:"Settings",modularExtension:!1,pageClass:"page-reference"},Ws={name:"settings",setup(Fs,{expose:r}){return r({frontmatter:{title:"Settings",modularExtension:!1,pageClass:"page-reference"}}),(Us,zs)=>{const l=a("router-link"),c=a("docswrapper");return i(),h(c,{frontmatter:Vs},{default:e(()=>[s("div",d,[_,p,u,s("div",g,[s("div",f,[s("div",j,[m,b,y,v,w,s("p",null,[x,q,k,A,S,n(l,{to:"/docs/reference/files/"},{default:e(()=>[T]),_:1}),E]),s("p",null,[P,R,C,B,M,n(l,{to:"/docs/reference/files/"},{default:e(()=>[O]),_:1}),N]),s("p",null,[Q,D,G,H,I,n(l,{to:"/docs/reference/files/"},{default:e(()=>[L]),_:1}),V]),W,F,U,s("p",null,[z,J,K,X,Y,n(l,{to:"/docs/reference/files/#requesting-a-thumbnail"},{default:e(()=>[Z]),_:1}),$,ss,ts,es,ls,ns,as]),s("p",null,[os,rs,cs,is,hs,n(l,{to:"/docs/reference/files/#requesting-a-thumbnail"},{default:e(()=>[ds]),_:1}),_s]),ps,us,gs,fs,js])]),ms]),bs,ys,s("div",vs,[s("div",ws,[xs,s("p",null,[qs,n(l,{to:"/docs/reference/query"},{default:e(()=>[ks]),_:1}),As]),Ss,Ts]),Es]),Ps,Rs,s("div",Cs,[s("div",Bs,[Ms,s("p",null,[Os,n(l,{to:"/docs/reference/query"},{default:e(()=>[Ns]),_:1}),Qs]),Ds,Gs,Hs,Is]),Ls])])]),_:1})}}};typeof o=="function"&&o(Ws);export{Ws as default,Vs as frontmatter};

package/dist/assets/sso.64b2717b.js

@@ -1,22 +0,0 @@
-import{a as o,o as i,b as c,w as l,g as e,e as u,B as s}from"./runtime-core.esm-bundler.b1f35d24.js";var n={};const h={class:"markdown-body"},d=e("p",null,"Single Sign-On is a mechanism which allows to use external providers to login into systems. For example, you can use your Google or Facebook account to authenticate into systems without the need to create a new registration on those systems.",-1),p=e("h2",{id:"supported-sso-mechanisms"},[s("Supported SSO mechanisms "),e("a",{class:"header-anchor",href:"#supported-sso-mechanisms"},"#")],-1),g=e("p",null,"Directus supports three standard types of SSO mechanisms:",-1),_=e("ul",null,[e("li",null,[e("a",{href:"https://openid.net/specs/openid-connect-core-1_0.html",target:"_blank",rel:"noopener noreferrer"},"OpenID")]),e("li",null,[e("a",{href:"https://www.ietf.org/rfc/rfc6750.txt",target:"_blank",rel:"noopener noreferrer"},"OAuth 2.0")]),e("li",null,[e("a",{href:"https://datatracker.ietf.org/doc/html/rfc4511",target:"_blank",rel:"noopener noreferrer"},"LDAP")])],-1),m=s("Here are the configuration allowed for each one: "),f=s("SSO configuration"),y=e("p",null,"In order to use these mechanisms you need to:",-1),O=e("ol",null,[e("li",null,"Create an application/configuration on your preferred external provider"),e("li",null,"Set the environment variables to configure the external provider"),e("li",null,[s("["),e("em",null,"Optional"),s("] Set the environment variables to configure cookies")])],-1),S=e("h3",{id:"openid"},[s("OpenID "),e("a",{class:"header-anchor",href:"#openid"},"#")],-1),X=e("p",null,"In this section, we provide some guides to help you set up SSO with OpenID.",-1),w=e("h4",{id:"google"},[s("Google "),e("a",{class:"header-anchor",href:"#google"},"#")],-1),v=e("p",null,"To be able to use Google OpenID as your external provider you will need to:",-1),E=e("ol",null,[e("li",null,[e("p",null,[s("Go into "),e("a",{href:"https://console.cloud.google.com/",target:"_blank",rel:"noopener noreferrer"},"Google Cloud Console")])]),e("li",null,[e("p",null,"Select or Create a new project")]),e("li",null,[e("p",null,[s("Go to "),e("a",{href:"https://console.cloud.google.com/apis/credentials/consent",target:"_blank",rel:"noopener noreferrer"},"APIs & Services -> OAuth consent screen"),s(" on side bar")]),e("ol",null,[e("li",null,[s("Select the access you desire "),e("ul",null,[e("li",null,[s("Select "),e("strong",null,"Internal"),s(" if you only want people within your organization to be able to access")]),e("li",null,[s("Select "),e("strong",null,"External"),s(" to allow everyone with a Google account")])])]),e("li",null,[s("Fill the fields according to your preferences "),e("ul",null,[e("li",null,[s("The "),e("strong",null,"Authorized domains"),s(" add an extra layer of security, but it is not required. In case you fill it, should be the domain where your Directus instance is")])])]),e("li",null,[s("On Scopes, you need to choose "),e("code",{class:""},".../auth/userinfo.email"),s(", "),e("code",{class:""},".../auth/userinfo.profile"),s(" and "),e("code",{class:""},"openid")])])]),e("li",null,[e("p",null,[s("On side bar, go to "),e("a",{href:"https://console.cloud.google.com/apis/credentials",target:"_blank",rel:"noopener noreferrer"},"Credentials")])]),e("li",null,[e("p",null,[s("Click on "),e("a",{href:"https://console.cloud.google.com/apis/credentials/oauthclient",target:"_blank",rel:"noopener noreferrer"},"Create Credentials -> OAuth Client ID")]),e("ol",null,[e("li",null,[s("Choose "),e("code",{class:""},"Web Application"),s(" on "),e("strong",null,"Application Type")]),e("li",null,[s("The "),e("strong",null,"Authorized JavaScript origins"),s(" adds an extra layer of security, but it is not required. In case you fill it, should be the address of your Directus instance. For example, "),e("code",{class:""},"https://directus.myserver.com")]),e("li",null,[s("On "),e("strong",null,"Authorized redirect URIs"),s(" put your Directus instance address plus "),e("code",{class:""},"/auth/login/google/callback"),s(". For example, you should put "),e("code",{class:""},"https://directus.myserver.com/auth/login/google/callback"),s(" where "),e("code",{class:""},"https://directus.myserver.com"),s(" should be the address of your Directus instance. If you are testing locally you should add "),e("code",{class:""},"http://localhost:8055/auth/login/google/callback"),s(" too")])])]),e("li",null,[e("p",null,[s("On click "),e("strong",null,"Create"),s(", a modal will appear with "),e("strong",null,"Client ID"),s(" and "),e("strong",null,"Client Secret"),s(". Save both somewhere to use later.")])]),e("li",null,[e("p",null,[s("Now on Directus side, you need to add the following configuration to your "),e("code",{class:""},".env"),s(" file located on root folder of your project:")])])],-1),b=e("pre",null,[e("code",{class:"language-sh"},[s("AUTH_PROVIDERS="),e("span",{class:"hljs-string"},'"google"'),s(`
-
-AUTH_GOOGLE_DRIVER=`),e("span",{class:"hljs-string"},'"openid"'),s(`
-AUTH_GOOGLE_CLIENT_ID=`),e("span",{class:"hljs-string"},'"XXXX"'),s(),e("span",{class:"hljs-comment"},"# Replace XXXX with the Client ID from Step 6"),s(`
-AUTH_GOOGLE_CLIENT_SECRET=`),e("span",{class:"hljs-string"},'"XXXX"'),s(),e("span",{class:"hljs-comment"},"# Replace XXXX with the Client Secret from Step 6"),s(`
-AUTH_GOOGLE_ISSUER_URL=`),e("span",{class:"hljs-string"},'"https://accounts.google.com"'),s(`
-AUTH_GOOGLE_IDENTIFIER_KEY=`),e("span",{class:"hljs-string"},'"email"'),s(`
-AUTH_GOOGLE_ICON=`),e("span",{class:"hljs-string"},'"google"'),s(`
-AUTH_GOOGLE_ALLOW_PUBLIC_REGISTRATION=`),e("span",{class:"hljs-string"},'"true"'),s(),e("span",{class:"hljs-comment"},'# This allows users to be automatically created on logins. Use "false" if you want to create users manually'),s(`
-AUTH_GOOGLE_DEFAULT_ROLE_ID=`),e("span",{class:"hljs-string"},'"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"'),s(),e("span",{class:"hljs-comment"},"# Replace this with the Directus Role ID you would want for new users. If this is not properly configured, new users will not have access to Directus"),s(`
-`)])],-1),I=e("ol",{start:"8"},[e("li",null,[s("Now you can see a nice functional "),e("code",{class:""},"Login with Google"),s(" button on Directus login page.")])],-1),j=e("h2",{id:"seamless-sso"},[s("Seamless SSO "),e("a",{class:"header-anchor",href:"#seamless-sso"},"#")],-1),k=e("p",null,"While sometimes you want your users to directly have access to the Directus Application, in other cases you may need to fetch private data from Directus in your client using external providers. In this cases, it is needed a special configuration to work across domains, but is simple as:",-1),D=e("ol",null,[e("li",null,[s("Setup an external provider. You have some examples on "),e("a",{href:"#supported-sso-mechanisms"},"Supported SSO mechanisms")]),e("li",null,[s("Allow cookie to be accessible across domains. Put the following configuration on "),e("code",{class:""},".env"),s(":")])],-1),T=e("pre",null,[e("code",{class:"language-sh"},[s("REFRESH_TOKEN_COOKIE_DOMAIN="),e("span",{class:"hljs-string"},'"XXXX"'),s(),e("span",{class:"hljs-comment"},'# Replace XXXX with the domain of your Directus instance. For example "directus.myserver.com"'),s(`
-REFRESH_TOKEN_COOKIE_SECURE=`),e("span",{class:"hljs-string"},'"true"'),s(`
-REFRESH_TOKEN_COOKIE_SAME_SITE=`),e("span",{class:"hljs-string"},'"None"'),s(`
-`)])],-1),A=e("ol",{start:"2"},[e("li",null,"On your client, your login button should be something like")],-1),C=e("pre",null,[e("code",{class:"language-html"},[e("span",{class:"hljs-tag"},[s("<"),e("span",{class:"hljs-name"},"a"),s(),e("span",{class:"hljs-attr"},"href"),s("="),e("span",{class:"hljs-string"},'"https://directus.myserver.com/auth/login/google?redirect=https://client.myserver.com/login"'),s(">")]),s("Login"),e("span",{class:"hljs-tag"},[s("</"),e("span",{class:"hljs-name"},"a"),s(">")]),s(`
-`)])],-1),R=e("ul",null,[e("li",null,[s("Where "),e("code",{class:""},"https://directus.myserver.com"),s(" should be the address of your Directus instance")]),e("li",null,[s("While "),e("code",{class:""},"https://client.myserver.com/login"),s(" should be the address of your client application. The "),e("code",{class:""},"/login"),s(" is not necessary, but helps to separate concerns")])],-1),G=e("ol",{start:"3"},[e("li",null,[e("p",null,[s("On your login page, following the example should be "),e("code",{class:""},"https://client.myserver.com/login"),s(" you need to call the refresh endpoint either via REST API or via SDK in order to retrieve an "),e("code",{class:""},"access_token")]),e("ul",null,[e("li",null,[e("p",null,"via REST API / fetch"),e("pre",null,[e("code",{class:"language-js"},[e("span",{class:"hljs-keyword"},"await"),s(" fetch("),e("span",{class:"hljs-string"},"'https://directus.myserver.com/auth/refresh'"),s(`, {
-	`),e("span",{class:"hljs-attr"},"method"),s(": "),e("span",{class:"hljs-string"},"'POST'"),s(`,
-	`),e("span",{class:"hljs-attr"},"withCredentials"),s(": "),e("span",{class:"hljs-literal"},"true"),s(", "),e("span",{class:"hljs-comment"},"// this is required in order to send the refresh token cookie"),s(`
-});
-`)])])]),e("li",null,[e("p",null,"via SDK"),e("pre",null,[e("code",{class:"language-js"},[e("span",{class:"hljs-keyword"},"const"),s(" sdk = "),e("span",{class:"hljs-keyword"},"new"),s(" Directus("),e("span",{class:"hljs-string"},"'https://directus.myserver.com'"),s(`);
-
-`),e("span",{class:"hljs-keyword"},"await"),s(` sdk.auth.refresh();
-`)])])])])])],-1),x={title:"Single Sign-On (SSO)",modularExtension:!1},L={name:"sso",setup(U,{expose:t}){return t({frontmatter:{title:"Single Sign-On (SSO)",modularExtension:!1}}),(N,H)=>{const a=o("router-link"),r=o("docswrapper");return i(),c(r,{frontmatter:x},{default:l(()=>[e("div",h,[d,p,g,_,e("p",null,[m,u(a,{to:"/docs/configuration/config-options/#sso-oauth2-and-openid"},{default:l(()=>[f]),_:1})]),y,O,S,X,w,v,E,b,I,j,k,D,T,A,C,R,G])]),_:1})}}};typeof n=="function"&&n(L);export{L as default,x as frontmatter};

package/dist/assets/support.94e3734b.js

@@ -1 +0,0 @@
-import{a as n,o as c,b as l,w as o,g as e,e as r,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var i={};const d={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"Directus is offered completely free and open-source for anyone wishing to self-host the platform. If you have questions along the way, there are many resources, both free and paid, to help you get up-and-running smoothly.")],-1),p=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#troubleshooting-steps"},"Troubleshooting Steps")]),e("li",null,[e("a",{href:"#support-tiers"},"Support Tiers")]),e("li",null,[e("a",{href:"#sponsored-work"},"Sponsored Work")]),e("li",null,[e("a",{href:"#frequently-asked-questions"},"Frequently Asked Questions")])])])],-1),f=e("h2",{id:"troubleshooting-steps"},[t("Troubleshooting Steps "),e("a",{class:"header-anchor",href:"#troubleshooting-steps"},"#")],-1),m=t("If you\u2019re experiencing issues or think you have found a problem in Directus, be sure to follow these steps before "),_=t("Reporting a Bug"),y=t(":"),g=t("Ensure your server and database meet the "),b=t("minimum requirements"),w=t("."),v=e("li",null,[t("Ensure you\u2019re on the "),e("a",{href:"https://github.com/directus/directus/releases/latest",target:"_blank",rel:"noopener noreferrer"},"latest version"),t(" of Directus.")],-1),k=e("li",null,[t("Stop "),e("code",{class:""},"CTRL+C"),t(" and restart the server "),e("code",{class:""},"npx directus start"),t(".")],-1),x=e("li",null,[t("Run the database migration script: "),e("code",{class:""},"directus database migrate:latest"),e("br"),e("em",null,"Note: backup your database first.")],-1),q=e("li",null,"Disable any data-caching within your project.",-1),C=e("li",null,[t("Test any app issues with both browser extensions and caching disabled "),e("em",null,"(i.e. Incognito Mode)"),t(".")],-1),S=e("li",null,"Confirm the issue is not related to your own custom code.",-1),D=e("li",null,[t("Check for "),e("a",{href:"https://github.com/directus/directus/issues?q=is%3Aissue",target:"_blank",rel:"noopener noreferrer"},"existing Issues"),t(" (and "),e("a",{href:"https://github.com/directus/directus/discussions",target:"_blank",rel:"noopener noreferrer"},"Discussions"),t(") that match your problem.")],-1),F=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Source Contributors"),e("p",null,[t("If you have installed from source, then you should also remove all dependencies by running "),e("code",{class:""},"npx lerna clean -y"),t(" and reinstall them with "),e("code",{class:""},"npm install")])],-1),I=t("If you\u2019re still experiencing a problem after completing the above steps, you can chat through things on our "),T=e("a",{href:"#community-support"},"community support",-1),B=t(" or "),E=t("report a bug"),j=t("."),W=e("h2",{id:"support-tiers"},[t("Support Tiers "),e("a",{class:"header-anchor",href:"#support-tiers"},"#")],-1),N=e("h3",{id:"community-support"},[t("Community Support "),e("a",{class:"header-anchor",href:"#community-support"},"#")],-1),O=e("p",null,[e("a",{href:"https://github.com/directus/directus/discussions",target:"_blank",rel:"noopener noreferrer"},"GitHub Discussions"),t(" 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.")],-1),R=e("p",null,[t("Our "),e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord Community"),t(" is another great way to get assistance. Please keep all questions on the "),e("code",{class:""},"#help"),t(" channel, be considerate, and remember that you are getting free help from the community for a free product.")],-1),z=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"No Guaranteed Response Time"),e("p",null,"While the Directus Core Team plays an active and engaged role in community discussions, there is no guaranteed response time for Community Support.")],-1),M=e("h3",{id:"basic-and-premium-support"},[t("Basic and Premium Support "),e("a",{class:"header-anchor",href:"#basic-and-premium-support"},"#")],-1),P=e("p",null,"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.",-1),A=t("Cloud customers and Self-Hosted users interested in learning more about our monthly retainer agreements should contact us at "),H=t("support@directus.io"),Q=t("."),V=e("h2",{id:"sponsored-work"},[t("Sponsored Work "),e("a",{class:"header-anchor",href:"#sponsored-work"},"#")],-1),G=e("h3",{id:"commissioned-features"},[t("Commissioned Features "),e("a",{class:"header-anchor",href:"#commissioned-features"},"#")],-1),L=t("If you need a specific feature added to Directus faster than the normal development timeline, "),Y=e("a",{href:"https://directus.io/contact/",target:"_blank",rel:"noopener noreferrer"},"reach out to us",-1),J=t(" for a quote. Our parent agency will often help subsidize the cost of developing new features if they pass our "),K=t("80/20 Rule"),U=t(" and can be merged into the core codebase. Other custom/proprietary development will be built bespoke within our robust extension system."),X=e("h3",{id:"expedited-fixes"},[t("Expedited Fixes "),e("a",{class:"header-anchor",href:"#expedited-fixes"},"#")],-1),Z=e("p",null,[t("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, "),e("a",{href:"https://directus.io/contact/",target:"_blank",rel:"noopener noreferrer"},"reach out to us"),t(" for a quote.")],-1),$=e("h2",{id:"frequently-asked-questions"},[t("Frequently Asked Questions "),e("a",{class:"header-anchor",href:"#frequently-asked-questions"},"#")],-1),ee=e("h3",{id:"does-directus-support-mongo%2Fnosql%3F"},[t("Does Directus support Mongo/NoSQL? "),e("a",{class:"header-anchor",href:"#does-directus-support-mongo%2Fnosql%3F"},"#")],-1),te=e("p",null,[t("Not currently. Directus has been built specifically for wrapping "),e("em",null,"relational"),t(" databases. While we could force Mongo to use tables, columns, and rows via Mongoose object modeling, that approach of \u201Cfaking\u201D a relational structure in a non-structured environment like Mongo doesn\u2019t make a lot of sense. We do realize many users are interested in this feature, and will continue to explore its possibility.")],-1),oe=e("h3",{id:"why-haven%E2%80%99t-you-added-this-feature%2C-or-fixed-that-issue-yet%3F"},[t("Why haven\u2019t you added this feature, or fixed that issue yet? "),e("a",{class:"header-anchor",href:"#why-haven%E2%80%99t-you-added-this-feature%2C-or-fixed-that-issue-yet%3F"},"#")],-1),se=e("p",null,"Directus is primarily a free and open-source project, maintained by a small core team and community contributors who donate their time and resources.",-1),re=t("Our platform is feature-rich, however we strictly adhere to our "),ne=t("80/20 Rule"),ie=t(" 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."),ae=e("p",null,[t("If you need, you can contact us about "),e("a",{href:"#expedited-fixes"},"sponsoring expedited fixes"),t(" or "),e("a",{href:"#commissioned-features"},"commissioning new features"),t(". You can also "),e("a",{href:"https://github.com/directus/directus/pulls",target:"_blank",rel:"noopener noreferrer"},"submit a pull request"),t(" \u2014 after all, it is open-source!")],-1),ue=e("h3",{id:"can-you-give-an-eta-for-this-feature%2Ffix%3F"},[t("Can you give an ETA for this feature/fix? "),e("a",{class:"header-anchor",href:"#can-you-give-an-eta-for-this-feature%2Ffix%3F"},"#")],-1),ce=e("p",null,"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.",-1),le=e("h3",{id:"but-this-is-an-emergency%2C-my-very-important-project-requires-it-now!"},[t("But this is an emergency, my very important project requires it now! "),e("a",{class:"header-anchor",href:"#but-this-is-an-emergency%2C-my-very-important-project-requires-it-now!"},"#")],-1),de=e("p",null,[t("We understand, and are here to help. If you need something prioritized, you can reach out to us to discuss "),e("a",{href:"#basic-and-premium-support"},"premium support"),t(", "),e("a",{href:"#expedited-fixes"},"sponsoring expedited fixes"),t(" or "),e("a",{href:"#commissioned-features"},"commissioning new features"),t(".")],-1),he={title:"Help & Support",modularExtension:!1},pe={name:"support",setup(fe,{expose:a}){return a({frontmatter:{title:"Help & Support",modularExtension:!1}}),(me,_e)=>{const s=n("router-link"),u=n("docswrapper");return c(),l(u,{frontmatter:he},{default:o(()=>[e("div",d,[h,p,f,e("p",null,[m,r(s,{to:"/docs/contributing/introduction/#bug-reporting"},{default:o(()=>[_]),_:1}),y]),e("ol",null,[e("li",null,[g,r(s,{to:"/docs/self-hosted/installation/cli/#_1-confirm-minimum-requirements"},{default:o(()=>[b]),_:1}),w]),v,k,x,q,C,S,D]),F,e("p",null,[I,T,B,r(s,{to:"/docs/contributing/introduction/#bug-reporting"},{default:o(()=>[E]),_:1}),j]),W,N,O,R,z,M,P,e("p",null,[A,r(s,{to:"/docsmailto:support@directus.io"},{default:o(()=>[H]),_:1}),Q]),V,G,e("p",null,[L,Y,J,r(s,{to:"/docs/contributing/introduction/#feature-requests"},{default:o(()=>[K]),_:1}),U]),X,Z,$,ee,te,oe,se,e("p",null,[re,r(s,{to:"/docs/contributing/introduction/#feature-requests"},{default:o(()=>[ne]),_:1}),ie]),ae,ue,ce,le,de])]),_:1})}}};typeof i=="function"&&i(pe);export{pe as default,he as frontmatter};

package/dist/assets/teams.9ff14f8f.js

@@ -1 +0,0 @@
-import{a as s,o as d,b as c,w as a,g as e,e as i,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var n={};const h={class:"markdown-body"},m=e("blockquote",null,[e("p",null,"A Team is an organizational system that groups Accounts together as Team Members and provides consolidated billing on its nested Projects.")],-1),u=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#create-a-team"},"Create a Team")]),e("li",null,[e("a",{href:"#update-team-settings"},"Update Team Settings")]),e("li",null,[e("a",{href:"#view-team-activity"},"View Team Activity")]),e("li",null,[e("a",{href:"#view-billing-details"},"View Billing Details")]),e("li",null,[e("a",{href:"#manage-billing"},"Manage Billing")]),e("li",null,[e("a",{href:"#invite-team-members"},"Invite Team Members")]),e("li",null,[e("a",{href:"#manage-team-members"},"Manage Team Members")]),e("li",null,[e("a",{href:"#destroy-a-team"},"Destroy a Team")])])])],-1),p=e("p",null,"Teams within the Cloud Dashboard allow individuals to separate or consolidate Projects and payment methods, as well as manage Projects independently or with other Team Members.",-1),g=e("p",null,"For example, a company can use Teams to organize Projects by department, each with consolidated billing and scoped access. Similarly, agencies or freelancers with multiple customers can create a Team per client to limit their access and isolate billing. Teams are free, so create as many as you need to appropriately organize Team Members, Projects and payment methods.",-1),_=t("See the "),b=t("Overview"),y=t(" to learn how Accounts, Teams and Projects interrelate."),v=e("h2",{id:"create-a-team"},[t("Create a Team "),e("a",{class:"header-anchor",href:"#create-a-team"},"#")],-1),f=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/create-a-team-20220329A.webp",alt:"Create Team"})],-1),T=e("p",null,"To create a Team:",-1),w=e("ol",null,[e("li",null,[t("Open the Team Menu in the Dashboard Header and click "),e("strong",null,[t("\u201CCreate a Team "),e("span",{mi:"",icon:"",prmry:""},"add"),t("\u201D")]),t("."),e("br"),t(" The Create Team page will open.")]),e("li",null,[t("Enter a Team Name and Team Slug, then click "),e("strong",null,"\u201CSave\u201D"),t(".")])],-1),P=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Team Name and Team Slug"),e("p",null,[t("The Team Name is a text name assigned to a Team, used in the Cloud Dashboard. The Team slug lies within the full URL "),e("code",{class:""},"https://directus.cloud/TEAM-SLUG/projects"),t(". These are purely organizational, allowing you to easily remember the Team and link to specific Cloud Dashboards. They do not impact Cloud Projects or billing and can be "),e("a",{href:"#update-team-settings"},"updated at any time"),t(".")])],-1),A=e("h2",{id:"update-team-settings"},[t("Update Team Settings "),e("a",{class:"header-anchor",href:"#update-team-settings"},"#")],-1),N=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/managing-a-team-20220225A.webp",alt:"Managing a Team"})],-1),j=e("p",null,"To update Team Settings:",-1),M=e("ol",null,[e("li",null,"Open the Team Menu in the Dashboard Header and select the desired Team."),e("li",null,[t("Click "),e("strong",null,"\u201CSettings\u201D"),t(" to enter the Team Settings page.")]),e("li",null,[t("Toggle "),e("span",{mi:"",icon:"",prmry:""},"edit"),t(" to allow edits.")]),e("li",null,"Edit Team Name and Team Slug as desired."),e("li",null,[t("Click the "),e("strong",null,"\u201CSave\u201D"),t(" button.")])],-1),S=e("h2",{id:"view-team-activity"},[t("View Team Activity "),e("a",{class:"header-anchor",href:"#view-team-activity"},"#")],-1),k=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/view-team-activity-20220322A.webp",alt:"View Team Activity"})],-1),C=e("p",null,"The Team Activity Page displays billing information changes, created and destroyed Projects, Team Members added or removed, Team Name and Team Slug changes, and any other major Team-oriented activities. To view Team Activity:",-1),x=e("ol",null,[e("li",null,"Open the Team Menu in the Dashboard Header and select the desired Team."),e("li",null,[t("Click "),e("strong",null,"\u201CActivity\u201D"),t(".")])],-1),D=e("h2",{id:"view-billing-details"},[t("View Billing Details "),e("a",{class:"header-anchor",href:"#view-billing-details"},"#")],-1),B=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/view-billing-details-20220322A.webp",alt:"View Billing Details"})],-1),$=e("p",null,"Follow these steps to see billing details such as credit available to Team Projects, total active subscriptions and invoice receipts:",-1),I=e("ol",null,[e("li",null,"Open the Team Menu in the Dashboard Header and select the desired Team."),e("li",null,[t("Click "),e("strong",null,"\u201CBilling\u201D"),t(" to enter the Billing Details Page.")])],-1),V=e("h2",{id:"manage-billing"},[t("Manage Billing "),e("a",{class:"header-anchor",href:"#manage-billing"},"#")],-1),O=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/manage-billing-20220322A.webp",alt:"Manage Billing"})],-1),z=e("p",null,"Since our Community tier is completely free, and our Enterprise tier pricing is individually tailored based on customer needs, this section will focus on our pay-as-you-go Standard tier. Follow the steps below to change a default payment method, add or remove additional payment methods or change other billing details:",-1),H=e("ol",null,[e("li",null,"Open the Team Menu in the Dashboard Header and select the desired Team."),e("li",null,[t("Click "),e("strong",null,"\u201CBilling\u201D"),t(" to enter the Billing Details page.")]),e("li",null,[t("Click "),e("strong",null,"\u201CManage Billing\u201D"),t(" to enter the Stripe payments gateway.")]),e("li",null,"Adjust payment methods and details as needed."),e("li",null,[t("Click "),e("strong",null,"\u201CReturn to Directus Cloud\u201D"),t(".")])],-1),E=e("h3",{id:"team-billing"},[t("Team Billing "),e("a",{class:"header-anchor",href:"#team-billing"},"#")],-1),G=e("p",null,[t("Teams are free to create, and they give Team Members access to the same Projects, Project invoices and payment methods. Each Team has its own separate billing, and each Project within a Team is "),e("a",{href:"#how-bills-are-calculated"},"calculated"),t(" and "),e("a",{href:"#billing-cycles"},"invoiced separately every month"),t(".")],-1),F=e("p",null,"Team Members are SuperAdmins. As such, they have full access to manage billing information and payment methods, including information provided by other Team Members. Team Members should be highly trusted individuals.",-1),U=e("p",null,"All bills will first be invoiced to the default payment method. You may notice that it is possible to add additional payment methods, and it may be a good idea to do so, as keeping multiple payment methods on file provides a fail-safe to help make sure your Project stays running. In the event that there is an issue processing the default payment method, the other payment methods on file will be attempted. If the bill is not paid, the Nodes will be paused, halting web-traffic, until a successful payment is made.",-1),R=e("div",{class:"warning hint"},[e("p",null,[t("If the paused Project is never repaid, it will eventually be deleted along with all of its data and assets. For details on unpaid Projects and refunds, see "),e("a",{href:"https://directus.io/cloud-policies/",target:"_blank",rel:"noopener noreferrer"},"Cloud Policies")])],-1),Y=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Team Metered Usage"),e("p",null,[t("You may notice credit on top of the "),e("a",{href:"#view-billing-details"},"Billing Page"),t(". In the "),e("em",null,"rare event"),t(" your Team receives credit from the Directus Team, this credit balance will decrease the amount due on the next invoice(s) until all credit is used up. Then the default payment method will be used.")])],-1),L=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Stripe Payment"),e("p",null,"To handle billing, Directus Cloud uses Stripe, a secure, industry-leading, dynamic international billing service.")],-1),q=e("h3",{id:"billing-cycles"},[t("Billing Cycles "),e("a",{class:"header-anchor",href:"#billing-cycles"},"#")],-1),K=e("p",null,"Bills are invoiced on a calendar monthly basis, so each new billing period begins after exactly one month. When a Project is destroyed, the bill is processed immediately. As mentioned in the previous section, bills are invoiced per-Project; so if a Team has 4 Standard Projects, it will be charged 4 times each month.",-1),W=e("h3",{id:"how-bills-are-calculated"},[t("How Bills Are Calculated "),e("a",{class:"header-anchor",href:"#how-bills-are-calculated"},"#")],-1),J=t("Project billing is calculated based on the total number of hours that Active and Standby Nodes are used during the billing period. Once the "),Q=t("Node Type"),X=t(" is selected, the associated hourly rate will apply to both Active and Standby Nodes."),Z=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Node Pricing"),e("p",null,[e("strong",null,"General Purpose:"),t(" $0.03424657534 / hour"),e("br"),e("strong",null,"Performance Tier:"),t(" $0.06849315068 / hour")])],-1),ee=e("p",null,[t("This means the monthly prices given for Active Nodes, "),e("em",null,"$25/month for General Purpose and $50/month for Performance tier"),t(", are actually estimates based on the cost per hour times the average length of a month (730 hours). So, the pricing shown for one Active General Purpose Node is "),e("code",{class:""},"$0.03424657534 x 730hrs = $25"),t(", however the actual bill will vary slightly each month.")],-1),te=e("p",null,[t("Keep in mind that a Standard Project\u2019s Nodes can be reconfigured at any time. You can upgrade and downgrade Node Types add and remove Nodes, or destroy your Project as you please. In the end, "),e("em",null,"you simply pay for the actual Node-hours used by your Project"),t(".")],-1),ae=e("p",null,"The following four examples demonstrate this billing system:",-1),oe=e("p",null,[e("strong",null,"Hourly Pricing"),e("br"),t(" A Project is configured to use General Purpose Nodes, with one Active Node and zero Standby Nodes. The Project runs for 3 days and 3.5 hours (75.5 hours total, rounded to 76 hours) and is then destroyed, costing "),e("code",{class:""},"1 Node x $0.03424657534/hr x 76 hrs = $2.60"),t(".")],-1),ie=e("p",null,[t("The bill will be "),e("code",{class:""},"$2.60"),t(" plus Tax/VAT, charged at Project destruction.")],-1),se=e("p",null,[e("strong",null,"Active Nodes"),e("br"),t(" A Project is configured to use Performance Tier Nodes, with two Active Nodes and zero Standby Nodes. The Project runs the full month (730 hours). For this billing cycle, the two Active Nodes will cost "),e("code",{class:""},"2 Nodes x $0.06849315068/hr x 730 hrs = $100"),t(".")],-1),ne=e("p",null,[t("The monthly bill will be "),e("code",{class:""},"$100"),t(" plus Tax/VAT.")],-1),le=e("p",null,[e("strong",null,"Overages on Standby Nodes"),e("br"),t(" A Project is configured to use General Purpose Nodes, with three Active Nodes and two Standby Nodes. The Project runs the full month (730 hours). There are two traffic spikes. The first spike is smaller and only activates one Standby Node for 6.5 hours. The second spike is larger and activates the first Node from 4pm to 12am (eight hours), and the second Node from 6pm to 11pm (five hours), for a total of "),e("code",{class:""},"8 + 5 = 13"),t(" hours. Between both spikes, Standby Nodes run for a total of 19.5 hours (rounds to 20 hrs). Active Nodes will cost "),e("code",{class:""},"3 Nodes x $0.03424657534/hr x 730 hrs = $75.00"),t(" plus Standby Node overages "),e("code",{class:""},"20 Node-hrs x $0.03424657534/hr = $0.68"),t(".")],-1),re=e("p",null,[t("The monthly bill will be "),e("code",{class:""},"$75.68"),t(" plus VAT/Tax.")],-1),de=e("p",null,[e("strong",null,"Pro-rated Changes"),e("br"),t(" A Project begins the billing cycle configured to use General Purpose Nodes, one Active and zero Standby. A massive traffic spike is expected from marketing activities this month and 200 hours into the month, the Project is reconfigured. The Node Type is now Performance Tier, using two Active Nodes and five Standby Nodes. In the end, the marketing event was a failure, and traffic was just slightly above average. The five Standby Nodes were not needed and never activated. The first 200 hours cost "),e("code",{class:""},"(1 General Purpose Node x $0.03424657534/hr x 200hrs) = $6.85"),t(". The other 530 hours cost "),e("code",{class:""},"(2 Performance Nodes x $0.06849315068/hr x 530hrs) = 72.60"),t(".")],-1),ce=e("p",null,[t("The monthly bill will be "),e("code",{class:""},"$79.45"),t(" plus VAT/Tax.")],-1),he=e("h3",{id:"optimize-node-configuration"},[t("Optimize Node Configuration "),e("a",{class:"header-anchor",href:"#optimize-node-configuration"},"#")],-1),me=t("Remember: "),ue=e("em",null,"you are never locked-in to a specific Node configuration",-1),pe=t(". As your needs change for a Project, you can reconfigure the Node Type as well as the number of Active and Standby Nodes at any time. To that end, you may want to monitor overall system traffic to make informed decisions on Node reconfiguration. The "),ge=t("Project Monitor Page"),_e=t(" provides performance analytics, which can be used to help identify optimal Node configurations for your Project."),be=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Standby Nodes"),e("p",null,"For production-ready Projects of any kind, it is probably a good idea to have one or more Standby Nodes. These do not activate, and you do not pay for their usage until they are needed. If you have no Standby Nodes, you many not have the processing power to handle traffic spikes, which can crash your Nodes!")],-1),ye=e("h2",{id:"invite-team-members"},[t("Invite Team Members "),e("a",{class:"header-anchor",href:"#invite-team-members"},"#")],-1),ve=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/inviting-a-team-member-20220225A.webp",alt:"Inviting a Team Member"})],-1),fe=e("p",null,"All Team Members can invite new Members via email. Each invitee will be emailed a link to accept the invitation and join the Team. To invite Team Members:",-1),Te=e("ol",null,[e("li",null,"Open the Team Menu in the Dashboard Header and select the desired Team."),e("li",null,[t("Click "),e("strong",null,"\u201CMembers\u201D"),t(" to enter the Members Page.")]),e("li",null,"Scroll down to the Invite New Members section."),e("li",null,"Enter one or more email(s), comma separated."),e("li",null,[t("Click "),e("strong",null,"\u201CSend Invites.\u201D")])],-1),we={class:"tip hint"},Pe=t("Clicking the emailed invitation link does not automatically create an Account for you. Invitees will need to "),Ae=t("create an Account"),Ne=t(" before accepting an invitation to join a Team."),je=e("h2",{id:"manage-team-members"},[t("Manage Team Members "),e("a",{class:"header-anchor",href:"#manage-team-members"},"#")],-1),Me=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/leaving-a-team-20220225A.webp",alt:"Removing a Team member"})],-1),Se=e("p",null,"All Team Members have the ability to remove other Members or invites from a Team. To remove Members or leave a Team yourself:",-1),ke=e("ol",null,[e("li",null,"Open the Team Menu in the Dashboard Header and select the desired Team."),e("li",null,[t("Click "),e("strong",null,"\u201CMembers\u201D"),t(" to enter the Members Page.")]),e("li",null,[t("Click the "),e("span",{mi:"",icon:""},"exit_to_app"),t(" or "),e("span",{mi:"",icon:""},"close"),t(" button on the desired Member.")]),e("li",null,[t("Click "),e("strong",null,"\u201CConfirm\u201D"),t(".")])],-1),Ce=e("div",{class:"warning hint"},[e("p",null,"If an Account leaves or is removed from a Team, it will be fully \u201Clocked out\u201D of the Team until re-invited by another Member.")],-1),xe=e("h2",{id:"destroy-a-team"},[t("Destroy a Team "),e("a",{class:"header-anchor",href:"#destroy-a-team"},"#")],-1),De=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/cloud/teams/teams-20220322A/destroy-a-team-20220225A.webp",alt:"Destroying a Team"})],-1),Be=e("p",null,"To destroy a Team:",-1),$e=e("ol",null,[e("li",null,"Open the Team Menu in the Dashboard Header and select the desired Team."),e("li",null,[t("Click "),e("strong",null,"\u201CSettings\u201D"),t(" to enter the Team Settings Page.")]),e("li",null,"Scroll down to the \u201CDestroy this Team\u201D section."),e("li",null,[t("Toggle "),e("span",{mi:"",icon:"",dngr:""},"local_fire_department"),t(" and an input box will appear.")]),e("li",null,"Type the Team Name into the input box."),e("li",null,[t("Click "),e("strong",null,"\u201CDestroy Team\u201D"),t(".")])],-1),Ie=e("div",{class:"danger hint"},[e("p",null,"Destroying a Team completely removes all its data from Directus Cloud. This action is permanent and irreversible. Proceed with caution!")],-1),Ve=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Teams with Active Projects"),e("p",null,"To delete a Team, you must first delete any active Projects within it.")],-1),Oe={title:"Cloud Teams",modularExtension:!1},ze={name:"teams",setup(He,{expose:l}){return l({frontmatter:{title:"Cloud Teams",modularExtension:!1}}),(Ee,Ge)=>{const o=s("router-link"),r=s("docswrapper");return d(),c(r,{frontmatter:Oe},{default:a(()=>[e("div",h,[m,u,p,g,e("p",null,[_,i(o,{to:"/docs/cloud/overview"},{default:a(()=>[b]),_:1}),y]),v,f,T,w,P,A,N,j,M,S,k,C,x,D,B,$,I,V,O,z,H,E,G,F,U,R,Y,L,q,K,W,e("p",null,[J,i(o,{to:"/docs/cloud/glossary/#nodes"},{default:a(()=>[Q]),_:1}),X]),Z,ee,te,ae,oe,ie,se,ne,le,re,de,ce,he,e("p",null,[me,ue,pe,i(o,{to:"/docs/cloud/projects/#monitor-a-project"},{default:a(()=>[ge]),_:1}),_e]),be,ye,ve,fe,Te,e("div",we,[e("p",null,[Pe,i(o,{to:"/docs/cloud/accounts/#create-account-and-login"},{default:a(()=>[Ae]),_:1}),Ne])]),je,Me,Se,ke,Ce,xe,De,Be,$e,Ie,Ve])]),_:1})}}};typeof n=="function"&&n(ze);export{ze as default,Oe as frontmatter};

package/dist/assets/themes.df7ec485.js

@@ -1,5 +0,0 @@
-import{a as l,o as c,b as h,w as s,g as e,e as n,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var r={};const d={class:"markdown-body"},u=e("strong",null,"Form Follows Function",-1),p=t(" is the guiding design principle of Directus. The minimal UI allows the platform to be easily tailored to your brand. "),m=t("Learn more about the App"),_=t("."),g=e("h2",{id:"app-themes"},[t("App Themes "),e("a",{class:"header-anchor",href:"#app-themes"},"#")],-1),y=e("p",null,"The Directus App has been developed with customization and extensibility in mind. Colors and styles referenced within the codebase all use CSS variables, and therefore it is easy to make comprehensive changes to the App styling.",-1),b=e("p",null,"There are two themes included by default: Light and Dark. You can duplicate these files to create your own themes \u2014 with no limit to customization. Below are several code resources for key SCSS files.",-1),f=e("ul",null,[e("li",null,[e("strong",null,"Themes"),t(" \u2014 See the "),e("a",{href:"https://github.com/directus/directus/blob/main/app/src/styles/themes/_light.scss",target:"_blank",rel:"noopener noreferrer"},"Light Theme"),t(" or "),e("a",{href:"https://github.com/directus/directus/blob/main/app/src/styles/themes/_dark.scss",target:"_blank",rel:"noopener noreferrer"},"Dark Theme")]),e("li",null,[e("strong",null,"Typography"),t(" \u2014 See the "),e("a",{href:"https://github.com/directus/directus/blob/main/app/src/styles/_type-styles.scss",target:"_blank",rel:"noopener noreferrer"},"Fonts"),t(" and "),e("a",{href:"https://github.com/directus/directus/blob/main/app/src/styles/mixins/type-styles.scss",target:"_blank",rel:"noopener noreferrer"},"Type Styles")]),e("li",null,[e("strong",null,"Variables"),t(" \u2014 See the "),e("a",{href:"https://github.com/directus/directus/blob/main/app/src/styles/_variables.scss",target:"_blank",rel:"noopener noreferrer"},"Global Variables")])],-1),S=e("h2",{id:"project-styling"},[t("Project Styling "),e("a",{class:"header-anchor",href:"#project-styling"},"#")],-1),v=t("See "),w=t("Adjusting Project Settings"),k=e("h2",{id:"custom-css"},[t("Custom CSS "),e("a",{class:"header-anchor",href:"#custom-css"},"#")],-1),C=e("p",null,"You can also override any core CSS directly within the App through Project Settings. This makes it easy to edit the CSS variables listed in the themes above.",-1),T=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,"Settings Module > Project Settings")]),e("li",null,[t("Scroll to the "),e("strong",null,"Custom CSS"),t(" field")]),e("li",null,[t("Enter any "),e("strong",null,"valid CSS")]),e("li",null,[t("Click the "),e("strong",null,"Save"),t(" action button in the header")])],-1),A=e("h3",{id:"example"},[t("Example "),e("a",{class:"header-anchor",href:"#example"},"#")],-1),x=e("p",null,[t("Since App styles are inserted/removed whenever a component is rendered, you\u2019ll need to be aware of CSS priority. Using "),e("code",{class:""},":root"),t(" or "),e("code",{class:""},"body"),t(" likely isn\u2019t scoped enough, you\u2019ll need to define a more specific scope, such as "),e("code",{class:""},"#app"),t(", or use "),e("code",{class:""},"!important"),t(".")],-1),j=e("pre",null,[e("code",{class:"language-css"},[e("span",{class:"hljs-selector-tag"},"body"),t(` {
-	--family-sans-serif: `),e("span",{class:"hljs-string"},"'Comic Sans MS'"),t(`;
-	--primary: MediumSlateBlue `),e("span",{class:"hljs-meta"},"!important"),t(`;
-}
-`)])],-1),B=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Action Styling"),e("p",null,[t("The "),e("code",{class:""},"--primary"),t(" variable (and its shades) control call-to-actions and all other elements within the App using the \u201CDirectus Green\u201D. While it may be tempting to override this variable with your brand\u2019s color, please first review the following warnings:")]),e("ul",null,[e("li",null,"Avoid using yellow, orange, or red hues that give a sense of \u201Cdanger\u201D"),e("li",null,"Avoid low-contrast colors like yellows, grays, etc, that might not be easily visible"),e("li",null,"Avoid low-saturation colors like black, which might not properly highlight CTAs")])],-1),D={title:"Themes & Styling",modularExtension:!1},V={name:"themes",setup(E,{expose:i}){return i({frontmatter:{title:"Themes & Styling",modularExtension:!1}}),(F,N)=>{const o=l("router-link"),a=l("docswrapper");return c(),h(a,{frontmatter:D},{default:s(()=>[e("div",d,[e("blockquote",null,[e("p",null,[u,p,n(o,{to:"/docs/app/overview/"},{default:s(()=>[m]),_:1}),_])]),g,y,b,f,S,e("p",null,[v,n(o,{to:"/docs/configuration/project-settings/"},{default:s(()=>[w]),_:1})]),k,C,T,A,x,j,B])]),_:1})}}};typeof r=="function"&&r(V);export{V as default,D as frontmatter};

package/dist/assets/translations.5191ab7c.js

@@ -1 +0,0 @@
-import{a as o,o as i,b as l,w as s,g as e,B as a}from"./runtime-core.esm-bundler.b1f35d24.js";var t={};const d=e("div",{class:"markdown-body"},[e("blockquote",null,[e("p",null,"The platform supports internationalization across the entire App. Many languages are currently supported, with more being added all the time. Anyone can add or refine any languages through the integration with CrowdIn.")]),e("h2",{id:"crowdin"},[a("Crowdin "),e("a",{class:"header-anchor",href:"#crowdin"},"#")]),e("p",null,[a("Our "),e("a",{href:"https://locales.directus.io/",target:"_blank",rel:"noopener noreferrer"},"Crowdin"),a(" page provides an external interface for managing all of the different language translations for the App. You can update and extend existing languages, or request a new language be added.")]),e("h2",{id:"working-with-existing-languages"},[a("Working with Existing Languages "),e("a",{class:"header-anchor",href:"#working-with-existing-languages"},"#")]),e("ol",null,[e("li",null,[a("Navigate to "),e("a",{href:"https://locales.directus.io/",target:"_blank",rel:"noopener noreferrer"},"Crowdin")]),e("li",null,"Click on the desired language"),e("li",null,[a("Click "),e("strong",null,"Translate All"),a(" in the header")]),e("li",null,"Log in to Crowdin, or register an account as needed"),e("li",null,"Select a source string using the left-hand navigation"),e("li",null,"Add or edit the translation in the lower text area"),e("li",null,"Click \u201CSAVE\u201D below the translation")]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Character Length"),e("p",null,"It is important to keep the character length approximately the same as the source string (English) to avoid truncation or a drastically different wrapping. For example, some text translations will go in a smaller button with limited space for text and no ability to wrap.")]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Suggestions"),e("p",null,"Crowdin provides useful TM and MT suggestions, however you should always confirm that these are context appropriate, as they may not accurately map to the source meaning.")]),e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Request Additional Context"),e("p",null,"If you feel you do not have enough information on how this string is used, you can always ask for additional context using the \u201CComment\u201D section.")]),e("h2",{id:"requesting-a-new-language"},[a("Requesting a New Language "),e("a",{class:"header-anchor",href:"#requesting-a-new-language"},"#")]),e("p",null,[a("To add a new language to the Crowdin service, you can make a request via Crowdin\u2019s "),e("strong",null,"Discussions"),a(" section, or reach out to a Core Team member via "),e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord"),a(".")])],-1),u={title:"App Translations",modularExtension:!1},c={name:"translations",setup(g,{expose:n}){return n({frontmatter:{title:"App Translations",modularExtension:!1}}),(h,p)=>{const r=o("docswrapper");return i(),l(r,{frontmatter:u},{default:s(()=>[d]),_:1})}}};typeof t=="function"&&t(c);export{c as default,u as frontmatter};

package/dist/assets/triggers.1f1ace5f.js

@@ -1 +0,0 @@
-import{a as l,o as h,b as c,w as t,g as o,e as s,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var r={};const u={class:"markdown-body"},d=o("blockquote",null,[o("p",null,"Each Flow is triggered by some internal or external event.")],-1),g=o("p",null,[o("div",{class:"table-of-contents"},[o("ul",null,[o("li",null,[o("a",{href:"#event-hook"},"Event Hook")]),o("li",null,[o("a",{href:"#webhook"},"Webhook")]),o("li",null,[o("a",{href:"#schedule"},"Schedule")]),o("li",null,[o("a",{href:"#another-flow"},"Another Flow")]),o("li",null,[o("a",{href:"#manual"},"Manual")])])])],-1),_=o("h2",{id:"event-hook"},[e("Event Hook "),o("a",{class:"header-anchor",href:"#event-hook"},"#")],-1),p=o("p",null,[o("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/triggers/triggers-20220603A/event-hook-20220602A.webp",alt:"Event Hooks"})],-1),w=e("Event Hooks are triggered by platform or data events. The logic is based on "),f=e("Custom API Hooks"),m=e("."),b=o("ul",null,[o("li",null,[o("strong",null,"Type"),e(" \u2014 Choose the type of Event Hook: "),o("ul",null,[o("li",null,[o("strong",null,"Filter (Blocking)"),e(" \u2014 Fires \u201Cblocking\u201D right before the database transaction is committed, allowing you to tweak the payload or even outright prevent completion.")]),o("li",null,[o("strong",null,"Action (Non-Blocking)"),e(" \u2014 Does not block anything. Therefore, this is mostly useful for doing things in response to an event, without slowing down the API.")])])]),o("li",null,[o("strong",null,"Scope"),e(" \u2014 Set the specific events which trip this Trigger.")]),o("li",null,[o("strong",null,"Collections"),e(" \u2014 Set the Collections which trip this Trigger.")]),o("li",null,[o("strong",null,"Response Body"),e(" \u2014 Send Data of last Operation, all Flow Object data, or Flow key.")])],-1),k=o("h2",{id:"webhook"},[e("Webhook "),o("a",{class:"header-anchor",href:"#webhook"},"#")],-1),v=o("p",null,[o("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/triggers/triggers-20220603A/webhook-20220602A.webp",alt:"Webhook"})],-1),y=o("p",null,[e("Triggered by an incoming HTTP request to: "),o("code",{class:""},"/flows/trigger/:this-webhook-trigger-id"),e(".")],-1),T=o("ul",null,[o("li",null,[o("strong",null,"Method"),e(" \u2014 Choose to make a GET, POST, PATCH, DELETE or other request from the dropdown.")]),o("li",null,[o("strong",null,"Asynchronous"),e(" \u2014 Toggle whether or not the Trigger responds asynchronously.")]),o("li",null,[o("strong",null,"Response Body"),e(" \u2014 Choose to send Data of last Operation, all Flow Object data, or some other key from the Flow object.")])],-1),A=o("h2",{id:"schedule"},[e("Schedule "),o("a",{class:"header-anchor",href:"#schedule"},"#")],-1),F=o("p",null,[o("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/triggers/triggers-20220603A/cron-20220602A.webp",alt:"Schedule a Cron Job"})],-1),C=o("p",null,"This Trigger allows you to create Data at scheduled intervals, via 6-point cron job syntax.",-1),x=o("ul",null,[o("li",null,[o("strong",null,"Interval"),e(" \u2014 Set the cron job interval to schedule when the Flow triggers.")])],-1),E=o("h2",{id:"another-flow"},[e("Another Flow "),o("a",{class:"header-anchor",href:"#another-flow"},"#")],-1),B=o("p",null,[o("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/triggers/triggers-20220603A/another-flow-20220602A.webp",alt:"Another Flow"})],-1),S=e("This Trigger executes a Flow via the "),P=e("Trigger Flow"),H=e(" Operation, allowing you to chain Flows together."),O=o("ul",null,[o("li",null,[o("strong",null,"Response Body"),e(" \u2014 Select data to return in the response to Trigger Flow.")])],-1),j=o("h2",{id:"manual"},[e("Manual "),o("a",{class:"header-anchor",href:"#manual"},"#")],-1),D=o("p",null,[o("img",{src:"https://cdn.directus.io/docs/v9/configuration/flows/triggers/triggers-20220603A/manual-20220602A.webp",alt:"Manual"})],-1),I=o("p",null,[e("Triggers on manual click of a button. Based on your "),o("strong",null,"Location"),e(" configuration, a "),o("strong",null,"Flows"),e(" menu will appear in the Sidebar of the Collection Page and/or Item Page. This will contain a button which starts the Flow when clicked.")],-1),M=o("ul",null,[o("li",null,[o("strong",null,"Collections"),e(" \u2014 Choose the Collection(s) to add in this Button on to.")]),o("li",null,[o("strong",null,"Location"),e(" \u2014 Choose to add the button into the Item Page, Collection Page, or both.")]),o("li",null,[o("strong",null,"Asynchronous"),e(" \u2014 Toggle whether or not the Flow executes asynchronously.")])],-1),N={title:"Triggers",modularExtension:!1},q={name:"triggers",setup(L,{expose:i}){return i({frontmatter:{title:"Triggers",modularExtension:!1}}),(R,V)=>{const n=l("router-link"),a=l("docswrapper");return h(),c(a,{frontmatter:N},{default:t(()=>[o("div",u,[d,g,_,p,o("p",null,[w,s(n,{to:"/docs/extensions/hooks/"},{default:t(()=>[f]),_:1}),m]),b,k,v,y,T,A,F,C,x,E,B,o("p",null,[S,s(n,{to:"/docs/configuration/flows/operations/#another-flow"},{default:t(()=>[P]),_:1}),H]),O,j,D,I,M])]),_:1})}}};typeof r=="function"&&r(q);export{q as default,N as frontmatter};

package/dist/assets/ubuntu.f4c21886.js

@@ -1,11 +0,0 @@
-import{a as s,o as r,b as c,w as i,g as t,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var n={};const u=t("div",{class:"markdown-body"},[t("p",null,[e("DigitalOcean provides a great tutorial on how to run a Node.js based app in production. See "),t("a",{href:"https://www.digitalocean.com/community/tutorials/how-to-set-up-a-node-js-application-for-production-on-ubuntu-20-04",target:"_blank",rel:"noopener noreferrer"},"How To Set Up a Node.js Application for Production on Ubuntu 20.04"),e(".")]),t("p",null,[e("Instead of starting the app using "),t("code",{class:""},"pm2 start hello.js"),e(", add the line "),t("code",{class:""},'"start": "directus start"'),e(" in the \u201Cscripts\u201D part of the "),t("em",null,"package.json"),e(" and start Directus using the command "),t("code",{class:""},"pm2 start npm -- start")]),t("p",null,[t("em",null,"Example:")]),t("pre",null,[t("code",{class:"language-json"},`{
-  "name": "directus",
-  "version": "1.0.0",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \\"Error: no test specified\\" && exit 1",
-    "start": "directus start"
-  },
-...
-}
-`)])],-1),l={title:"Ubuntu",modularExtension:!1},p={name:"ubuntu",setup(d,{expose:o}){return o({frontmatter:{title:"Ubuntu",modularExtension:!1}}),(m,f)=>{const a=s("docswrapper");return r(),c(a,{frontmatter:l},{default:i(()=>[u]),_:1})}}};typeof n=="function"&&n(p);export{p as default,l as frontmatter};