@directus/app 9.14.5 → 9.16.0

package/dist/assets/collections.11aae4a8.js

@@ -1,106 +0,0 @@
-import{a as o,o as r,b as h,w as l,g as s,e as n,B as t}from"./runtime-core.esm-bundler.e3d5f5b7.js";const d={class:"markdown-body"},p={class:"two-up"},u={class:"left"},_=t("Collections are the individual collections of items, similar to tables in a database. Changes to collections will alter the schema of the database. "),j=t("Learn more about Collections"),g=t("."),m=s("div",{class:"right"},[s("p",null,[s("div",{class:"table-of-contents"},[s("ul",null,[s("li",null,[s("a",{href:"#the-collection-object"},"The Collection Object ")]),s("li",null,[s("a",{href:"#list-collections"},"List Collections ")]),s("li",null,[s("a",{href:"#retrieve-a-collection"},"Retrieve a Collection ")]),s("li",null,[s("a",{href:"#create-a-collection"},"Create a Collection ")]),s("li",null,[s("a",{href:"#update-a-collection"},"Update a Collection ")]),s("li",null,[s("a",{href:"#delete-a-collection"},"Delete a Collection ")])])])])],-1),f=s("hr",null,null,-1),b=s("h2",{id:"the-collection-object",tabindex:"-1"},[t("The Collection Object "),s("a",{class:"header-anchor",href:"#the-collection-object"},"#")],-1),y={class:"two-up"},v={class:"left"},x=s("div",{class:"definitions"},[s("p",null,[s("code",null,"collection"),t(),s("strong",null,"string"),s("br"),t(" Name of the collection. This matches the table name in the database.")])],-1),w=s("h4",{id:"meta",tabindex:"-1"},[t("Meta "),s("a",{class:"header-anchor",href:"#meta"},"#")],-1),q=s("p",null,"Directus metadata, primarily used in the Admin App.",-1),T={class:"definitions"},A=s("p",null,[s("code",null,"collection"),t(),s("strong",null,"string"),s("br"),t(" Name of the collection. This matches the table name in the database.")],-1),k=s("p",null,[s("code",null,"icon"),t(),s("strong",null,"string"),s("br"),t(" Icon displayed in the Admin App when working with this collection.")],-1),C=s("p",null,[s("code",null,"note"),t(),s("strong",null,"string"),s("br"),t(" Short description displayed in the Admin App.")],-1),E=s("p",null,[s("code",null,"display_template"),t(),s("strong",null,"string"),s("br"),t(" How items in this collection should be displayed when viewed relationally in the Admin App.")],-1),S=s("p",null,[s("code",null,"hidden"),t(),s("strong",null,"boolean"),s("br"),t(" Whether or not this collection is hidden in the Admin App.")],-1),P=s("p",null,[s("code",null,"singleton"),t(),s("strong",null,"boolean"),s("br"),t(" Whether or not this collection is treated as a singleton.")],-1),R=s("p",null,[s("code",null,"translations"),t(),s("strong",null,"array"),s("br"),t(" How this collection\u2019s name is displayed in the different languages in the Admin App.")],-1),L=s("p",null,[s("code",null,"archive_field"),t(),s("strong",null,"string"),s("br"),t(" What field in the collection holds the archived state.")],-1),O=s("p",null,[s("code",null,"archive_value"),t(),s("strong",null,"string"),s("br"),t(" What value the archive field should be set to when archiving an item.")],-1),Q=s("p",null,[s("code",null,"unarchive_value"),t(),s("strong",null,"string"),s("br"),t(" What value the archive field should be set to when unarchiving an item.")],-1),W=s("p",null,[s("code",null,"archive_app_filter"),t(),s("strong",null,"boolean"),s("br"),t(" Whether or not the Admin App should allow the user to view archived items.")],-1),B=s("p",null,[s("code",null,"sort_field"),t(),s("strong",null,"boolean"),s("br"),t(" What field holds the sort value on the collection. The Admin App uses this to allow drag-and-drop manual sorting.")],-1),D=s("code",null,"accountability",-1),G=t(),H=s("strong",null,"string",-1),I=s("br",null,null,-1),N=t(" What data is tracked. One of "),M=s("code",null,"all",-1),U=t(", "),V=s("code",null,"activity",-1),Y=t(". See "),z=t("Accountability"),F=t(" for more information."),J=s("code",null,"item_duplication_fields",-1),K=t(),X=s("strong",null,"array",-1),Z=s("br",null,null,-1),$=t(" What fields are duplicated during \u201CSave as copy\u201D action of an item in this collection. See "),ss=t("Duplication"),ts=t(" for more information."),ls=s("code",null,"group",-1),es=t(),ns=s("strong",null,"string",-1),as=s("br",null,null,-1),os=t(" The name of the parent collection. This is used in "),cs=t("grouping/nesting of collections"),is=t("."),rs=s("code",null,"sort",-1),hs=t(),ds=s("strong",null,"number",-1),ps=s("br",null,null,-1),us=t(" What sort order of the collection relative to other collections of the same level. This is used in "),_s=t("sorting of collections"),js=t("."),gs=s("p",null,[s("code",null,"collapse"),t(),s("strong",null,"string"),s("br"),t(" What is the default behavior of this collection or \u201Cfolder\u201D collection when it has nested collections. One of "),s("code",null,"open"),t(", "),s("code",null,"closed"),t(", "),s("code",null,"locked"),t(".")],-1),ms=s("h4",{id:"schema",tabindex:"-1"},[t("Schema "),s("a",{class:"header-anchor",href:"#schema"},"#")],-1),fs=s("p",null,"\u201CRaw\u201D database information. Based on the database vendor used, different information might be returned. The following are available for all drivers.",-1),bs=s("div",{class:"definitions"},[s("p",null,[s("code",null,"name"),t(),s("strong",null,"string"),s("br"),t(" The table name.")]),s("p",null,[s("code",null,"comment"),t(),s("strong",null,"string"),s("br"),t(" The table comment.")])],-1),ys={class:"tip hint"},vs=t("\u201Cfolder\u201D collections do not hold any data"),xs=t(", hence their schema would be "),ws=s("code",null,"null",-1),qs=t("."),Ts=s("div",{class:"right"},[s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),t(`
-	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-attr"},'"meta"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-punctuation"},"{"),t(`
-		`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"article"'),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"note"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"Blog posts"'),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"display_template"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"{{ title }}"'),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"hidden"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"singleton"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"false")]),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"translations"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-punctuation"},"["),t(`
-			`),s("span",{class:"hljs-punctuation"},"{"),t(`
-				`),s("span",{class:"hljs-attr"},'"language"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"en-US"'),s("span",{class:"hljs-punctuation"},","),t(`
-				`),s("span",{class:"hljs-attr"},'"translation"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"Articles"'),t(`
-			`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),t(`
-			`),s("span",{class:"hljs-punctuation"},"{"),t(`
-				`),s("span",{class:"hljs-attr"},'"language"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"nl-NL"'),s("span",{class:"hljs-punctuation"},","),t(`
-				`),s("span",{class:"hljs-attr"},'"translation"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"Artikelen"'),t(`
-			`),s("span",{class:"hljs-punctuation"},"}"),t(`
-		`),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"archive_field"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"status"'),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"archive_value"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"archived"'),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"unarchive_value"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"draft"'),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"archive_app_filter"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"sort_field"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"sort"'),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"item_duplication_fields"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"sort"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-number"},"1"),t(`
-	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-attr"},'"schema"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-punctuation"},"{"),t(`
-		`),s("span",{class:"hljs-attr"},'"name"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"pages"'),s("span",{class:"hljs-punctuation"},","),t(`
-		`),s("span",{class:"hljs-attr"},'"comment"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),t(`
-	`),s("span",{class:"hljs-punctuation"},"}"),t(`
-`),s("span",{class:"hljs-punctuation"},"}"),t(`
-`)])])],-1),As=s("hr",null,null,-1),ks=s("h2",{id:"list-collections",tabindex:"-1"},[t("List Collections "),s("a",{class:"header-anchor",href:"#list-collections"},"#")],-1),Cs=s("p",null,"List the available collections.",-1),Es={class:"two-up"},Ss=s("div",{class:"left"},[s("h3",{id:"query-parameters",tabindex:"-1"},[t("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters"},"#")]),s("p",null,"This endpoint doesn\u2019t currently support any query parameters."),s("h3",{id:"returns",tabindex:"-1"},[t("Returns "),s("a",{class:"header-anchor",href:"#returns"},"#")]),s("p",null,[t("An array of "),s("a",{href:"#the-collection-object"},"collection objects"),t(".")])],-1),Ps={class:"right"},Rs=s("h3",{id:"rest-api",tabindex:"-1"},[t("REST API "),s("a",{class:"header-anchor",href:"#rest-api"},"#")],-1),Ls=s("pre",null,[s("code",null,`GET /collections
-SEARCH /collections
-`)],-1),Os=t("Learn more about SEARCH ->"),Qs=s("h3",{id:"graphql",tabindex:"-1"},[t("GraphQL "),s("a",{class:"header-anchor",href:"#graphql"},"#")],-1),Ws=s("pre",null,[s("code",null,`POST /graphql/system
-`)],-1),Bs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),t(` {
-	collections: [directus_collections]
-}
-`)])],-1),Ds=s("h5",{id:"example",tabindex:"-1"},[t("Example "),s("a",{class:"header-anchor",href:"#example"},"#")],-1),Gs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),t(` {
-	collections {
-		`),s("span",{class:"hljs-keyword"},"..."),t(`
-	}
-}
-`)])],-1),Hs=s("hr",null,null,-1),Is=s("h2",{id:"retrieve-a-collection",tabindex:"-1"},[t("Retrieve a Collection "),s("a",{class:"header-anchor",href:"#retrieve-a-collection"},"#")],-1),Ns=s("p",null,"Retrieve a single collection by table name.",-1),Ms=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"query-parameters-1",tabindex:"-1"},[t("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-1"},"#")]),s("p",null,"This endpoint doesn\u2019t currently support any query parameters."),s("h3",{id:"returns-1",tabindex:"-1"},[t("Returns "),s("a",{class:"header-anchor",href:"#returns-1"},"#")]),s("p",null,[t("A "),s("a",{href:"#the-collection-object"},"collection object"),t(".")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-1",tabindex:"-1"},[t("REST API "),s("a",{class:"header-anchor",href:"#rest-api-1"},"#")]),s("pre",null,[s("code",null,`GET /collections/:collection
-`)]),s("h5",{id:"example-1",tabindex:"-1"},[t("Example "),s("a",{class:"header-anchor",href:"#example-1"},"#")]),s("pre",null,[s("code",null,`GET /collections/articles
-`)]),s("h3",{id:"graphql-1",tabindex:"-1"},[t("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-1"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),t(` {
-	collections_by_name(name:`),s("span",{class:"hljs-type"}," String"),t(`!): directus_collections
-}
-`)])]),s("h5",{id:"example-2",tabindex:"-1"},[t("Example "),s("a",{class:"header-anchor",href:"#example-2"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),t(` {
-	collections_by_name(name: `),s("span",{class:"hljs-string"},'"articles"'),t(`) {
-		`),s("span",{class:"hljs-keyword"},"..."),t(`
-	}
-}
-`)])])])],-1),Us=s("hr",null,null,-1),Vs=s("h2",{id:"create-a-collection",tabindex:"-1"},[t("Create a Collection "),s("a",{class:"header-anchor",href:"#create-a-collection"},"#")],-1),Ys=s("p",null,"Create a new Collection. This will create a new table in the database as well.",-1),zs={class:"two-up"},Fs={class:"left"},Js=s("h3",{id:"query-parameters-2",tabindex:"-1"},[t("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-2"},"#")],-1),Ks=s("p",null,"This endpoint doesn\u2019t currently support any query parameters.",-1),Xs=s("h3",{id:"request-body",tabindex:"-1"},[t("Request Body "),s("a",{class:"header-anchor",href:"#request-body"},"#")],-1),Zs=s("p",null,[t("The "),s("code",null,"collection"),t(" property is required, all other properties of the "),s("a",{href:"#the-collection-object"},"collection object"),t(" are optional.")],-1),$s=t("You are able to provide an array of "),st=s("code",null,"fields",-1),tt=t(" to be created during the creation of the collection. See the "),lt=t("fields object"),et=t(" for more information on what properties are available in a field."),nt=s("h3",{id:"returns-2",tabindex:"-1"},[t("Returns "),s("a",{class:"header-anchor",href:"#returns-2"},"#")],-1),at=s("p",null,[t("The "),s("a",{href:"#the-collection-object"},"collection object"),t(" for the collection created in this request.")],-1),ot={class:"tip hint"},ct=t("Make sure to pass an empty object for schema ("),it=s("code",null,"schema: {}",-1),rt=t(") when creating collections. Alternatively, you can omit it entirely or use "),ht=s("code",null,"schema: null",-1),dt=t(" to create "),pt=t("\u201Cfolder\u201D collections"),ut=t("."),_t=s("div",{class:"right"},[s("h3",{id:"rest-api-2",tabindex:"-1"},[t("REST API "),s("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),s("pre",null,[s("code",null,`POST /collections
-`)]),s("h5",{id:"example-3",tabindex:"-1"},[t("Example "),s("a",{class:"header-anchor",href:"#example-3"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /collections"),t(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),t(`
-	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"testimonials"'),s("span",{class:"hljs-punctuation"},","),t(`
-	`),s("span",{class:"hljs-attr"},'"meta"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-punctuation"},"{"),t(`
-		`),s("span",{class:"hljs-attr"},'"icon"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"format_quote"'),t(`
-	`),s("span",{class:"hljs-punctuation"},"}"),t(`
-`),s("span",{class:"hljs-punctuation"},"}"),t(`
-`)])]),s("h3",{id:"graphql-2",tabindex:"-1"},[t("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-2"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),t(` {
-	create_collections_item(data: directus_collections): directus_collections
-}
-`)])]),s("h5",{id:"example-4",tabindex:"-1"},[t("Example "),s("a",{class:"header-anchor",href:"#example-4"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),t(` {
-	create_collections_item(data: {
-		collection: `),s("span",{class:"hljs-string"},'"testimonials"'),t(`,
-		meta: {
-			icon: `),s("span",{class:"hljs-string"},'"format_quote"'),t(`
-		}
-	}) {
-		`),s("span",{class:"hljs-keyword"},"..."),t(`
-	}
-}
-`)])])],-1),jt=s("hr",null,null,-1),gt=s("h2",{id:"update-a-collection",tabindex:"-1"},[t("Update a Collection "),s("a",{class:"header-anchor",href:"#update-a-collection"},"#")],-1),mt=s("p",null,"Update the metadata for an existing collection.",-1),ft=s("div",{class:"two-up"},[s("div",{class:"left"},[s("h3",{id:"query-parameters-3",tabindex:"-1"},[t("Query Parameters "),s("a",{class:"header-anchor",href:"#query-parameters-3"},"#")]),s("p",null,"This endpoint doesn\u2019t currently support any query parameters."),s("h3",{id:"request-body-1",tabindex:"-1"},[t("Request Body "),s("a",{class:"header-anchor",href:"#request-body-1"},"#")]),s("p",null,[t("You can only update the "),s("code",null,"meta"),t(" values of the "),s("a",{href:"#the-collection-object"},"collection object"),t(". Updating the collection name is not supported at this time.")]),s("h3",{id:"returns-3",tabindex:"-1"},[t("Returns "),s("a",{class:"header-anchor",href:"#returns-3"},"#")]),s("p",null,[t("The "),s("a",{href:"#the-collection-object"},"collection object"),t(" for the updated collection in this request.")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-3",tabindex:"-1"},[t("REST API "),s("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),s("pre",null,[s("code",null,`PATCH /collections/:collection
-`)]),s("h5",{id:"example-5",tabindex:"-1"},[t("Example "),s("a",{class:"header-anchor",href:"#example-5"},"#")]),s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /collections/testimonials"),t(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),t(`
-	`),s("span",{class:"hljs-attr"},'"meta"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-punctuation"},"{"),t(`
-		`),s("span",{class:"hljs-attr"},'"note"'),s("span",{class:"hljs-punctuation"},":"),t(),s("span",{class:"hljs-string"},'"Short quotes from happy customers."'),t(`
-	`),s("span",{class:"hljs-punctuation"},"}"),t(`
-`),s("span",{class:"hljs-punctuation"},"}"),t(`
-`)])]),s("h3",{id:"graphql-3",tabindex:"-1"},[t("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-3"},"#")]),s("pre",null,[s("code",null,`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_collections_item(collection:`),s("span",{class:"hljs-type"}," String"),t(`!, data: update_directus_collections_input!): directus_collections
-}
-`)])]),s("h5",{id:"example-6",tabindex:"-1"},[t("Example "),s("a",{class:"header-anchor",href:"#example-6"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),t(` {
-	update_collections_item(collection: `),s("span",{class:"hljs-string"},'"testimonials"'),t(", data: { meta: { note: "),s("span",{class:"hljs-string"},'"Short quotes from happy customers."'),t(` } }) {
-		collection
-	}
-}
-`)])])])],-1),bt=s("hr",null,null,-1),yt=s("h2",{id:"delete-a-collection",tabindex:"-1"},[t("Delete a Collection "),s("a",{class:"header-anchor",href:"#delete-a-collection"},"#")],-1),vt=s("p",null,"Delete a collection.",-1),xt=s("div",{class:"two-up"},[s("div",{class:"left"},[s("div",{class:"danger hint"},[s("div",{class:"hint-title"},"Destructive"),s("p",null,"Be aware, this will delete the table from the database, including all items in it. This action can\u2019t be undone.")])]),s("div",{class:"right"},[s("h3",{id:"rest-api-4",tabindex:"-1"},[t("REST API "),s("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),s("pre",null,[s("code",null,`DELETE /collections/:collection
-`)]),s("h5",{id:"example-7",tabindex:"-1"},[t("Example "),s("a",{class:"header-anchor",href:"#example-7"},"#")]),s("pre",null,[s("code",null,`DELETE /collections/articles
-`)]),s("h3",{id:"graphql-4",tabindex:"-1"},[t("GraphQL "),s("a",{class:"header-anchor",href:"#graphql-4"},"#")]),s("pre",null,[s("code",null,`POST /graphql/system
-`)]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),t(` {
-	delete_collections_item(collection:`),s("span",{class:"hljs-type"}," String"),t(`!): delete_collection
-}
-`)])]),s("h5",{id:"example-8",tabindex:"-1"},[t("Example "),s("a",{class:"header-anchor",href:"#example-8"},"#")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),t(` {
-	delete_collections_item(collection: `),s("span",{class:"hljs-string"},'"articles"'),t(`) {
-		collection
-	}
-}
-`)])])])],-1),wt=s("hr",null,null,-1),Ct="Collections",Et=!1,St="page-reference",Pt={name:"collections",setup(qt,{expose:c}){const a={title:"Collections",modularExtension:!1,pageClass:"page-reference"};return c({frontmatter:a}),(Tt,At)=>{const e=o("router-link"),i=o("docs-wrapper");return r(),h(i,{frontmatter:a},{default:l(()=>[s("div",d,[s("div",p,[s("div",u,[s("blockquote",null,[s("p",null,[_,n(e,{to:"/docs/getting-started/glossary/#collections"},{default:l(()=>[j]),_:1}),g])])]),m]),f,b,s("div",y,[s("div",v,[x,w,q,s("div",T,[A,k,C,E,S,P,R,L,O,Q,W,B,s("p",null,[D,G,H,I,N,M,U,V,Y,n(e,{to:"/docs/configuration/data-model/#accountability"},{default:l(()=>[z]),_:1}),F]),s("p",null,[J,K,X,Z,$,n(e,{to:"/docs/configuration/data-model/#duplication"},{default:l(()=>[ss]),_:1}),ts]),s("p",null,[ls,es,ns,as,os,n(e,{to:"/docs/configuration/data-model/#sorting-grouping"},{default:l(()=>[cs]),_:1}),is]),s("p",null,[rs,hs,ds,ps,us,n(e,{to:"/docs/configuration/data-model/#sorting-grouping"},{default:l(()=>[_s]),_:1}),js]),gs]),ms,fs,bs,s("div",ys,[s("p",null,[n(e,{to:"/docs/configuration/data-model/#sorting-grouping"},{default:l(()=>[vs]),_:1}),xs,ws,qs])])]),Ts]),As,ks,Cs,s("div",Es,[Ss,s("div",Ps,[Rs,Ls,s("p",null,[n(e,{to:"/docs/reference/introduction/#search-http-method"},{default:l(()=>[Os]),_:1})]),Qs,Ws,Bs,Ds,Gs])]),Hs,Is,Ns,Ms,Us,Vs,Ys,s("div",zs,[s("div",Fs,[Js,Ks,Xs,Zs,s("p",null,[$s,st,tt,n(e,{to:"/docs/reference/system/fields/#the-fields-object"},{default:l(()=>[lt]),_:1}),et]),nt,at,s("div",ot,[s("p",null,[ct,it,rt,ht,dt,n(e,{to:"/docs/configuration/data-model/#sorting-grouping"},{default:l(()=>[pt]),_:1}),ut])])]),_t]),jt,gt,mt,ft,bt,yt,vt,xt,wt])]),_:1})}}};export{Pt as default,Et as modularExtension,St as pageClass,Ct as title};

package/dist/assets/collections.e06a8b1f.js

@@ -1,2 +0,0 @@
-import{a as l,o as r,b as d,w as o,g as e,e as n,B as t}from"./runtime-core.esm-bundler.e3d5f5b7.js";const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,"The Collection Page displays all Items within a Collection and comes with highly configurable Layouts for browsing, visualizing, and managing these Items.")],-1),m=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#adjust-page-layout"},"Adjust Page Layout ")]),e("li",null,[e("a",{href:"#search-items"},"Search Items ")]),e("li",null,[e("a",{href:"#filter-items"},"Filter Items ")]),e("li",null,[e("a",{href:"#manually-sort-items"},"Manually Sort Items ")]),e("li",null,[e("a",{href:"#automatically-sort-items"},"Automatically Sort Items ")]),e("li",null,[e("a",{href:"#view-archived-items"},"View Archived Items ")]),e("li",null,[e("a",{href:"#create-presets-and-bookmarks"},"Create Presets and Bookmarks ")]),e("li",null,[e("a",{href:"#import-%2F-export-items"},"Import / Export Items ")]),e("li",null,[e("a",{href:"#batch-delete%2C-archive-or-edit-items"},"Batch Delete, Archive or Edit Items ")])])])],-1),p={class:"tip hint"},_=e("div",{class:"hint-title"},"Before You Begin",-1),g=t("To use the Collection Page, you will need to know about "),y=t("Collections"),f=t(", "),v=t("Items"),b=t(" and "),I=t("Fields"),w=t("."),C=e("h2",{id:"adjust-page-layout",tabindex:"-1"},[t("Adjust Page Layout "),e("a",{class:"header-anchor",href:"#adjust-page-layout"},"#")],-1),k=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"Layouts"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/adjust-page-layout-20220415A.mp4",type:"video/mp4"})],-1),A=t("Layouts determine how you view or interact with Items in a Collection. Whether your Collection contains blog posts, project management tasks, geo-coordinates, temporal data or beyond; Layouts present Items in a more human-friendly way. "),S=t("Learn More"),x=e("h2",{id:"search-items",tabindex:"-1"},[t("Search Items "),e("a",{class:"header-anchor",href:"#search-items"},"#")],-1),T=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"Search Items"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/search-items-20220419A.mp4",type:"video/mp4"})],-1),L=e("p",null,[t("Find all Items with one or more Fields containing your searched value, excluding any Items which have been "),e("a",{href:"#filter-items"},"filtered out"),t(". To search through a Collection\u2019s Items, follow the steps below.")],-1),F=e("ol",null,[e("li",null,"Navigate to the Content Module and select the desired Collection."),e("li",null,[t("Select "),e("span",{mi:"",icon:""},"search"),t(" in the Page Header and a search bar will appear.")]),e("li",null,"Type in the value to search for.")],-1),P=e("h2",{id:"filter-items",tabindex:"-1"},[t("Filter Items "),e("a",{class:"header-anchor",href:"#filter-items"},"#")],-1),B=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"Filter Items"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/filter-items-2022019A.mp4",type:"video/mp4"})],-1),M=t("Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results, restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more. To Learn More, see our guide on "),D=t("Filters"),E=t("."),j=e("h2",{id:"manually-sort-items",tabindex:"-1"},[t("Manually Sort Items "),e("a",{class:"header-anchor",href:"#manually-sort-items"},"#")],-1),N=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"Batch Edit Items"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/manually-sort-items-20220415A.mp4",type:"video/mp4"})],-1),V=t("Drag and drop Items to custom sort them as desired. This is only possible on certain Layouts, such as the default "),q=t("Table Layout"),U=t(". To sort a Collection\u2019s Items, follow the steps below."),O=e("ol",null,[e("li",null,[t("Be sure a sorting column has been configured under "),e("strong",null,"\u201CSettings > Data Model > Collection\u201D"),t("."),e("br"),e("em",null,"(Shown in the video)")]),e("li",null,"Navigate to the Content Module and select the desired Collection."),e("li",null,[t("In the Sidebar, be sure a "),e("a",{href:"#adjust-page-layout"},"Layout"),t(" is chosen that supports manual sorting.")]),e("li",null,[t("Enable manual sorting: "),e("ul",null,[e("li",null,[t("For the Table Layout, toggle "),e("span",{mi:"",icon:""},"sort"),t(" in the configured Sort column.")])])]),e("li",null,"Drag Items by their handle into a new position.")],-1),R=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Manual Sorting Requires Configuration"),e("p",null,[t("Only available if a Sort column has been configured under:"),e("br"),e("strong",null,"\u201CSettings > Data Model > Collection > Sort\u201D")])],-1),z={class:"tip hint"},H=t("Sorting saves a value in a "),W=t("Sort Field"),Y=t(". This value is used to return data in a custom order. This means that while the values in this Sort Field do get updated and modified, values in other Fields are not changed."),G=e("h2",{id:"automatically-sort-items",tabindex:"-1"},[t("Automatically Sort Items "),e("a",{class:"header-anchor",href:"#automatically-sort-items"},"#")],-1),J=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"Automatically Sort Items"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/automatically-sort-items-20220415A.mp4",type:"video/mp4"})],-1),K=t("Sort Items alphabetically or numerically, in ascending or descending order. Sorting is not possible on certain Layouts, such as the Map Layout. Layouts that do support automatic sorting have controls in slightly different locations. To learn more, see "),Q=t("Layouts"),X=t("."),Z=e("div",{class:"tip hint"},[e("p",null,"Automatic sorting is a non-destructive action which does not change your data.")],-1),$=e("h2",{id:"view-archived-items",tabindex:"-1"},[t("View Archived Items "),e("a",{class:"header-anchor",href:"#view-archived-items"},"#")],-1),ee=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"View Archived Items"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/view-archived-items.mp4",type:"video/mp4"})],-1),te=t("The no-code app allows you to hide archived Items, display them alongside other Items, or display archived Items only. To learn how to archive an Item, see our guide on the "),oe=t("Item Page"),se=t(". To change whether an archived Item is displayed, follow the steps below."),ne=e("ol",null,[e("li",null,"Navigate to the Content Module and select the desired Collection."),e("li",null,[t("Click "),e("strong",null,"\u201CArchive\u201D"),t(" in the Sidebar.")]),e("li",null,[t("Choose the desired view: "),e("ul",null,[e("li",null,[e("strong",null,"\u201CShow Items\u201D")]),e("li",null,[e("strong",null,"\u201CShow Archived Items\u201D")]),e("li",null,[e("strong",null,"\u201CShow Items + Archived Items\u201D")])])])],-1),ie=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Archiving Requires Configuration"),e("p",null,[t("Only available if an Archive column has been configured under:"),e("br"),e("strong",null,"\u201CSettings > Data Model > Collection > Archive\u201D"),t(".")])],-1),le=e("h2",{id:"create-presets-and-bookmarks",tabindex:"-1"},[t("Create Presets and Bookmarks "),e("a",{class:"header-anchor",href:"#create-presets-and-bookmarks"},"#")],-1),ae=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"Create Presets and Bookmarks"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/presets-and-bookmarks-20220415A.mp4",type:"video/mp4"})],-1),ce=t("Save how a Collection Page looks so that you can return to the exact same view later, including details such as the Layout, searches, filters, sorting, ordering, etc. To learn more, see our guide on "),re=t("Presets and Bookmarks"),de=t("."),he=e("h2",{id:"import-%2F-export-items",tabindex:"-1"},[t("Import / Export Items "),e("a",{class:"header-anchor",href:"#import-%2F-export-items"},"#")],-1),ue=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/content/content-collections/content-collections-20220415A/imports-exports-20220416A.webp",alt:"Import and Export Items"})],-1),me=t("The Content, User Directory and File Library modules allow importing and exporting of multiple Items stored as files. This makes it quick and easy to handle tasks like uploading and downloading new customer information; pulling down sales data for transformation, reports, analysis, and beyond. To learn more, see how to "),pe=t("Import and Export Items"),_e=t(" in file format."),ge=e("h2",{id:"batch-delete%2C-archive-or-edit-items",tabindex:"-1"},[t("Batch Delete, Archive or Edit Items "),e("a",{class:"header-anchor",href:"#batch-delete%2C-archive-or-edit-items"},"#")],-1),ye=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"Batch Edit Items"},[e("source",{src:`https://cdn.directus.io/docs/v9/app-guide/content/content-items/content-items-20220415A/batch-edit-items-20220415A.mp4
-`,type:"video/mp4"})],-1),fe=e("p",null,"It is possible to delete, archive, or edit multiple Items at once from the Collection Page. Deletion will permanently delete Items from the database, this cannot be reverted. When batch editing, the Item Page opens, allowing you to make the same edit across multiple Items. Follow the steps below to batch delete, archive, or edit Items.",-1),ve=e("li",null,"Navigate to the Content Module and select the desired Collection.",-1),be=t("Choose a "),Ie=t("Layout"),we=t(" that supports multiple Item selection from the Sidebar."),Ce=e("br",null,null,-1),ke=t(" (e.g. The Table or Card Layout)"),Ae=e("li",null,[t("Click the Items you wish to select: "),e("ul",null,[e("li",null,[e("strong",null,"Table Layout:"),t(" Click "),e("span",{mi:"",icon:""},"check_box_outline_blank"),t(" in the left-most column.")]),e("li",null,[e("strong",null,"Card Layout:"),t(" Click "),e("span",{mi:"",icon:""},"radio_button_unchecked"),t(" in the upper left-hand corner of each Card.")])])],-1),Se=e("p",null,[t("Once Items are selected, the following buttons will appear in the Page Header: "),e("span",{mi:"",btn:"",muted:""},"delete"),e("span",{mi:"",btn:"",muted:""},"archive"),t(),e("span",{mi:"",btn:"",muted:""},"edit")],-1),xe=e("p",null,[e("strong",null,"Delete"),e("br"),t(" 4. Click "),e("span",{mi:"",btn:"",dngr:""},"delete"),t(" in the header and a popup will appear."),e("br"),t(" 5. Click "),e("strong",null,"\u201CDelete\u201D"),t(" to confirm the action.")],-1),Te=e("p",null,[e("strong",null,"Archive"),e("br"),t(" 4. Click "),e("span",{mi:"",btn:"",muted:""},"archive"),t(" in the header and a popup will appear."),e("br"),t(" 5. Click "),e("strong",null,"\u201CDelete\u201D"),t(" to confirm the action.")],-1),Le=e("p",null,[e("strong",null,"Edit"),e("br"),t(" 4. Click "),e("span",{mi:"",btn:"",muted:""},"edit"),t(" in the header and the Item Page will open."),e("br"),t(" 5. Update Item details as desired."),e("br"),t(" 6. Click "),e("span",{mi:"",btn:""},"check"),t(" to confirm batch edits on all Items.")],-1),De="Collection Page",Ee=!1,je={name:"collections",setup(Fe,{expose:a}){const i={title:"Collection Page",modularExtension:!1};return a({frontmatter:i}),(Pe,Be)=>{const s=l("router-link"),c=l("docs-wrapper");return r(),d(c,{frontmatter:i},{default:o(()=>[e("div",h,[u,m,e("div",p,[_,e("p",null,[g,n(s,{to:"/docs/getting-started/glossary/#collections"},{default:o(()=>[y]),_:1}),f,n(s,{to:"/docs/getting-started/glossary/#items"},{default:o(()=>[v]),_:1}),b,n(s,{to:"/docs/getting-started/glossary/#fields"},{default:o(()=>[I]),_:1}),w])]),C,k,e("p",null,[A,n(s,{to:"/docs/app/layouts"},{default:o(()=>[S]),_:1})]),x,T,L,F,P,B,e("p",null,[M,n(s,{to:"/docs/app/filters/"},{default:o(()=>[D]),_:1}),E]),j,N,e("p",null,[V,n(s,{to:"/docs/app/layouts/#table-layout"},{default:o(()=>[q]),_:1}),U]),O,R,e("div",z,[e("p",null,[H,n(s,{to:"/docs/reference/query/#sort"},{default:o(()=>[W]),_:1}),Y])]),G,J,e("p",null,[K,n(s,{to:"/docs/app/layouts"},{default:o(()=>[Q]),_:1}),X]),Z,$,ee,e("p",null,[te,n(s,{to:"/docs/app/content/items/#archive-an-item"},{default:o(()=>[oe]),_:1}),se]),ne,ie,le,ae,e("p",null,[ce,n(s,{to:"/docs/configuration/presets-bookmarks/"},{default:o(()=>[re]),_:1}),de]),he,ue,e("p",null,[me,n(s,{to:"/docs/app/import-export/"},{default:o(()=>[pe]),_:1}),_e]),ge,ye,fe,e("ol",null,[ve,e("li",null,[be,n(s,{to:"/docs/app/layouts"},{default:o(()=>[Ie]),_:1}),we,Ce,ke]),Ae]),Se,xe,Te,Le])]),_:1})}}};export{je as default,Ee as modularExtension,De as title};

package/dist/assets/commonlisp.725a0889.js

@@ -1 +0,0 @@
-import{z as y}from"./index.917a76e9.entry.js";function k(c,d){return d.forEach(function(i){i&&typeof i!="string"&&!Array.isArray(i)&&Object.keys(i).forEach(function(l){if(l!=="default"&&!(l in c)){var u=Object.getOwnPropertyDescriptor(i,l);Object.defineProperty(c,l,u.get?u:{enumerable:!0,get:function(){return i[l]}})}})}),Object.freeze(Object.defineProperty(c,Symbol.toStringTag,{value:"Module"}))}var x={exports:{}};(function(c,d){(function(i){i(y.exports)})(function(i){i.defineMode("commonlisp",function(l){var u=/^(block|let*|return-from|catch|load-time-value|setq|eval-when|locally|symbol-macrolet|flet|macrolet|tagbody|function|multiple-value-call|the|go|multiple-value-prog1|throw|if|progn|unwind-protect|labels|progv|let|quote)$/,s=/^with|^def|^do|^prog|case$|^cond$|bind$|when$|unless$/,a=/^(?:[+\-]?(?:\d+|\d*\.\d+)(?:[efd][+\-]?\d+)?|[+\-]?\d+(?:\/[+\-]?\d+)?|#b[+\-]?[01]+|#o[+\-]?[0-7]+|#x[+\-]?[\da-f]+)/,b=/[^\s'`,@()\[\]";]/,o;function f(e){for(var n;n=e.next();)if(n=="\\")e.next();else if(!b.test(n)){e.backUp(1);break}return e.current()}function p(e,n){if(e.eatSpace())return o="ws",null;if(e.match(a))return"number";var t=e.next();if(t=="\\"&&(t=e.next()),t=='"')return(n.tokenize=m)(e,n);if(t=="(")return o="open","bracket";if(t==")"||t=="]")return o="close","bracket";if(t==";")return e.skipToEnd(),o="ws","comment";if(/['`,@]/.test(t))return null;if(t=="|")return e.skipTo("|")?(e.next(),"symbol"):(e.skipToEnd(),"error");if(t=="#"){var t=e.next();return t=="("?(o="open","bracket"):/[+\-=\.']/.test(t)||/\d/.test(t)&&e.match(/^\d*#/)?null:t=="|"?(n.tokenize=v)(e,n):t==":"?(f(e),"meta"):t=="\\"?(e.next(),f(e),"string-2"):"error"}else{var r=f(e);return r=="."?null:(o="symbol",r=="nil"||r=="t"||r.charAt(0)==":"?"atom":n.lastType=="open"&&(u.test(r)||s.test(r))?"keyword":r.charAt(0)=="&"?"variable-2":"variable")}}function m(e,n){for(var t=!1,r;r=e.next();){if(r=='"'&&!t){n.tokenize=p;break}t=!t&&r=="\\"}return"string"}function v(e,n){for(var t,r;t=e.next();){if(t=="#"&&r=="|"){n.tokenize=p;break}r=t}return o="ws","comment"}return{startState:function(){return{ctx:{prev:null,start:0,indentTo:0},lastType:null,tokenize:p}},token:function(e,n){e.sol()&&typeof n.ctx.indentTo!="number"&&(n.ctx.indentTo=n.ctx.start+1),o=null;var t=n.tokenize(e,n);return o!="ws"&&(n.ctx.indentTo==null?o=="symbol"&&s.test(e.current())?n.ctx.indentTo=n.ctx.start+l.indentUnit:n.ctx.indentTo="next":n.ctx.indentTo=="next"&&(n.ctx.indentTo=e.column()),n.lastType=o),o=="open"?n.ctx={prev:n.ctx,start:e.column(),indentTo:null}:o=="close"&&(n.ctx=n.ctx.prev||n.ctx),t},indent:function(e,n){var t=e.ctx.indentTo;return typeof t=="number"?t:e.ctx.start+1},closeBrackets:{pairs:'()[]{}""'},lineComment:";;",blockCommentStart:"#|",blockCommentEnd:"|#"}}),i.defineMIME("text/x-common-lisp","commonlisp")})})();var h=x.exports,g=k({__proto__:null,default:h},[x.exports]);export{g as c};

package/dist/assets/config-options.9b79feaf.js

@@ -1,138 +0,0 @@
-import{a as u,o as r,b as i,w as n,g as l,e as o,B as e}from"./runtime-core.esm-bundler.e3d5f5b7.js";const c={class:"markdown-body"},h=l("blockquote",null,[l("p",null,"Environment variables are used for all configuration within a Directus project. These variables can be defined in a number of ways, which we cover below.")],-1),_=l("p",null,[l("div",{class:"table-of-contents"},[l("ul",null,[l("li",null,[l("a",{href:"#configuration-files"},"Configuration Files ")]),l("li",null,[l("a",{href:"#environment-variable-files"},"Environment Variable Files ")]),l("li",null,[l("a",{href:"#type-casting-and-nesting"},"Type Casting and Nesting ")]),l("li",null,[l("a",{href:"#environment-syntax-prefix"},"Environment Syntax Prefix ")]),l("li",null,[l("a",{href:"#general"},"General ")]),l("li",null,[l("a",{href:"#server"},"Server ")]),l("li",null,[l("a",{href:"#database"},"Database ")]),l("li",null,[l("a",{href:"#security"},"Security ")]),l("li",null,[l("a",{href:"#cors"},"CORS ")]),l("li",null,[l("a",{href:"#rate-limiting"},"Rate Limiting ")]),l("li",null,[l("a",{href:"#cache"},"Cache ")]),l("li",null,[l("a",{href:"#file-storage"},"File Storage ")]),l("li",null,[l("a",{href:"#assets"},"Assets ")]),l("li",null,[l("a",{href:"#authentication"},"Authentication ")]),l("li",null,[l("a",{href:"#extensions"},"Extensions ")]),l("li",null,[l("a",{href:"#messenger"},"Messenger ")]),l("li",null,[l("a",{href:"#email"},"Email ")]),l("li",null,[l("a",{href:"#admin-account"},"Admin Account ")]),l("li",null,[l("a",{href:"#telemetry"},"Telemetry ")]),l("li",null,[l("a",{href:"#limits-%26-optimizations"},"Limits & Optimizations ")])])])],-1),p=l("h2",{id:"configuration-files",tabindex:"-1"},[e("Configuration Files "),l("a",{class:"header-anchor",href:"#configuration-files"},"#")],-1),f=l("p",null,[e("By default, Directus will read the "),l("code",null,".env"),e(" file located next to your project\u2019s "),l("code",null,"package.json"),e(" (typically in the root folder of your project) for its configuration. You can change this path and filename by setting the "),l("code",null,"CONFIG_PATH"),e(" environment variable before starting Directus. For example:")],-1),m=l("pre",null,[l("code",{class:"language-bash"},[e("CONFIG_PATH="),l("span",{class:"hljs-string"},'"/path/to/config.js"'),e(` npx directus start
-`)])],-1),E=l("p",null,[e("In case you prefer using a configuration file instead of environment variables, you can also use the "),l("code",null,"CONFIG_PATH"),e(" environment variable to instruct Directus to use a local configuration file instead of environment variables. The config file can be one of the following formats:")],-1),g=l("ul",null,[l("li",null,[l("a",{href:"#env"},".env")]),l("li",null,[l("a",{href:"#config-json"},"config.json")]),l("li",null,[l("a",{href:"#config-yaml"},"config.yaml")]),l("li",null,[l("a",{href:"#config-js"},"config.js")])],-1),A=l("h3",{id:".env",tabindex:"-1"},[e(".env "),l("a",{class:"header-anchor",href:"#.env"},"#")],-1),T=l("p",null,"If the config path has no file extension, or a file extension that\u2019s not one of the other supported formats, Directus will try reading the file config path as environment variables. This has the following structure:",-1),b=l("pre",null,[l("code",null,`HOST="0.0.0.0"
-PORT=8055
-
-DB_CLIENT="pg"
-DB_HOST="localhost"
-DB_PORT=5432
-
-etc
-`)],-1),R=l("h3",{id:"config.json",tabindex:"-1"},[e("config.json "),l("a",{class:"header-anchor",href:"#config.json"},"#")],-1),S=l("p",null,"If you prefer a single JSON file for your configuration, create a JSON file with the environment variables as keys, for example:",-1),O=l("pre",null,[l("code",null,`CONFIG_PATH="/path/to/config.json"
-`)],-1),I=l("pre",null,[l("code",{class:"language-json"},[l("span",{class:"hljs-punctuation"},"{"),e(`
-	`),l("span",{class:"hljs-attr"},'"HOST"'),l("span",{class:"hljs-punctuation"},":"),e(),l("span",{class:"hljs-string"},'"0.0.0.0"'),l("span",{class:"hljs-punctuation"},","),e(`
-	`),l("span",{class:"hljs-attr"},'"PORT"'),l("span",{class:"hljs-punctuation"},":"),e(),l("span",{class:"hljs-number"},"8055"),l("span",{class:"hljs-punctuation"},","),e(`
-
-	`),l("span",{class:"hljs-attr"},'"DB_CLIENT"'),l("span",{class:"hljs-punctuation"},":"),e(),l("span",{class:"hljs-string"},'"pg"'),l("span",{class:"hljs-punctuation"},","),e(`
-	`),l("span",{class:"hljs-attr"},'"DB_HOST"'),l("span",{class:"hljs-punctuation"},":"),e(),l("span",{class:"hljs-string"},'"localhost"'),l("span",{class:"hljs-punctuation"},","),e(`
-	`),l("span",{class:"hljs-attr"},'"DB_PORT"'),l("span",{class:"hljs-punctuation"},":"),e(),l("span",{class:"hljs-number"},"5432"),e(`
-
-	`),l("span",{class:"hljs-comment"},"// etc"),e(`
-`),l("span",{class:"hljs-punctuation"},"}"),e(`
-`)])],-1),y=l("h3",{id:"config.yaml",tabindex:"-1"},[e("config.yaml "),l("a",{class:"header-anchor",href:"#config.yaml"},"#")],-1),D=l("p",null,[e("Similar to JSON, you can use a "),l("code",null,".yaml"),e(" (or "),l("code",null,".yml"),e(") file for your config:")],-1),C=l("pre",null,[l("code",null,`CONFIG_PATH="/path/to/config.yaml"
-`)],-1),v=l("pre",null,[l("code",{class:"language-yaml"},[l("span",{class:"hljs-attr"},"HOST:"),e(),l("span",{class:"hljs-number"},"0.0"),l("span",{class:"hljs-number"},".0"),l("span",{class:"hljs-number"},".0"),e(`
-`),l("span",{class:"hljs-attr"},"PORT:"),e(),l("span",{class:"hljs-number"},"8055"),e(`
-
-`),l("span",{class:"hljs-attr"},"DB_CLIENT:"),e(),l("span",{class:"hljs-string"},"pg"),e(`
-`),l("span",{class:"hljs-attr"},"DB_HOST:"),e(),l("span",{class:"hljs-string"},"localhost"),e(`
-`),l("span",{class:"hljs-attr"},"DB_PORT:"),e(),l("span",{class:"hljs-number"},"5432"),e(`
-`),l("span",{class:"hljs-comment"},"#"),e(`
-`),l("span",{class:"hljs-comment"},"# etc"),e(`
-`)])],-1),L=l("h3",{id:"config.js",tabindex:"-1"},[e("config.js "),l("a",{class:"header-anchor",href:"#config.js"},"#")],-1),w=l("p",null,[e("Using a JavaScript file for your config allows you to dynamically generate the configuration of the project during startup. The JavaScript configuration supports two different formats, either an "),l("strong",null,"Object Structure"),e(" where the key is the environment variable name:")],-1),U=l("pre",null,[l("code",{class:"language-js"},[l("span",{class:"hljs-comment"},"// Object Syntax"),e(`
-
-`),l("span",{class:"hljs-variable language_"},"module"),e("."),l("span",{class:"hljs-property"},"exports"),e(` = {
-	`),l("span",{class:"hljs-attr"},"HOST"),e(": "),l("span",{class:"hljs-string"},"'0.0.0.0'"),e(`,
-	`),l("span",{class:"hljs-attr"},"PORT"),e(": "),l("span",{class:"hljs-number"},"8055"),e(`,
-
-	`),l("span",{class:"hljs-attr"},"DB_CLIENT"),e(": "),l("span",{class:"hljs-string"},"'pg'"),e(`,
-	`),l("span",{class:"hljs-attr"},"DB_HOST"),e(": "),l("span",{class:"hljs-string"},"'localhost'"),e(`,
-	`),l("span",{class:"hljs-attr"},"DB_PORT"),e(": "),l("span",{class:"hljs-number"},"5432"),e(`,
-
-	`),l("span",{class:"hljs-comment"},"// etc"),e(`
-};
-`)])],-1),N=l("p",null,[e("Or a "),l("strong",null,"Function Structure"),e(" that "),l("em",null,"returns"),e(" the same object format as above. The function gets "),l("code",null,"process.env"),e(" as its parameter.")],-1),H=l("pre",null,[l("code",{class:"language-js"},[l("span",{class:"hljs-comment"},"// Function Syntax"),e(`
-
-`),l("span",{class:"hljs-variable language_"},"module"),e("."),l("span",{class:"hljs-property"},"exports"),e(" = "),l("span",{class:"hljs-keyword"},"function"),e(" ("),l("span",{class:"hljs-params"},"env"),e(`) {
-	`),l("span",{class:"hljs-keyword"},"return"),e(` {
-		`),l("span",{class:"hljs-attr"},"HOST"),e(": "),l("span",{class:"hljs-string"},"'0.0.0.0'"),e(`,
-		`),l("span",{class:"hljs-attr"},"PORT"),e(": "),l("span",{class:"hljs-number"},"8055"),e(`,
-
-		`),l("span",{class:"hljs-attr"},"DB_CLIENT"),e(": "),l("span",{class:"hljs-string"},"'pg'"),e(`,
-		`),l("span",{class:"hljs-attr"},"DB_HOST"),e(": "),l("span",{class:"hljs-string"},"'localhost'"),e(`,
-		`),l("span",{class:"hljs-attr"},"DB_PORT"),e(": "),l("span",{class:"hljs-number"},"5432"),e(`,
-
-		`),l("span",{class:"hljs-comment"},"// etc"),e(`
-	};
-};
-`)])],-1),P=l("h2",{id:"environment-variable-files",tabindex:"-1"},[e("Environment Variable Files "),l("a",{class:"header-anchor",href:"#environment-variable-files"},"#")],-1),x=l("p",null,[e("Any of the environment variable values can be imported from a file, by appending "),l("code",null,"_FILE"),e(" to the environment variable name. This is especially useful when used in conjunction with Docker Secrets, so you can keep sensitive data out of your compose files. For example:")],-1),V=l("pre",null,[l("code",null,`DB_PASSWORD_FILE="/run/secrets/db_password"
-`)],-1),M=l("h2",{id:"type-casting-and-nesting",tabindex:"-1"},[e("Type Casting and Nesting "),l("a",{class:"header-anchor",href:"#type-casting-and-nesting"},"#")],-1),j=l("p",null,"Environment variables are automatically type cast based on the structure of the variable, for example:",-1),k=l("pre",null,[l("code",null,`PUBLIC_URL="https://example.com"
-// "https://example.com"
-
-DB_HOST="3306"
-// 3306
-
-CORS_ENABLED="false"
-// false
-
-STORAGE_LOCATIONS="s3,local,example"
-// ["s3", "local", "example"]
-`)],-1),B=l("p",null,[e("In cases where the environment variables are converted to a configuration object for third party library use, like in "),l("code",null,"DB_*"),e(" or "),l("code",null,"RATE_LIMITER_REDIS_*"),e(", the environment variable will be converted to camelCase. You can use a double underscore ("),l("code",null,"__"),e(") for nested objects:")],-1),G=l("pre",null,[l("code",null,`DB_CLIENT="pg"
-DB_CONNECTION_STRING="postgresql://postgres:example@127.0.0.1"
-DB_SSL__REJECT_UNAUTHORIZED="false"
-
-{
-	client: "pg",
-	connectionString: "postgresql://postgres:example@127.0.0.1",
-	ssl: {
-		rejectUnauthorized: false
-	}
-}
-`)],-1),F=l("h2",{id:"environment-syntax-prefix",tabindex:"-1"},[e("Environment Syntax Prefix "),l("a",{class:"header-anchor",href:"#environment-syntax-prefix"},"#")],-1),W=l("p",null,[e("Directus will attempt to "),l("a",{href:"#type-casting-and-nesting"},"automatically type cast environment variables"),e(" based on context clues. If you have a specific need for a given type, you can tell Directus what type to use for the given value by prefixing the value with "),l("code",null,"{type}:"),e(". The following types are available:")],-1),q=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Syntax Prefix"),l("th",null,"Example"),l("th",null,"Output")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"string")]),l("td",null,[l("code",null,"string:value")]),l("td",null,[l("code",null,'"value"')])]),l("tr",null,[l("td",null,[l("code",null,"number")]),l("td",null,[l("code",null,"number:3306")]),l("td",null,[l("code",null,"3306")])]),l("tr",null,[l("td",null,[l("code",null,"regex")]),l("td",null,[l("code",null,"regex:\\.example\\.com$")]),l("td",null,[l("code",null,"/\\.example\\.com$/")])]),l("tr",null,[l("td",null,[l("code",null,"array")]),l("td",null,[l("code",null,"array:https://example.com,https://example2.com"),e(),l("br"),e(),l("code",null,"array:string:https://example.com,regex:\\.example3\\.com$")]),l("td",null,[l("code",null,'["https://example.com", "https://example2.com"]'),e(),l("br"),e(),l("code",null,'["https://example.com", "https://example2.com", /\\.example3\\.com$/]')])])])],-1),Y=l("hr",null,null,-1),K=l("h2",{id:"general",tabindex:"-1"},[e("General "),l("a",{class:"header-anchor",href:"#general"},"#")],-1),z=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"CONFIG_PATH")]),l("td",null,[e("Where your config file is located. See "),l("a",{href:"#configuration-files"},"Configuration Files")]),l("td",null,[l("code",null,".env")])]),l("tr",null,[l("td",null,[l("code",null,"HOST")]),l("td",null,"IP or host the API listens on."),l("td",null,[l("code",null,"0.0.0.0")])]),l("tr",null,[l("td",null,[l("code",null,"PORT")]),l("td",null,"What port to run the API under."),l("td",null,[l("code",null,"8055")])]),l("tr",null,[l("td",null,[l("code",null,"PUBLIC_URL"),l("sup",null,"[1]")]),l("td",null,"URL where your API can be reached on the web."),l("td",null,[l("code",null,"/")])]),l("tr",null,[l("td",null,[l("code",null,"LOG_LEVEL")]),l("td",null,[e("What level of detail to log. One of "),l("code",null,"fatal"),e(", "),l("code",null,"error"),e(", "),l("code",null,"warn"),e(", "),l("code",null,"info"),e(", "),l("code",null,"debug"),e(", "),l("code",null,"trace"),e(" or "),l("code",null,"silent"),e(".")]),l("td",null,[l("code",null,"info")])]),l("tr",null,[l("td",null,[l("code",null,"LOG_STYLE")]),l("td",null,[e("Render the logs human readable (pretty) or as JSON. One of "),l("code",null,"pretty"),e(", "),l("code",null,"raw"),e(".")]),l("td",null,[l("code",null,"pretty")])]),l("tr",null,[l("td",null,[l("code",null,"MAX_PAYLOAD_SIZE")]),l("td",null,"Controls the maximum request body size. Accepts number of bytes, or human readable string."),l("td",null,[l("code",null,"100kb")])]),l("tr",null,[l("td",null,[l("code",null,"ROOT_REDIRECT")]),l("td",null,[e("Where to redirect to when navigating to "),l("code",null,"/"),e(". Accepts a relative path, absolute URL, or "),l("code",null,"false"),e(" to disable.")]),l("td",null,[l("code",null,"./admin")])]),l("tr",null,[l("td",null,[l("code",null,"SERVE_APP")]),l("td",null,[e("Whether or not to serve the Admin App under "),l("code",null,"/admin"),e(".")]),l("td",null,[l("code",null,"true")])]),l("tr",null,[l("td",null,[l("code",null,"GRAPHQL_INTROSPECTION")]),l("td",null,"Whether or not to enable GraphQL Introspection"),l("td",null,[l("code",null,"true")])]),l("tr",null,[l("td",null,[l("code",null,"MAX_RELATIONAL_DEPTH")]),l("td",null,[e("The maximum depth when filtering / querying relational fields, with a minimum value of "),l("code",null,"2"),e(".")]),l("td",null,[l("code",null,"10")])])])],-1),X=l("sup",null,"[1]",-1),Z=e(" The PUBLIC_URL value is used for things like OAuth redirects, forgot-password emails, and logos that needs to be publicly available on the internet. "),J=l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"Additional Logger Variables"),l("p",null,[e("All "),l("code",null,"LOGGER_*"),e(" environment variables are passed to the "),l("code",null,"options"),e(" configuration of a "),l("a",{href:"https://github.com/pinojs/pino/blob/master/docs/api.md#options",target:"_blank",rel:"noopener noreferrer"},[l("code",null,"Pino"),e(" instance")]),e(". All "),l("code",null,"LOGGER_HTTP*"),e(" environment variables are passed to the "),l("code",null,"options"),e(" configuration of a "),l("a",{href:"https://github.com/pinojs/pino-http#api",target:"_blank",rel:"noopener noreferrer"},[l("code",null,"Pino-http"),e(" instance")]),e(". Based on your project\u2019s needs, you can extend the "),l("code",null,"LOGGER_*"),e(" environment variables with any config you need to pass to the logger instance. If a LOGGER_LEVELS key is added, these values will be passed to the logger formatter, as described "),l("a",{href:"https://github.com/pinojs/pino/blob/master/docs/help.md#mapping-pino-log-levels-to-google-cloud-logging-stackdriver-severity-levels",target:"_blank",rel:"noopener noreferrer"},"here"),e(" for example. The format for adding LEVELS values is: "),l("code",null,'LOGGER_LEVELS="trace:DEBUG,debug:DEBUG,info:INFO,warn:WARNING,error:ERROR,fatal:CRITICAL"')])],-1),Q=l("h2",{id:"server",tabindex:"-1"},[e("Server "),l("a",{class:"header-anchor",href:"#server"},"#")],-1),$=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"SERVER_KEEP_ALIVE_TIMEOUT")]),l("td",null,"Timeout in milliseconds for socket to be destroyed"),l("td",null,[l("a",{href:"https://github.com/nodejs/node/blob/master/doc/api/http.md#serverkeepalivetimeout",target:"_blank",rel:"noopener noreferrer"},"server.keepAliveTimeout")])]),l("tr",null,[l("td",null,[l("code",null,"SERVER_HEADERS_TIMEOUT")]),l("td",null,"Timeout in milliseconds to parse HTTP headers"),l("td",null,[l("a",{href:"https://github.com/nodejs/node/blob/master/doc/api/http.md#serverheaderstimeout",target:"_blank",rel:"noopener noreferrer"},"server.headersTimeout")])])])],-1),ll=l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"Additional Server Variables"),l("p",null,[e("All "),l("code",null,"SERVER_*"),e(" environment variables are merged with "),l("code",null,"server"),e(" instance properties created from "),l("a",{href:"https://github.com/nodejs/node/blob/master/doc/api/http.md#class-httpserver",target:"_blank",rel:"noopener noreferrer"},"http.Server"),e(". This allows to configure server behind a proxy, a load balancer, etc. Be careful to not override methods of this instance otherwise you may incur into unexpected behaviors.")])],-1),el=l("h2",{id:"database",tabindex:"-1"},[e("Database "),l("a",{class:"header-anchor",href:"#database"},"#")],-1),nl=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"DB_CLIENT")]),l("td",null,[l("strong",null,"Required"),e(". What database client to use. One of "),l("code",null,"pg"),e(" or "),l("code",null,"postgres"),e(", "),l("code",null,"mysql"),e(", "),l("code",null,"oracledb"),e(", "),l("code",null,"mssql"),e(", "),l("code",null,"sqlite3"),e(", "),l("code",null,"cockroachdb"),e(".")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"DB_HOST")]),l("td",null,[e("Database host. "),l("strong",null,"Required"),e(" when using "),l("code",null,"pg"),e(", "),l("code",null,"mysql"),e(", "),l("code",null,"oracledb"),e(", or "),l("code",null,"mssql"),e(".")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"DB_PORT")]),l("td",null,[e("Database port. "),l("strong",null,"Required"),e(" when using "),l("code",null,"pg"),e(", "),l("code",null,"mysql"),e(", "),l("code",null,"oracledb"),e(", or "),l("code",null,"mssql"),e(".")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"DB_DATABASE")]),l("td",null,[e("Database name. "),l("strong",null,"Required"),e(" when using "),l("code",null,"pg"),e(", "),l("code",null,"mysql"),e(", "),l("code",null,"oracledb"),e(", or "),l("code",null,"mssql"),e(".")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"DB_USER")]),l("td",null,[e("Database user. "),l("strong",null,"Required"),e(" when using "),l("code",null,"pg"),e(", "),l("code",null,"mysql"),e(", "),l("code",null,"oracledb"),e(", or "),l("code",null,"mssql"),e(".")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"DB_PASSWORD")]),l("td",null,[e("Database user\u2019s password. "),l("strong",null,"Required"),e(" when using "),l("code",null,"pg"),e(", "),l("code",null,"mysql"),e(", "),l("code",null,"oracledb"),e(", or "),l("code",null,"mssql"),e(".")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"DB_FILENAME")]),l("td",null,[e("Where to read/write the SQLite database. "),l("strong",null,"Required"),e(" when using "),l("code",null,"sqlite3"),e(".")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"DB_CONNECTION_STRING")]),l("td",null,[e("When using "),l("code",null,"pg"),e(", you can submit a connection string instead of individual properties. Using this will ignore any of the other connection settings.")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"DB_POOL__*")]),l("td",null,[e("Pooling settings. Passed on to "),l("a",{href:"https://github.com/vincit/tarn.js#usage",target:"_blank",rel:"noopener noreferrer"},[e("the "),l("code",null,"tarn.js")]),e(" library.")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"DB_EXCLUDE_TABLES")]),l("td",null,"CSV of tables you want Directus to ignore completely"),l("td",null,[l("code",null,"spatial_ref_sys,sysdiagrams")])]),l("tr",null,[l("td",null,[l("code",null,"DB_CHARSET")]),l("td",null,"Charset/collation to use in the connection to MySQL/MariaDB"),l("td",null,[l("code",null,"UTF8_GENERAL_CI")])]),l("tr",null,[l("td",null,[l("code",null,"DB_VERSION")]),l("td",null,"Database version, in case you use the PostgreSQL adapter to connect a non-standard database. Not normally required."),l("td",null,"\u2013")])])],-1),tl=l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"Additional Database Variables"),l("p",null,[e("All "),l("code",null,"DB_*"),e(" environment variables are passed to the "),l("code",null,"connection"),e(" configuration of a "),l("a",{href:"http://knexjs.org",target:"_blank",rel:"noopener noreferrer"},[l("code",null,"Knex"),e(" instance")]),e(". Based on your project\u2019s needs, you can extend the "),l("code",null,"DB_*"),e(" environment variables with any config you need to pass to the database instance.")])],-1),ol=l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"Pooling"),l("p",null,[e("All the "),l("code",null,"DB_POOL__"),e(" prefixed options are passed to "),l("a",{href:"https://github.com/vincit/tarn.js#usage",target:"_blank",rel:"noopener noreferrer"},[l("code",null,"tarn.js")]),e(" through "),l("a",{href:"http://knexjs.org/#Installation-pooling",target:"_blank",rel:"noopener noreferrer"},"Knex")])],-1),sl=l("h2",{id:"security",tabindex:"-1"},[e("Security "),l("a",{class:"header-anchor",href:"#security"},"#")],-1),ul=l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])],-1),al=l("tr",null,[l("td",null,[l("code",null,"KEY")]),l("td",null,"Unique identifier for the project."),l("td",null,"\u2013")],-1),dl=l("tr",null,[l("td",null,[l("code",null,"SECRET")]),l("td",null,"Secret string for the project."),l("td",null,"\u2013")],-1),rl=l("tr",null,[l("td",null,[l("code",null,"ACCESS_TOKEN_TTL")]),l("td",null,"The duration that the access token is valid."),l("td",null,[l("code",null,"15m")])],-1),il=l("tr",null,[l("td",null,[l("code",null,"REFRESH_TOKEN_TTL")]),l("td",null,"The duration that the refresh token is valid, and also how long users stay logged-in to the App."),l("td",null,[l("code",null,"7d")])],-1),cl=l("tr",null,[l("td",null,[l("code",null,"REFRESH_TOKEN_COOKIE_DOMAIN")]),l("td",null,"Which domain to use for the refresh cookie. Useful for development mode."),l("td",null,"\u2013")],-1),hl=l("tr",null,[l("td",null,[l("code",null,"REFRESH_TOKEN_COOKIE_SECURE")]),l("td",null,"Whether or not to use a secure cookie for the refresh token in cookie mode."),l("td",null,[l("code",null,"false")])],-1),_l=l("tr",null,[l("td",null,[l("code",null,"REFRESH_TOKEN_COOKIE_SAME_SITE")]),l("td",null,[e("Value for "),l("code",null,"sameSite"),e(" in the refresh token cookie when in cookie mode.")]),l("td",null,[l("code",null,"lax")])],-1),pl=l("tr",null,[l("td",null,[l("code",null,"REFRESH_TOKEN_COOKIE_NAME")]),l("td",null,"Name of refresh token cookie ."),l("td",null,[l("code",null,"directus_refresh_token")])],-1),fl=l("td",null,[l("code",null,"PASSWORD_RESET_URL_ALLOW_LIST")],-1),ml=e("List of URLs that can be used "),El=e("as "),gl=l("code",null,"reset_url",-1),Al=e(" in /password/request"),Tl=l("td",null,"\u2013",-1),bl=l("td",null,[l("code",null,"USER_INVITE_URL_ALLOW_LIST")],-1),Rl=e("List of URLs that can be used "),Sl=e("as "),Ol=l("code",null,"invite_url",-1),Il=e(" in /users/invite"),yl=l("td",null,"\u2013",-1),Dl=l("tr",null,[l("td",null,[l("code",null,"IP_TRUST_PROXY")]),l("td",null,[e("Settings for "),l("a",{href:"https://expressjs.com/en/guide/behind-proxies.html",target:"_blank",rel:"noopener noreferrer"},"express\u2019 trust proxy setting")]),l("td",null,"true")],-1),Cl=l("tr",null,[l("td",null,[l("code",null,"IP_CUSTOM_HEADER")]),l("td",null,"What custom request header to use for the IP address"),l("td",null,"false")],-1),vl=l("tr",null,[l("td",null,[l("code",null,"ASSETS_CONTENT_SECURITY_POLICY")]),l("td",null,[e("Custom overrides for the Content-Security-Policy header for the /assets endpoint. See "),l("a",{href:"https://helmetjs.github.io",target:"_blank",rel:"noopener noreferrer"},"helmet\u2019s documentation"),e(" for more information.")]),l("td",null,"\u2013")],-1),Ll=l("tr",null,[l("td",null,[l("code",null,"IMPORT_IP_DENY_LIST")]),l("td",null,[e("Deny importing files from these IP addresses. Use "),l("code",null,"0.0.0.0"),e(" for any local IP address")]),l("td",null,[l("code",null,"0.0.0.0")])],-1),wl=l("tr",null,[l("td",null,[l("code",null,"CONTENT_SECURITY_POLICY_*")]),l("td",null,[e("Custom overrides for the Content-Security-Policy header. See "),l("a",{href:"https://helmetjs.github.io",target:"_blank",rel:"noopener noreferrer"},"helmet\u2019s documentation"),e(" for more information.")]),l("td",null,"\u2013")],-1),Ul=l("tr",null,[l("td",null,[l("code",null,"HSTS_ENABLED")]),l("td",null,"Enable the Strict-Transport-Security policy header."),l("td",null,[l("code",null,"false")])],-1),Nl=l("tr",null,[l("td",null,[l("code",null,"HSTS_*")]),l("td",null,[e("Custom overrides for the Strict-Transport-Security header. See "),l("a",{href:"https://helmetjs.github.io",target:"_blank",rel:"noopener noreferrer"},"helmet\u2019s documentation"),e(" for more information.")]),l("td",null,"\u2013")],-1),Hl=l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"Cookie Strictness"),l("p",null,[e("Browser are pretty strict when it comes to third-party cookies. If you\u2019re running into unexpected problems when running your project and API on different domains, make sure to verify your configuration for "),l("code",null,"REFRESH_TOKEN_COOKIE_NAME"),e(", "),l("code",null,"REFRESH_TOKEN_COOKIE_SECURE"),e(" and "),l("code",null,"REFRESH_TOKEN_COOKIE_SAME_SITE"),e(".")])],-1),Pl=l("h3",{id:"hashing",tabindex:"-1"},[e("Hashing "),l("a",{class:"header-anchor",href:"#hashing"},"#")],-1),xl=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"HASH_MEMORY_COST")]),l("td",null,"How much memory to use when generating hashes, in KiB."),l("td",null,[l("code",null,"4096"),e(" (4 MiB)")])]),l("tr",null,[l("td",null,[l("code",null,"HASH_LENGTH")]),l("td",null,"The length of the hash function output in bytes."),l("td",null,[l("code",null,"32")])]),l("tr",null,[l("td",null,[l("code",null,"HASH_TIME_COST")]),l("td",null,"The amount of passes (iterations) used by the hash function. It increases hash strength at the cost of time required to compute."),l("td",null,[l("code",null,"3")])]),l("tr",null,[l("td",null,[l("code",null,"HASH_PARALLELISM")]),l("td",null,[e("The amount of threads to compute the hash on. Each thread has a memory pool with "),l("code",null,"HASH_MEMORY_COST"),e(" size.")]),l("td",null,[l("code",null,"1"),e(" (single thread)")])]),l("tr",null,[l("td",null,[l("code",null,"HASH_TYPE")]),l("td",null,[e("The variant of the hash function ("),l("code",null,"0"),e(": argon2d, "),l("code",null,"1"),e(": argon2i, or "),l("code",null,"2"),e(": argon2id).")]),l("td",null,[l("code",null,"1"),e(" (argon2i)")])]),l("tr",null,[l("td",null,[l("code",null,"HASH_ASSOCIATED_DATA")]),l("td",null,"An extra and optional non-secret value. The value will be included B64 encoded in the parameters portion of the digest."),l("td",null,"\u2013")])])],-1),Vl=e("Argon2\u2019s hashing function is used by Directus for three purposes: 1) hashing user passwords, 2) generating hashes for the "),Ml=l("code",null,"Hash",-1),jl=e(" field type in collections, and 3) the "),kl=e("generate a hash API endpoint"),Bl=e("."),Gl=l("p",null,[e("All "),l("code",null,"HASH_*"),e(" environment variable parameters are passed to the "),l("code",null,"argon2.hash"),e(" function. See the "),l("a",{href:"https://github.com/ranisalt/node-argon2/wiki/Options",target:"_blank",rel:"noopener noreferrer"},"node-argon2 library options page"),e(" for reference.")],-1),Fl=l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"Memory Usage"),l("p",null,[e("Modifying "),l("code",null,"HASH_MEMORY_COST"),e(" and/or "),l("code",null,"HASH_PARALLELISM"),e(" will affect the amount of memory directus uses when computing hashes; each thread gets "),l("code",null,"HASH_MEMORY_COST"),e(" amount of memory, so the total additional memory will be these two values multiplied. This may cause out of memory errors, especially when running in containerized environments.")])],-1),Wl=l("h2",{id:"cors",tabindex:"-1"},[e("CORS "),l("a",{class:"header-anchor",href:"#cors"},"#")],-1),ql=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"CORS_ENABLED")]),l("td",null,"Whether or not to enable the CORS headers."),l("td",null,[l("code",null,"false")])]),l("tr",null,[l("td",null,[l("code",null,"CORS_ORIGIN")]),l("td",null,[e("Value for the "),l("code",null,"Access-Control-Allow-Origin"),e(" header. Use "),l("code",null,"true"),e(" to match the Origin header, or provide a domain or a CSV of domains for specific access")]),l("td",null,[l("code",null,"false")])]),l("tr",null,[l("td",null,[l("code",null,"CORS_METHODS")]),l("td",null,[e("Value for the "),l("code",null,"Access-Control-Allow-Methods"),e(" header.")]),l("td",null,[l("code",null,"GET,POST,PATCH,DELETE")])]),l("tr",null,[l("td",null,[l("code",null,"CORS_ALLOWED_HEADERS")]),l("td",null,[e("Value for the "),l("code",null,"Access-Control-Allow-Headers"),e(" header.")]),l("td",null,[l("code",null,"Content-Type,Authorization")])]),l("tr",null,[l("td",null,[l("code",null,"CORS_EXPOSED_HEADERS")]),l("td",null,[e("Value for the "),l("code",null,"Access-Control-Expose-Headers"),e(" header.")]),l("td",null,[l("code",null,"Content-Range")])]),l("tr",null,[l("td",null,[l("code",null,"CORS_CREDENTIALS")]),l("td",null,[e("Whether or not to send the "),l("code",null,"Access-Control-Allow-Credentials"),e(" header.")]),l("td",null,[l("code",null,"true")])]),l("tr",null,[l("td",null,[l("code",null,"CORS_MAX_AGE")]),l("td",null,[e("Value for the "),l("code",null,"Access-Control-Max-Age"),e(" header.")]),l("td",null,[l("code",null,"18000")])])])],-1),Yl=l("h2",{id:"rate-limiting",tabindex:"-1"},[e("Rate Limiting "),l("a",{class:"header-anchor",href:"#rate-limiting"},"#")],-1),Kl=l("p",null,[e("You can use the built-in rate-limiter to prevent users from hitting the API too much. Simply enabling the rate-limiter will set a default maximum of 50 requests per second, tracked in memory. Once you have multiple copies of Directus running under a load-balancer, or your user base grows so much that memory is no longer a viable place to store the rate limiter information, you can use an external "),l("code",null,"memcache"),e(" or "),l("code",null,"redis"),e(" instance to store the rate limiter data.")],-1),zl=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"RATE_LIMITER_ENABLED")]),l("td",null,"Whether or not to enable rate limiting on the API."),l("td",null,[l("code",null,"false")])]),l("tr",null,[l("td",null,[l("code",null,"RATE_LIMITER_POINTS")]),l("td",null,"The amount of allowed hits per duration."),l("td",null,[l("code",null,"50")])]),l("tr",null,[l("td",null,[l("code",null,"RATE_LIMITER_DURATION")]),l("td",null,"The time window in seconds in which the points are counted."),l("td",null,[l("code",null,"1")])]),l("tr",null,[l("td",null,[l("code",null,"RATE_LIMITER_STORE")]),l("td",null,[e("Where to store the rate limiter counts. One of "),l("code",null,"memory"),e(", "),l("code",null,"redis"),e(", or "),l("code",null,"memcache"),e(".")]),l("td",null,[l("code",null,"memory")])])])],-1),Xl=l("p",null,[e("Based on the "),l("code",null,"RATE_LIMITER_STORE"),e(" used, you must also provide the following configurations:")],-1),Zl=l("h3",{id:"memory",tabindex:"-1"},[e("Memory "),l("a",{class:"header-anchor",href:"#memory"},"#")],-1),Jl=l("p",null,"No additional configuration required.",-1),Ql=l("h3",{id:"redis",tabindex:"-1"},[e("Redis "),l("a",{class:"header-anchor",href:"#redis"},"#")],-1),$l=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"RATE_LIMITER_REDIS")]),l("td",null,[e("Redis connection string, eg: "),l("code",null,"redis://:authpassword@127.0.0.1:6380/4")]),l("td",null,"\u2014")])])],-1),le=l("p",null,"Alternatively, you can provide the individual connection parameters:",-1),ee=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"RATE_LIMITER_REDIS_HOST")]),l("td",null,"Hostname of the Redis instance"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"RATE_LIMITER_REDIS_PORT")]),l("td",null,"Port of the Redis instance"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"RATE_LIMITER_REDIS_PASSWORD")]),l("td",null,"Password for your Redis instance"),l("td",null,"\u2013")])])],-1),ne=l("h3",{id:"memcache",tabindex:"-1"},[e("Memcache "),l("a",{class:"header-anchor",href:"#memcache"},"#")],-1),te=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"RATE_LIMITER_MEMCACHE")]),l("td",null,[e("Location of your memcache instance. You can use "),l("a",{href:"#environment-syntax-prefix"},[l("code",null,"array:"),e(" syntax")]),e(", eg: "),l("code",null,"array:<instance-1>,<instance-2>"),e(" for multiple memcache instances.")]),l("td",null,"\u2014")])])],-1),oe=l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"Additional Rate Limiter Variables"),l("p",null,[e("All "),l("code",null,"RATE_LIMITER_*"),e(" variables are passed directly to a "),l("code",null,"rate-limiter-flexible"),e(" instance. Depending on your project\u2019s needs, you can extend the above environment variables to configure any of "),l("a",{href:"https://github.com/animir/node-rate-limiter-flexible/wiki/Options",target:"_blank",rel:"noopener noreferrer"},[e("the "),l("code",null,"rate-limiter-flexible"),e(" options")]),e(".")])],-1),se=l("h3",{id:"example%3A-basic",tabindex:"-1"},[e("Example: Basic "),l("a",{class:"header-anchor",href:"#example%3A-basic"},"#")],-1),ue=l("pre",null,[l("code",null,`// 10 requests per 5 seconds
-
-RATE_LIMITER_POINTS="10"
-RATE_LIMITER_DURATION="5"
-`)],-1),ae=l("h3",{id:"example%3A-redis",tabindex:"-1"},[e("Example: Redis "),l("a",{class:"header-anchor",href:"#example%3A-redis"},"#")],-1),de=l("pre",null,[l("code",null,`RATE_LIMITER_ENABLED="true"
-
-RATE_LIMITER_POINTS="10"
-RATE_LIMITER_DURATION="5"
-
-RATE_LIMITER_STORE="redis"
-
-RATE_LIMITER_REDIS="redis://@127.0.0.1"
-`)],-1),re=l("h2",{id:"cache",tabindex:"-1"},[e("Cache "),l("a",{class:"header-anchor",href:"#cache"},"#")],-1),ie=l("p",null,"Directus has a built-in data-caching option. Enabling this will cache the output of requests (based on the current user and exact query parameters used) into configured cache storage location. This drastically improves API performance, as subsequent requests are served straight from this cache. Enabling cache will also make Directus return accurate cache-control headers. Depending on your setup, this will further improve performance by caching the request in middleman servers (like CDNs) and even the browser.",-1),ce=l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"Internal Caching"),l("p",null,[e("In addition to data-caching, Directus also does some internal caching. Note "),l("code",null,"SCHEMA_CACHE"),e(" and "),l("code",null,"CACHE_PERMISSIONS"),e(" which are enabled by default. These speed up the overall performance of Directus, as we don\u2019t want to introspect the whole database or check all permissions on every request. When running Directus load balanced, you\u2019ll need to use a shared cache storage (like "),l("a",{href:"#redis-2"},"Redis"),e(" or "),l("a",{href:"#memcache-2"},"Memcache"),e(") or else disable all caching.")])],-1),he=l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"Assets Cache"),l("p",null,[l("code",null,"Cache-Control"),e(" and "),l("code",null,"Last-Modified"),e(" headers for the "),l("code",null,"/assets"),e(" endpoint are separate from the regular data-cache. "),l("code",null,"Last-Modified"),e(" comes from "),l("code",null,"modified_on"),e(" DB field. This is useful as it\u2019s often possible to cache assets for far longer than you would cache database content. To learn more, see "),l("a",{href:"#assets"},"Assets"),e(".")])],-1),_e=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"CACHE_ENABLED")]),l("td",null,"Whether or not data caching is enabled."),l("td",null,[l("code",null,"false")])]),l("tr",null,[l("td",null,[l("code",null,"CACHE_TTL"),l("sup",null,"[1]")]),l("td",null,"How long the data cache is persisted."),l("td",null,[l("code",null,"5m")])]),l("tr",null,[l("td",null,[l("code",null,"CACHE_CONTROL_S_MAXAGE")]),l("td",null,[e("Whether to not to add the "),l("code",null,"s-maxage"),e(" expiration flag. Set to a number for a custom value.")]),l("td",null,[l("code",null,"0")])]),l("tr",null,[l("td",null,[l("code",null,"CACHE_AUTO_PURGE"),l("sup",null,"[2]")]),l("td",null,[e("Automatically purge the data cache on "),l("code",null,"create"),e(", "),l("code",null,"update"),e(", and "),l("code",null,"delete"),e(" actions.")]),l("td",null,[l("code",null,"false")])]),l("tr",null,[l("td",null,[l("code",null,"CACHE_SYSTEM_TTL"),l("sup",null,"[3]")]),l("td",null,[e("How long "),l("code",null,"CACHE_SCHEMA"),e(" and "),l("code",null,"CACHE_PERMISSIONS"),e(" are persisted.")]),l("td",null,[l("code",null,"10m")])]),l("tr",null,[l("td",null,[l("code",null,"CACHE_SCHEMA"),l("sup",null,"[3]")]),l("td",null,[e("Whether or not the database schema is cached. One of "),l("code",null,"false"),e(", "),l("code",null,"true")]),l("td",null,[l("code",null,"true")])]),l("tr",null,[l("td",null,[l("code",null,"CACHE_PERMISSIONS"),l("sup",null,"[3]")]),l("td",null,[e("Whether or not the user permissions are cached. One of "),l("code",null,"false"),e(", "),l("code",null,"true")]),l("td",null,[l("code",null,"true")])]),l("tr",null,[l("td",null,[l("code",null,"CACHE_NAMESPACE")]),l("td",null,"How to scope the cache data."),l("td",null,[l("code",null,"directus-cache")])]),l("tr",null,[l("td",null,[l("code",null,"CACHE_STORE"),l("sup",null,"[4]")]),l("td",null,[e("Where to store the cache data. Either "),l("code",null,"memory"),e(", "),l("code",null,"redis"),e(", or "),l("code",null,"memcache"),e(".")]),l("td",null,[l("code",null,"memory")])]),l("tr",null,[l("td",null,[l("code",null,"CACHE_STATUS_HEADER")]),l("td",null,[e("If set, returns the cache status in the configured header. One of "),l("code",null,"HIT"),e(", "),l("code",null,"MISS"),e(".")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"CACHE_VALUE_MAX_SIZE")]),l("td",null,[e("Maximum size of values that will be cached. Accepts number of bytes, or human readable string. Use "),l("code",null,"false"),e(" for no limit")]),l("td",null,"false")])])],-1),pe=l("sup",null,"[1]",-1),fe=e(" `CACHE_TTL` Based on your project's needs, you might be able to aggressively cache your data, only requiring new data to be fetched every hour or so. This allows you to squeeze the most performance out of your Directus instance. This can be incredibly useful for applications where you have a lot of (public) read-access and where updates aren't real-time (for example a website). `CACHE_TTL` uses [`ms`](https://www.npmjs.com/package/ms) to parse the value, so you configure it using human readable values (like `2 days`, `7 hrs`, `5m`). "),me=l("sup",null,"[2]",-1),Ee=e(" `CACHE_AUTO_PURGE` allows you to keep the Directus API real-time, while still getting the performance benefits on quick subsequent reads. "),ge=l("sup",null,"[3]",-1),Ae=e(" Not affected by the `CACHE_ENABLED` value. "),Te=l("sup",null,"[4]",-1),be=e(" `CACHE_STORE` For larger projects, you most likely don't want to rely on local memory for caching. Instead, you can use the above `CACHE_STORE` environment variable to use either `memcache` or `redis` as the cache store. Based on the chosen `CACHE_STORE`, you must also provide the following configurations: "),Re=l("h3",{id:"memory-1",tabindex:"-1"},[e("Memory "),l("a",{class:"header-anchor",href:"#memory-1"},"#")],-1),Se=l("p",null,"No additional configuration required.",-1),Oe=l("h3",{id:"redis-1",tabindex:"-1"},[e("Redis "),l("a",{class:"header-anchor",href:"#redis-1"},"#")],-1),Ie=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"CACHE_REDIS")]),l("td",null,[e("Redis connection string, eg: "),l("code",null,"redis://:authpassword@127.0.0.1:6380/4")]),l("td",null,"\u2014")])])],-1),ye=l("p",null,"Alternatively, you can provide the individual connection parameters:",-1),De=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"CACHE_REDIS_HOST")]),l("td",null,"Hostname of the Redis instance"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"CACHE_REDIS_PORT")]),l("td",null,"Port of the Redis instance"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"CACHE_REDIS_PASSWORD")]),l("td",null,"Password for your Redis instance"),l("td",null,"\u2013")])])],-1),Ce=l("h3",{id:"memcache-1",tabindex:"-1"},[e("Memcache "),l("a",{class:"header-anchor",href:"#memcache-1"},"#")],-1),ve=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"CACHE_MEMCACHE")]),l("td",null,[e("Location of your memcache instance. You can use "),l("a",{href:"#environment-syntax-prefix"},[l("code",null,"array:"),e(" syntax")]),e(", eg: "),l("code",null,"array:<instance-1>,<instance-2>"),e(" for multiple memcache instances.")]),l("td",null,"\u2014")])])],-1),Le=l("h2",{id:"file-storage",tabindex:"-1"},[e("File Storage "),l("a",{class:"header-anchor",href:"#file-storage"},"#")],-1),we=l("p",null,[e("By default, Directus stores all uploaded files locally on disk. However, you can also configure Directus to use S3, Google Cloud Storage, or Azure. You can also configure "),l("em",null,"multiple"),e(" storage adapters at the same time. This allows you to choose where files are being uploaded on a file-by-file basis. In the Admin App, files will automatically be uploaded to the first configured storage location (in this case "),l("code",null,"local"),e("). The used storage location is saved under "),l("code",null,"storage"),e(" in "),l("code",null,"directus_files"),e(".")],-1),Ue=l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"File Storage Default"),l("p",null,"If you don\u2019t provide any configuration for storage adapters, this default will be used:"),l("pre",null,[l("code",null,`STORAGE_LOCATIONS="local"
-STORAGE_LOCAL_ROOT="./uploads"
-`)])],-1),Ne=l("div",{class:"warning hint"},[l("div",{class:"hint-title"},"Case sensitivity"),l("p",null,"The location value(s) you specify should be capitalized when specifying the additional configuration values. For example, this will not work:"),l("pre",null,[l("code",null,`STORAGE_LOCATIONS="s3"
-STORAGE_s3_DRIVER="s3" # Will not work, lowercase "s3" \u274C
-`)]),l("p",null,"but this will work:"),l("pre",null,[l("code",null,`STORAGE_LOCATIONS="s3"
-STORAGE_S3_DRIVER="s3" # Will work, "s3" is uppercased \u2705
-`)])],-1),He=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"STORAGE_LOCATIONS")]),l("td",null,[e("A CSV of storage locations (eg: "),l("code",null,"local,digitalocean,amazon"),e(") to use. You can use any names you\u2019d like for these keys.")]),l("td",null,[l("code",null,"local")])])])],-1),Pe=l("p",null,"For each of the storage locations listed, you must provide the following configuration:",-1),xe=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_DRIVER")]),l("td",null,[e("Which driver to use, either "),l("code",null,"local"),e(", "),l("code",null,"s3"),e(", "),l("code",null,"gcs"),e(", "),l("code",null,"azure")]),l("td")]),l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_ROOT")]),l("td",null,"Where to store the files on disk"),l("td",null,[l("code",null,"''")])])])],-1),Ve=l("p",null,"Based on your configured driver, you must also provide the following configurations:",-1),Me=l("h3",{id:"local-(local)",tabindex:"-1"},[e("Local ("),l("code",null,"local"),e(") "),l("a",{class:"header-anchor",href:"#local-(local)"},"#")],-1),je=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_ROOT")]),l("td",null,"Where to store the files on disk"),l("td",null,"\u2013")])])],-1),ke=l("h3",{id:"s3-(s3)",tabindex:"-1"},[e("S3 ("),l("code",null,"s3"),e(") "),l("a",{class:"header-anchor",href:"#s3-(s3)"},"#")],-1),Be=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_KEY")]),l("td",null,"User key"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_SECRET")]),l("td",null,"User secret"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_BUCKET")]),l("td",null,"S3 Bucket"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_REGION")]),l("td",null,"S3 Region"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_ENDPOINT")]),l("td",null,"S3 Endpoint"),l("td",null,[l("code",null,"s3.amazonaws.com")])]),l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_ACL")]),l("td",null,"S3 ACL"),l("td",null,"\u2013")])])],-1),Ge=l("h3",{id:"azure-(azure)",tabindex:"-1"},[e("Azure ("),l("code",null,"azure"),e(") "),l("a",{class:"header-anchor",href:"#azure-(azure)"},"#")],-1),Fe=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_CONTAINER_NAME")]),l("td",null,"Azure Storage container"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_ACCOUNT_NAME")]),l("td",null,"Azure Storage account name"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_ACCOUNT_KEY")]),l("td",null,"Azure Storage key"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_ENDPOINT")]),l("td",null,"Azure URL"),l("td",null,[l("code",null,"https://{ACCOUNT_KEY}.blob.core.windows.net")])])])],-1),We=l("h3",{id:"google-cloud-storage-(gcs)",tabindex:"-1"},[e("Google Cloud Storage ("),l("code",null,"gcs"),e(") "),l("a",{class:"header-anchor",href:"#google-cloud-storage-(gcs)"},"#")],-1),qe=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_KEY_FILENAME")]),l("td",null,"Path to key file on disk"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"STORAGE_<LOCATION>_BUCKET")]),l("td",null,"Google Cloud Storage bucket"),l("td",null,"\u2013")])])],-1),Ye=l("h3",{id:"example%3A-multiple-storage-adapters",tabindex:"-1"},[e("Example: Multiple Storage Adapters "),l("a",{class:"header-anchor",href:"#example%3A-multiple-storage-adapters"},"#")],-1),Ke=l("p",null,"Below showcases a CSV of storage location names, with a config block for each:",-1),ze=l("pre",null,[l("code",null,`STORAGE_LOCATIONS="local,aws"
-
-STORAGE_LOCAL_DRIVER="local"
-STORAGE_LOCAL_ROOT="local"
-
-STORAGE_AWS_KEY="tp15c...510vk"
-STORAGE_AWS_SECRET="yk29b...b932n"
-STORAGE_AWS_REGION="us-east-2"
-STORAGE_AWS_BUCKET="my-files"
-`)],-1),Xe=l("h3",{id:"metadata",tabindex:"-1"},[e("Metadata "),l("a",{class:"header-anchor",href:"#metadata"},"#")],-1),Ze=l("p",null,[e("When uploading an image, Directus persists the "),l("em",null,"description, title, and tags"),e(" from available EXIF metadata. For security purposes, collection of additional metadata must be configured:")],-1),Je=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"FILE_METADATA_ALLOW_LIST")]),l("td",null,[e("A comma-separated list of metadata keys to collect during file upload. Use "),l("code",null,"*"),e(" for all"),l("sup",null,"[1]"),e(".")]),l("td",null,"ifd0.Make,ifd0.Model,exif.FNumber,exif.ExposureTime,exif.FocalLength,exif.ISO")])])],-1),Qe=l("sup",null,"[1]",-1),$e=e(": Extracting all metadata might cause memory issues when the file has an unusually large set of metadata "),ln=l("h2",{id:"assets",tabindex:"-1"},[e("Assets "),l("a",{class:"header-anchor",href:"#assets"},"#")],-1),en=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"ASSETS_CACHE_TTL")]),l("td",null,[e("How long assets will be cached for in the browser. Sets the "),l("code",null,"max-age"),e(" value of the "),l("code",null,"Cache-Control"),e(" header.")]),l("td",null,[l("code",null,"30m")])]),l("tr",null,[l("td",null,[l("code",null,"ASSETS_TRANSFORM_MAX_CONCURRENT")]),l("td",null,"How many file transformations can be done simultaneously"),l("td",null,[l("code",null,"4")])]),l("tr",null,[l("td",null,[l("code",null,"ASSETS_TRANSFORM_IMAGE_MAX_DIMENSION")]),l("td",null,"The max pixel dimensions size (width/height) that is allowed to be transformed"),l("td",null,[l("code",null,"6000")])]),l("tr",null,[l("td",null,[l("code",null,"ASSETS_TRANSFORM_MAX_OPERATIONS")]),l("td",null,"The max number of transform operations that is allowed to be processed (excludes saved presets)"),l("td",null,[l("code",null,"5")])]),l("tr",null,[l("td",null,[l("code",null,"ASSETS_CONTENT_SECURITY_POLICY")]),l("td",null,[e("Custom overrides for the Content-Security-Policy header. See "),l("a",{href:"https://helmetjs.github.io",target:"_blank",rel:"noopener noreferrer"},"helmet\u2019s documentation"),e(" for more information.")]),l("td",null,"\u2013")])])],-1),nn=l("p",null,"Image transformations can be fairly heavy on memory usage. If you\u2019re using a system with 1GB or less available memory, we recommend lowering the allowed concurrent transformations to prevent you from overflowing your server.",-1),tn=l("h2",{id:"authentication",tabindex:"-1"},[e("Authentication "),l("a",{class:"header-anchor",href:"#authentication"},"#")],-1),on=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"AUTH_PROVIDERS")]),l("td",null,"A comma-separated list of auth providers."),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"AUTH_DISABLE_DEFAULT")]),l("td",null,"Disable the default auth provider"),l("td",null,[l("code",null,"false")])])])],-1),sn=l("p",null,"For each auth provider you list, you must also provide the following configuration:",-1),un=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_DRIVER")]),l("td",null,[e("Which driver to use, either "),l("code",null,"local"),e(", "),l("code",null,"oauth2"),e(", "),l("code",null,"openid"),e(", "),l("code",null,"ldap")]),l("td",null,"\u2013")])])],-1),an=l("p",null,"You may also be required to specify additional variables depending on the auth driver. See configuration details below.",-1),dn=l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"Multiple Providers"),l("p",null,"Directus users can only authenticate using the auth provider they are created with. It is not possible to authenticate with multiple providers for the same user.")],-1),rn=l("h3",{id:"local-(local)-1",tabindex:"-1"},[e("Local ("),l("code",null,"local"),e(") "),l("a",{class:"header-anchor",href:"#local-(local)-1"},"#")],-1),cn=l("p",null,"The default Directus email/password authentication flow.",-1),hn=l("p",null,"No additional configuration required.",-1),_n=l("h3",{id:"sso-(oauth2-and-openid)",tabindex:"-1"},[e("SSO ("),l("code",null,"oauth2"),e(" and "),l("code",null,"openid"),e(") "),l("a",{class:"header-anchor",href:"#sso-(oauth2-and-openid)"},"#")],-1),pn=l("p",null,"Directus\u2019 SSO integrations provide powerful alternative ways to authenticate into your project. Directus will ask you to login on the external service, and return authenticated with a Directus account linked to that service.",-1),fn=l("p",null,[e("For example, you can login to Directus using a github account by creating an "),l("a",{href:"https://github.com/settings/developers",target:"_blank",rel:"noopener noreferrer"},"OAuth 2.0 app in GitHub"),e(" and adding the following configuration to Directus:")],-1),mn=l("pre",null,[l("code",null,`AUTH_PROVIDERS="github"
-
-AUTH_GITHUB_DRIVER="oauth2"
-AUTH_GITHUB_CLIENT_ID="99d3...c3c4"
-AUTH_GITHUB_CLIENT_SECRET="34ae...f963"
-AUTH_GITHUB_AUTHORIZE_URL="https://github.com/login/oauth/authorize"
-AUTH_GITHUB_ACCESS_URL="https://github.com/login/oauth/access_token"
-AUTH_GITHUB_PROFILE_URL="https://api.github.com/user"
-`)],-1),En=e("More example SSO configurations "),gn=e("can be found here"),An=e("."),Tn=l("div",{class:"warning hint"},[l("div",{class:"hint-title"},"PUBLIC_URL"),l("p",null,[e("These flows rely on the "),l("code",null,"PUBLIC_URL"),e(" variable for redirecting. Ensure the variable is correctly configured.")])],-1),bn=l("h3",{id:"oauth-2.0",tabindex:"-1"},[e("OAuth 2.0 "),l("a",{class:"header-anchor",href:"#oauth-2.0"},"#")],-1),Rn=l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])],-1),Sn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_CLIENT_ID")]),l("td",null,"Client identifier for the OAuth provider."),l("td",null,"\u2013")],-1),On=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_CLIENT_SECRET")]),l("td",null,"Client secret for the OAuth provider."),l("td",null,"\u2013")],-1),In=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_SCOPE")]),l("td",null,"A white-space separated list of permissions to request."),l("td",null,[l("code",null,"email")])],-1),yn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_AUTHORIZE_URL")]),l("td",null,"Authorization page URL of the OAuth provider."),l("td",null,"\u2013")],-1),Dn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_ACCESS_URL")]),l("td",null,"Access token URL of the OAuth provider."),l("td",null,"\u2013")],-1),Cn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_PROFILE_URL")]),l("td",null,"User profile URL of the OAuth provider."),l("td",null,"\u2013")],-1),vn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_IDENTIFIER_KEY")]),l("td",null,[e("User profile identifier key "),l("sup",null,"[1]"),e(". Will default to "),l("code",null,"EMAIL_KEY"),e(".")]),l("td",null,"\u2013")],-1),Ln=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_EMAIL_KEY")]),l("td",null,"User profile email key."),l("td",null,[l("code",null,"email")])],-1),wn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_FIRST_NAME_KEY")]),l("td",null,"User profile first name key."),l("td",null,"\u2013")],-1),Un=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_LAST_NAME_KEY")]),l("td",null,"User profile last name key."),l("td",null,"\u2013")],-1),Nn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_ALLOW_PUBLIC_REGISTRATION")]),l("td",null,"Automatically create accounts for authenticating users."),l("td",null,[l("code",null,"false")])],-1),Hn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_DEFAULT_ROLE_ID")]),l("td",null,"A Directus role ID to assign created users."),l("td",null,"\u2013")],-1),Pn=l("td",null,[l("code",null,"AUTH_<PROVIDER>_ICON")],-1),xn=e("SVG icon to display with the login link. "),Vn=e("See options here"),Mn=e("."),jn=l("td",null,[l("code",null,"account_circle")],-1),kn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_PARAMS")]),l("td",null,"Custom query parameters applied to the authorization URL."),l("td",null,"\u2013")],-1),Bn=l("sup",null,"[1]",-1),Gn=e(' When authenticating, Directus will match the identifier value from the external user profile to a Directus users "External Identifier". '),Fn=l("h3",{id:"openid",tabindex:"-1"},[e("OpenID "),l("a",{class:"header-anchor",href:"#openid"},"#")],-1),Wn=l("p",null,"OpenID is an authentication protocol built on OAuth 2.0, and should be preferred over standard OAuth 2.0 where possible.",-1),qn=l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])],-1),Yn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_CLIENT_ID")]),l("td",null,"Client identifier for the external service."),l("td",null,"\u2013")],-1),Kn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_CLIENT_SECRET")]),l("td",null,"Client secret for the external service."),l("td",null,"\u2013")],-1),zn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_SCOPE")]),l("td",null,"A white-space separated list of permissions to request."),l("td",null,[l("code",null,"openid profile email")])],-1),Xn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_ISSUER_URL")]),l("td",null,[e("OpenID "),l("code",null,".well-known"),e(" discovery document URL of the external service.")]),l("td",null,"\u2013")],-1),Zn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_IDENTIFIER_KEY")]),l("td",null,[e("User profile identifier key "),l("sup",null,"[1]"),e(".")]),l("td",null,[l("code",null,"sub"),l("sup",null,"[2]")])],-1),Jn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_ALLOW_PUBLIC_REGISTRATION")]),l("td",null,"Automatically create accounts for authenticating users."),l("td",null,[l("code",null,"false")])],-1),Qn=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_REQUIRE_VERIFIED_EMAIL")]),l("td",null,"Require created users to have a verified email address."),l("td",null,[l("code",null,"false")])],-1),$n=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_DEFAULT_ROLE_ID")]),l("td",null,"A Directus role ID to assign created users."),l("td",null,"\u2013")],-1),lt=l("td",null,[l("code",null,"AUTH_<PROVIDER>_ICON")],-1),et=e("SVG icon to display with the login link. "),nt=e("See options here"),tt=e("."),ot=l("td",null,[l("code",null,"account_circle")],-1),st=l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_PARAMS")]),l("td",null,"Custom query parameters applied to the authorization URL."),l("td",null,"\u2013")],-1),ut=l("sup",null,"[1]",-1),at=e(' When authenticating, Directus will match the identifier value from the external user profile to a Directus users "External Identifier". '),dt=l("sup",null,"[2]",-1),rt=e(" `sub` represents a unique user identifier defined by the OpenID provider. For users not relying on `PUBLIC_REGISTRATION` it is recommended to use a human-readable identifier, such as `email`. "),it=l("h3",{id:"ldap-(ldap)",tabindex:"-1"},[e("LDAP ("),l("code",null,"ldap"),e(") "),l("a",{class:"header-anchor",href:"#ldap-(ldap)"},"#")],-1),ct=l("p",null,"LDAP allows Active Directory users to authenticate and use Directus without having to be manually configured. User information and roles will be assigned from Active Directory.",-1),ht=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_CLIENT_URL")]),l("td",null,"LDAP connection URL."),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_BIND_DN")]),l("td",null,[e("Bind user "),l("sup",null,"[1]"),e(" distinguished name.")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_BIND_PASSWORD")]),l("td",null,"Bind user password."),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_USER_DN")]),l("td",null,"Directory path containing users."),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_USER_ATTRIBUTE")]),l("td",null,"Attribute to identify the user."),l("td",null,[l("code",null,"cn")])]),l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_USER_SCOPE")]),l("td",null,[e("Scope of the user search, either "),l("code",null,"base"),e(", "),l("code",null,"one"),e(", "),l("code",null,"sub"),e(),l("sup",null,"[2]"),e(".")]),l("td",null,[l("code",null,"one")])]),l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_MAIL_ATTRIBUTE")]),l("td",null,"User email attribute."),l("td",null,[l("code",null,"mail")])]),l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_FIRST_NAME_ATTRIBUTE")]),l("td",null,"User first name attribute."),l("td",null,[l("code",null,"givenName")])]),l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_LAST_NAME_ATTRIBUTE")]),l("td",null,"User last name attribute."),l("td",null,[l("code",null,"sn")])]),l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_GROUP_DN"),l("sup",null,"[3]")]),l("td",null,"Directory path containing groups."),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_GROUP_ATTRIBUTE")]),l("td",null,"Attribute to identify user as a member of a group."),l("td",null,[l("code",null,"member")])]),l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_GROUP_SCOPE")]),l("td",null,[e("Scope of the group search, either "),l("code",null,"base"),e(", "),l("code",null,"one"),e(", "),l("code",null,"sub"),e(),l("sup",null,"[2]"),e(".")]),l("td",null,[l("code",null,"one")])]),l("tr",null,[l("td",null,[l("code",null,"AUTH_<PROVIDER>_DEFAULT_ROLE_ID")]),l("td",null,"A fallback Directus role ID to assign created users."),l("td",null,"\u2013")])])],-1),_t=l("sup",null,"[1]",-1),pt=e(" The bind user must have permission to query users and groups to perform authentication. Anonymous binding can by achieved by setting an empty value for `BIND_DN` and `BIND_PASSWORD`. "),ft=l("sup",null,"[2]",-1),mt=e(" The scope defines the following behaviors: "),Et=l("ul",null,[l("li",null,[l("code",null,"base"),e(": Limits the scope to a single object defined by the associated DN.")]),l("li",null,[l("code",null,"one"),e(": Searches all objects within the associated DN.")]),l("li",null,[l("code",null,"sub"),e(": Searches all objects and sub-objects within the associated DN.")])],-1),gt=l("sup",null,"[3]",-1),At=e(" If `GROUP_DN` is specified, the user's role will always be updated on authentication to a matching group configured in AD, or fallback to the `DEFAULT_ROLE_ID`. "),Tt=l("h3",{id:"example%3A-ldap",tabindex:"-1"},[e("Example: LDAP "),l("a",{class:"header-anchor",href:"#example%3A-ldap"},"#")],-1),bt=l("pre",null,[l("code",null,`AUTH_PROVIDERS="ldap"
-
-AUTH_LDAP_DRIVER="ldap"
-AUTH_LDAP_CLIENT_URL="ldap://ldap.directus.io"
-AUTH_LDAP_BIND_DN="CN=Bind User,OU=Users,DC=ldap,DC=directus,DC=io"
-AUTH_LDAP_BIND_PASSWORD="p455w0rd"
-AUTH_LDAP_USER_DN="OU=Users,DC=ldap,DC=directus,DC=io"
-AUTH_LDAP_GROUP_DN="OU=Groups,DC=ldap,DC=directus,DC=io"
-`)],-1),Rt=l("h3",{id:"example%3A-multiple-auth-providers",tabindex:"-1"},[e("Example: Multiple Auth Providers "),l("a",{class:"header-anchor",href:"#example%3A-multiple-auth-providers"},"#")],-1),St=l("p",null,"You can configure multiple providers for handling authentication in Directus. This allows for different options when logging in. To do this, provide a comma-separated list of provider names, and a config block for each provider:",-1),Ot=l("pre",null,[l("code",null,`AUTH_PROVIDERS="google,facebook"
-
-AUTH_GOOGLE_DRIVER="openid"
-AUTH_GOOGLE_CLIENT_ID="830d...29sd"
-AUTH_GOOGLE_CLIENT_SECRET="la23...4k2l"
-AUTH_GOOGLE_ISSUER_URL="https://accounts.google.com/.well-known/openid-configuration"
-AUTH_GOOGLE_IDENTIFIER_KEY="email"
-AUTH_GOOGLE_ICON="google"
-
-AUTH_FACEBOOK_DRIVER="oauth2"
-AUTH_FACEBOOK_CLIENT_ID="830d...29sd"
-AUTH_FACEBOOK_CLIENT_SECRET="jd8x...685z"
-AUTH_FACEBOOK_AUTHORIZE_URL="https://www.facebook.com/dialog/oauth"
-AUTH_FACEBOOK_ACCESS_URL="https://graph.facebook.com/oauth/access_token"
-AUTH_FACEBOOK_PROFILE_URL="https://graph.facebook.com/me?fields=email"
-AUTH_FACEBOOK_ICON="facebook"
-`)],-1),It=l("h2",{id:"extensions",tabindex:"-1"},[e("Extensions "),l("a",{class:"header-anchor",href:"#extensions"},"#")],-1),yt=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"EXTENSIONS_PATH")]),l("td",null,"Path to your local extensions folder."),l("td",null,[l("code",null,"./extensions")])]),l("tr",null,[l("td",null,[l("code",null,"EXTENSIONS_AUTO_RELOAD")]),l("td",null,"Automatically reload extensions when they have changed."),l("td",null,[l("code",null,"false")])])])],-1),Dt=l("h2",{id:"messenger",tabindex:"-1"},[e("Messenger "),l("a",{class:"header-anchor",href:"#messenger"},"#")],-1),Ct=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"MESSENGER_STORE")]),l("td",null,[e("One of "),l("code",null,"memory"),e(", "),l("code",null,"redis"),l("sup",null,"[1]")]),l("td",null,[l("code",null,"memory")])]),l("tr",null,[l("td",null,[l("code",null,"MESSENGER_NAMESPACE")]),l("td",null,"How to scope the channels in Redis"),l("td",null,[l("code",null,"directus")])]),l("tr",null,[l("td",null,[l("code",null,"MESSENGER_REDIS_*")]),l("td",null,"The Redis configuration for the pubsub connection"),l("td",null,"\u2013")])])],-1),vt=l("sup",null,"[1]",-1),Lt=e(" `redis` should be used in load-balanced installations of Directus "),wt=l("h2",{id:"email",tabindex:"-1"},[e("Email "),l("a",{class:"header-anchor",href:"#email"},"#")],-1),Ut=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"EMAIL_VERIFY_SETUP")]),l("td",null,"Check if email setup is properly configured."),l("td",null,[l("code",null,"true")])]),l("tr",null,[l("td",null,[l("code",null,"EMAIL_FROM")]),l("td",null,"Email address from which emails are sent."),l("td",null,[l("code",null,"no-reply@directus.io")])]),l("tr",null,[l("td",null,[l("code",null,"EMAIL_TRANSPORT")]),l("td",null,[e("What to use to send emails. One of "),l("code",null,"sendmail"),e(", "),l("code",null,"smtp"),e(", "),l("code",null,"mailgun"),e(", "),l("code",null,"ses"),e(".")]),l("td",null,[l("code",null,"sendmail")])])])],-1),Nt=l("p",null,[e("Based on the "),l("code",null,"EMAIL_TRANSPORT"),e(" used, you must also provide the following configurations:")],-1),Ht=l("h3",{id:"sendmail-(sendmail)",tabindex:"-1"},[e("Sendmail ("),l("code",null,"sendmail"),e(") "),l("a",{class:"header-anchor",href:"#sendmail-(sendmail)"},"#")],-1),Pt=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"EMAIL_SENDMAIL_NEW_LINE")]),l("td",null,"What new line style to use in sendmail."),l("td",null,[l("code",null,"unix")])]),l("tr",null,[l("td",null,[l("code",null,"EMAIL_SENDMAIL_PATH")]),l("td",null,"Path to your sendmail executable."),l("td",null,[l("code",null,"/usr/sbin/sendmail")])])])],-1),xt=l("h3",{id:"smtp-(smtp)",tabindex:"-1"},[e("SMTP ("),l("code",null,"smtp"),e(") "),l("a",{class:"header-anchor",href:"#smtp-(smtp)"},"#")],-1),Vt=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"EMAIL_SMTP_HOST")]),l("td",null,"SMTP Host"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"EMAIL_SMTP_PORT")]),l("td",null,"SMTP Port"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"EMAIL_SMTP_USER")]),l("td",null,"SMTP User"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"EMAIL_SMTP_PASSWORD")]),l("td",null,"SMTP Password"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"EMAIL_SMTP_POOL")]),l("td",null,"Use SMTP pooling"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"EMAIL_SMTP_SECURE")]),l("td",null,"Enable TLS"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"EMAIL_SMTP_IGNORE_TLS")]),l("td",null,"Ignore TLS"),l("td",null,"\u2013")])])],-1),Mt=l("h3",{id:"mailgun-(mailgun)",tabindex:"-1"},[e("Mailgun ("),l("code",null,"mailgun"),e(") "),l("a",{class:"header-anchor",href:"#mailgun-(mailgun)"},"#")],-1),jt=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"EMAIL_MAILGUN_API_KEY")]),l("td",null,"Your Mailgun API key."),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"EMAIL_MAILGUN_DOMAIN")]),l("td",null,[e("A domain from "),l("a",{href:"https://app.mailgun.com/app/sending/domains",target:"_blank",rel:"noopener noreferrer"},"your Mailgun account")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"EMAIL_MAILGUN_HOST")]),l("td",null,"Allows you to specify a custom host."),l("td",null,[l("code",null,"api.mailgun.net")])])])],-1),kt=l("h3",{id:"aws-ses-(ses)",tabindex:"-1"},[e("AWS SES ("),l("code",null,"ses"),e(") "),l("a",{class:"header-anchor",href:"#aws-ses-(ses)"},"#")],-1),Bt=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"EMAIL_SES_CREDENTIALS__ACCESS_KEY_ID")]),l("td",null,"Your AWS SES access key. ID."),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"EMAIL_SES_CREDENTIALS__SECRET_ACCESS_KEY")]),l("td",null,"Your AWS SES secret key."),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"EMAIL_SES_REGION")]),l("td",null,"Your AWS SES region."),l("td",null,"\u2013")])])],-1),Gt=l("h2",{id:"admin-account",tabindex:"-1"},[e("Admin Account "),l("a",{class:"header-anchor",href:"#admin-account"},"#")],-1),Ft=l("p",null,[e("If you\u2019re relying on Docker and/or the "),l("code",null,"directus bootstrap"),e(" CLI command, you can pass the following two environment variables to automatically configure the first user:")],-1),Wt=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"ADMIN_EMAIL")]),l("td",null,[e("The email address of the first user that\u2019s automatically created when using "),l("code",null,"directus bootstrap"),e(".")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"ADMIN_PASSWORD")]),l("td",null,[e("The password of the first user that\u2019s automatically created when using "),l("code",null,"directus bootstrap"),e(".")]),l("td",null,"\u2013")])])],-1),qt=l("h2",{id:"telemetry",tabindex:"-1"},[e("Telemetry "),l("a",{class:"header-anchor",href:"#telemetry"},"#")],-1),Yt=l("p",null,"To more accurately gauge the frequency of installation, version fragmentation, and general size of the userbase, Directus collects little and anonymized data about your environment. You can easily opt-out with the following environment variable:",-1),Kt=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"TELEMETRY")]),l("td",null,"Allow Directus to collect anonymized data about your environment."),l("td",null,[l("code",null,"true")])])])],-1),zt=l("h2",{id:"limits-%26-optimizations",tabindex:"-1"},[e("Limits & Optimizations "),l("a",{class:"header-anchor",href:"#limits-%26-optimizations"},"#")],-1),Xt=l("p",null,"Allows you to configure hard technical limits, to prevent abuse and optimize for your particular server environment.",-1),Zt=l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"RELATIONAL_BATCH_SIZE")]),l("td",null,"How many rows are read into memory at a time when constructing nested relational datasets"),l("td",null,"25000")]),l("tr",null,[l("td",null,[l("code",null,"EXPORT_BATCH_SIZE")]),l("td",null,"How many rows are read into memory at a time when constructing exports"),l("td",null,"5000")])])],-1),eo="Configuration Options",no=!1,to={name:"config-options",setup(Jt,{expose:a}){const s={title:"Configuration Options",modularExtension:!1};return a({frontmatter:s}),(Qt,$t)=>{const t=u("router-link"),d=u("docs-wrapper");return r(),i(d,{frontmatter:s},{default:n(()=>[l("div",c,[h,_,p,f,m,E,g,A,T,b,R,S,O,I,y,D,C,v,L,w,U,N,H,P,x,V,M,j,k,B,G,F,W,q,Y,K,z,X,Z,J,Q,$,ll,el,nl,tl,ol,sl,l("table",null,[ul,l("tbody",null,[al,dl,rl,il,cl,hl,_l,pl,l("tr",null,[fl,l("td",null,[ml,o(t,{to:"/docs/reference/authentication/#request-password-reset"},{default:n(()=>[El,gl,Al]),_:1})]),Tl]),l("tr",null,[bl,l("td",null,[Rl,o(t,{to:"/docs/reference/system/users/#invite-a-new-user"},{default:n(()=>[Sl,Ol,Il]),_:1})]),yl]),Dl,Cl,vl,Ll,wl,Ul,Nl])]),Hl,Pl,xl,l("p",null,[Vl,Ml,jl,o(t,{to:"/docs/reference/system/utilities/#generate-a-hash"},{default:n(()=>[kl]),_:1}),Bl]),Gl,Fl,Wl,ql,Yl,Kl,zl,Xl,Zl,Jl,Ql,$l,le,ee,ne,te,oe,se,ue,ae,de,re,ie,ce,he,_e,pe,fe,me,Ee,ge,Ae,Te,be,Re,Se,Oe,Ie,ye,De,Ce,ve,Le,we,Ue,Ne,He,Pe,xe,Ve,Me,je,ke,Be,Ge,Fe,We,qe,Ye,Ke,ze,Xe,Ze,Je,Qe,$e,ln,en,nn,tn,on,sn,un,an,dn,rn,cn,hn,_n,pn,fn,mn,l("p",null,[En,o(t,{to:"/docs/self-hosted/sso-examples/"},{default:n(()=>[gn]),_:1}),An]),Tn,bn,l("table",null,[Rn,l("tbody",null,[Sn,On,In,yn,Dn,Cn,vn,Ln,wn,Un,Nn,Hn,l("tr",null,[Pn,l("td",null,[xn,o(t,{to:"/docs/getting-started/glossary/#icons"},{default:n(()=>[Vn]),_:1}),Mn]),jn]),kn])]),Bn,Gn,Fn,Wn,l("table",null,[qn,l("tbody",null,[Yn,Kn,zn,Xn,Zn,Jn,Qn,$n,l("tr",null,[lt,l("td",null,[et,o(t,{to:"/docs/getting-started/glossary/#icons"},{default:n(()=>[nt]),_:1}),tt]),ot]),st])]),ut,at,dt,rt,it,ct,ht,_t,pt,ft,mt,Et,gt,At,Tt,bt,Rt,St,Ot,It,yt,Dt,Ct,vt,Lt,wt,Ut,Nt,Ht,Pt,xt,Vt,Mt,jt,kt,Bt,Gt,Ft,Wt,qt,Yt,Kt,zt,Xt,Zt])]),_:1})}}};export{to as default,no as modularExtension,eo as title};