npm - @directus/app - Versions diffs - 9.0.0-rc.98 → 9.0.0-rc.99 - Mend

@directus/app 9.0.0-rc.98 → 9.0.0-rc.99

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (399) hide show

package/dist/index.html CHANGED Viewed

@@ -133,11 +133,11 @@
 		/>
 		<title>Loading&hellip;</title>
 		<style id="custom-css"></style>
-		<script type="module" crossorigin src="index.9cda602b.js"></script>
-		<link rel="modulepreload" href="assets/vendor.62143b15.js">
-		<link rel="modulepreload" href="assets/use-sync.25413196.js">
-		<link rel="stylesheet" href="assets/vendor.de5758fd.css">
-		<link rel="stylesheet" href="assets/index.3339c532.css">
+		<script type="module" crossorigin src="index.514c2a9a.js"></script>
+		<link rel="modulepreload" href="assets/vendor.a626ab9c.js">
+		<link rel="modulepreload" href="assets/use-sync.fa2fe3b0.js">
+		<link rel="stylesheet" href="assets/vendor.fe7856f0.css">
+		<link rel="stylesheet" href="assets/index.d07f63e3.css">
 	</head>
 	<body class="light">
 		<noscript>

package/dist/vue-i18n.c5bba31b.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ import{d6 as e,d7 as r,d8 as t,d9 as d,c as o,u as m,da as n}from"./assets/vendor.a626ab9c.js";export{e as DatetimeFormat,r as NumberFormat,t as Translation,d as VERSION,o as createI18n,m as useI18n,n as vTDirective};

package/dist/vue-router.ba0fd454.js ADDED Viewed

@@ -0,0 +1 @@

+ import{db as s,dc as r,X as t,dd as o,de as i,ar as u,df as d,dg as y,as as c,dh as n,di as R,R as p,ai as L,dj as f,dk as h,dl as v,dm as K,dn as b,aG as g,Z as m,U as H,dp as T}from"./assets/vendor.a626ab9c.js";export{s as NavigationFailureType,r as RouterLink,t as RouterView,o as START_LOCATION,i as createMemoryHistory,u as createRouter,d as createRouterMatcher,y as createWebHashHistory,c as createWebHistory,n as isNavigationFailure,R as matchedRouteKey,p as onBeforeRouteLeave,L as onBeforeRouteUpdate,f as parseQuery,h as routeLocationKey,v as routerKey,K as routerViewLocationKey,b as stringifyQuery,g as useLink,m as useRoute,H as useRouter,T as viewDepthKey};

package/dist/vue.010be4a3.js ADDED Viewed

@@ -0,0 +1 @@

+ import{bX as s,bY as t,cM as o,Y as c,bZ as r,cN as n,b_ as i,b$ as d,aD as l,c0 as p,aC as m,aE as f,bK as u,c1 as S,c2 as v,d3 as R,d4 as b,c3 as h,c4 as C,bJ as w,o as y,bz as E,q as g,I as T,V as k,B as x,c5 as D,c6 as M,c7 as P,bL as V,D as A,aJ as H,P as N,t as B,cO as z,bk as F,n as U,bM as K,c8 as I,c9 as W,ca as J,bN as L,cb as O,cP as j,cQ as q,cc as G,cR as Q,cd as Y,N as _,W as $,ce as X,bO as Z,cf as ee,bP as ae,T as se,cg as te,cS as oe,cT as ce,cU as re,ak as ne,ch as ie,ci as de,cV as le,cj as pe,O as me,al as fe,K as ue,M as Se,av as ve,bC as Re,ac as be,ad as he,ck as Ce,bD as we,cl as ye,Q as Ee,cm as ge,cn as Te,cW as ke,co as xe,aa as De,cp as Me,p as Pe,a2 as Ve,S as Ae,cX as He,a1 as Ne,cq as Be,z as ze,cY as Fe,v as Ue,cr as Ke,bQ as Ie,$ as We,E as Je,r as Le,F as Oe,L as je,cs as qe,ct as Ge,cu as Qe,cv as Ye,cw as _e,cZ as $e,c_ as Xe,s as Ze,cx as ea,cy as aa,c$ as sa,C as ta,d5 as oa,aF as ca,d0 as ra,d1 as na,A as ia,cz as da,d2 as la,ae as pa,cA as ma,bR as fa,bS as ua,cB as Sa,cC as va,cD as Ra,bT as ba,bU as ha,bV as Ca,bW as wa,aH as ya,J as Ea,cE as ga,cF as Ta,y as ka,a6 as xa,cG as Da,cH as Ma,cI as Pa,w as Va,cJ as Aa,G as Ha,_ as Na,cK as Ba,H as za,cL as Fa}from"./assets/vendor.a626ab9c.js";export{s as BaseTransition,t as Comment,o as EffectScope,c as Fragment,r as KeepAlive,n as ReactiveEffect,i as Static,d as Suspense,l as Teleport,p as Text,m as Transition,f as TransitionGroup,u as VueElement,S as callWithAsyncErrorHandling,v as callWithErrorHandling,R as camelize,b as capitalize,h as cloneVNode,C as compatUtils,w as compile,y as computed,E as createApp,g as createBlock,T as createCommentVNode,k as createElementBlock,x as createElementVNode,D as createHydrationRenderer,M as createPropsRestProxy,P as createRenderer,V as createSSRApp,A as createSlots,H as createStaticVNode,N as createTextVNode,B as createVNode,z as customRef,F as defineAsyncComponent,U as defineComponent,K as defineCustomElement,I as defineEmits,W as defineExpose,J as defineProps,L as defineSSRCustomElement,O as devtools,j as effect,q as effectScope,G as getCurrentInstance,Q as getCurrentScope,Y as getTransitionRawChildren,_ as guardReactiveProps,$ as h,X as handleError,Z as hydrate,ee as initCustomFormatter,ae as initDirectivesForSSR,se as inject,te as isMemoSame,oe as isProxy,ce as isReactive,re as isReadonly,ne as isRef,ie as isRuntimeOnly,de as isVNode,le as markRaw,pe as mergeDefaults,me as mergeProps,fe as nextTick,ue as normalizeClass,Se as normalizeProps,ve as normalizeStyle,Re as onActivated,be as onBeforeMount,he as onBeforeUnmount,Ce as onBeforeUpdate,we as onDeactivated,ye as onErrorCaptured,Ee as onMounted,ge as onRenderTracked,Te as onRenderTriggered,ke as onScopeDispose,xe as onServerPrefetch,De as onUnmounted,Me as onUpdated,Pe as openBlock,Ve as popScopeId,Ae as provide,He as proxyRefs,Ne as pushScopeId,Be as queuePostFlushCb,ze as reactive,Fe as readonly,Ue as ref,Ke as registerRuntimeCompiler,Ie as render,We as renderList,Je as renderSlot,Le as resolveComponent,Oe as resolveDirective,je as resolveDynamicComponent,qe as resolveFilter,Ge as resolveTransitionHooks,Qe as setBlockTracking,Ye as setDevtoolsHook,_e as setTransitionHooks,$e as shallowReactive,Xe as shallowReadonly,Ze as shallowRef,ea as ssrContextKey,aa as ssrUtils,sa as stop,ta as toDisplayString,oa as toHandlerKey,ca as toHandlers,ra as toRaw,na as toRef,ia as toRefs,da as transformVNodeArgs,la as triggerRef,pa as unref,ma as useAttrs,fa as useCssModule,ua as useCssVars,Sa as useSSRContext,va as useSlots,Ra as useTransitionState,ba as vModelCheckbox,ha as vModelDynamic,Ca as vModelRadio,wa as vModelSelect,ya as vModelText,Ea as vShow,ga as version,Ta as warn,ka as watch,xa as watchEffect,Da as watchPostEffect,Ma as watchSyncEffect,Pa as withAsyncContext,Va as withCtx,Aa as withDefaults,Ha as withDirectives,Na as withKeys,Ba as withMemo,za as withModifiers,Fa as withScopeId};

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
 	"name": "@directus/app",
-	"version": "9.0.0-rc.98",
+	"version": "9.0.0-rc.99",
 	"private": false,
 	"description": "Directus is an Open-Source Headless CMS & API for Managing Custom Databases",
 	"author": "Rijk van Zanten <rijkvanzanten@me.com>",
@@ -22,17 +22,19 @@
 		"build": "vite build",
 		"serve": "vite preview"
 	},
-	"gitHead": "0dd0e1b1c1ccac3a502dc6ed9f81ecd881cd650f",
+	"gitHead": "7c88f038844d6a64e36c9848fe95074aae7fdd0c",
 	"devDependencies": {
-		"@directus/docs": "9.0.0-rc.98",
-		"@directus/extensions-sdk": "9.0.0-rc.98",
-		"@directus/format-title": "9.0.0-rc.98",
-		"@directus/shared": "9.0.0-rc.98",
-		"@fullcalendar/core": "5.9.0",
-		"@fullcalendar/daygrid": "5.9.0",
-		"@fullcalendar/interaction": "5.9.0",
-		"@fullcalendar/list": "5.9.0",
-		"@fullcalendar/timegrid": "5.9.0",
+		"@directus/docs": "9.0.0-rc.99",
+		"@directus/extensions-sdk": "9.0.0-rc.99",
+		"@directus/format-title": "9.0.0-rc.99",
+		"@directus/shared": "9.0.0-rc.99",
+		"@fortawesome/fontawesome-svg-core": "1.2.36",
+		"@fortawesome/free-brands-svg-icons": "5.15.4",
+		"@fullcalendar/core": "5.10.0",
+		"@fullcalendar/daygrid": "5.10.0",
+		"@fullcalendar/interaction": "5.10.0",
+		"@fullcalendar/list": "5.10.0",
+		"@fullcalendar/timegrid": "5.10.0",
 		"@mapbox/mapbox-gl-draw": "1.3.0",
 		"@mapbox/mapbox-gl-draw-static-mode": "1.0.1",
 		"@mapbox/mapbox-gl-geocoder": "4.7.4",
@@ -49,7 +51,7 @@
 		"@types/diff": "5.0.1",
 		"@types/dompurify": "2.3.1",
 		"@types/geojson": "7946.0.8",
-		"@types/lodash": "4.14.175",
+		"@types/lodash": "4.14.176",
 		"@types/mapbox__mapbox-gl-draw": "1.2.3",
 		"@types/mapbox__mapbox-gl-geocoder": "4.7.1",
 		"@types/markdown-it": "12.2.3",
@@ -80,7 +82,7 @@
 		"mitt": "3.0.0",
 		"nanoid": "3.1.30",
 		"p-queue": "7.1.0",
-		"pinia": "2.0.0-rc.13",
+		"pinia": "2.0.0-rc.14",
 		"prettier": "2.4.1",
 		"pretty-ms": "7.0.1",
 		"qrcode": "1.4.4",
@@ -88,8 +90,8 @@
 		"sass": "1.43.2",
 		"tinymce": "5.10.0",
 		"typescript": "4.4.4",
-		"vite": "2.6.7",
-		"vite-plugin-md": "0.11.1",
+		"vite": "2.6.10",
+		"vite-plugin-md": "0.11.2",
 		"vue": "3.2.20",
 		"vue-i18n": "9.1.9",
 		"vue-router": "4.0.12",

package/dist/@directus_extensions-sdk.caa1292f.js DELETED Viewed

@@ -1 +0,0 @@

- import{o as u}from"./assets/vendor.62143b15.js";import{f as p,l,k as m,h as y,i as F,d as j,b,c as g,n as h,a as k,j as v,m as x,u as G}from"./assets/use-sync.25413196.js";function d(t,s){return{fieldGroups:u(()=>{const n={};for(const e in s)n[e]=[];return t.value.reduce((e,o)=>{for(const a in s)s[a](o)!==!1&&e[a].push(o);return e},n)})}}export{p as defineDisplay,l as defineEndpoint,m as defineHook,y as defineInterface,F as defineLayout,j as defineModule,b as getFieldsFromTemplate,g as getRelationType,h as useApi,k as useCollection,d as useFilterFields,v as useItems,x as useStores,G as useSync};

package/dist/assets/api-config.d4a334b4.js DELETED Viewed

@@ -1,53 +0,0 @@
-import{r as n,p as l,q as c,w as i,B as e,t as u,P as o}from"./vendor.62143b15.js";const h={class:"markdown-body"},d=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#cache"},"Cache")]),e("li",null,[e("a",{href:"#oauth-(single-sign-on-(sso)-%2F-openid)"},"oAuth (Single Sign-On (SSO) / OpenID)")]),e("li",null,[e("a",{href:"#file-storage"},"File Storage")]),e("li",null,[e("a",{href:"#rate-limiting"},"Rate Limiting")]),e("li",null,[e("a",{href:"#file-based-configuration"},"File-Based Configuration")])])])],-1),_=e("h2",{id:"cache"},[o("Cache "),e("a",{class:"header-anchor",href:"#cache"},"#")],-1),p=e("p",null,"Directus has a built-in way to do data-caching. Enabling this will cache the output of the request (based on the current user and exact query parameters used) into to configured cache storage location. This will drastically improve 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),f=e("p",null,[o("You can enable the data-cache with the "),e("code",null,"CACHE_ENABLED"),o(" environment variable.")],-1),g=e("h3",{id:"cache-store"},[o("Cache Store "),e("a",{class:"header-anchor",href:"#cache-store"},"#")],-1),m=e("p",null,[o("In bigger projects, you most likely don\u2019t want to rely on local memory to keep the caches. Instead, you can use the "),e("code",null,"CACHE_STORE"),o(" environment variable to tell Directus to use either "),e("code",null,"memcache"),o(" or "),e("code",null,"redis"),o(" to store the caches.")],-1),T=e("pre",null,[e("code",null,`CACHE_ENABLED="true"
-CACHE_STORE="redis"
-CACHE_REDIS="redis://@127.0.0.1"
-`)],-1),E=e("h3",{id:"auto-purging"},[o("Auto-Purging "),e("a",{class:"header-anchor",href:"#auto-purging"},"#")],-1),A=e("p",null,"Directus can automatically clear the caches whenever a create/update/delete action is performed. This allows you to keep the Directus API real-time, while still getting the performance benefits on quick subsequent reads.",-1),O=e("pre",null,[e("code",null,`CACHE_AUTO_PURGE="true"
-`)],-1),S=e("h3",{id:"ttl"},[o("TTL "),e("a",{class:"header-anchor",href:"#ttl"},"#")],-1),R=e("p",null,[o("Based on your project\u2019s 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\u2019t real-time (for example a website). "),e("code",null,"CACHE_TTL"),o(" uses "),e("a",{href:"https://www.npmjs.com/package/ms",target:"_blank",rel:"noopener noreferrer"},[e("code",null,"ms")]),o(" to parse the value, so you configure it using human readable values (like "),e("code",null,"2 days"),o(", "),e("code",null,"7 hrs"),o(", "),e("code",null,"5m"),o(").")],-1),y=e("pre",null,[e("code",null,`CACHE_TTL="1h"
-`)],-1),b=e("h3",{id:"assets"},[o("Assets "),e("a",{class:"header-anchor",href:"#assets"},"#")],-1),v=e("p",null,"The cache-control header for the /assets endpoint is separate from the regular data-cache. This is useful as it\u2019s often possible to cache assets for way longer than you would with the actual content.",-1),C=e("pre",null,[e("code",null,`ASSETS_CACHE_TTL="7d"
-`)],-1),I=e("h2",{id:"oauth-(single-sign-on-(sso)-%2F-openid)"},[o("oAuth (Single Sign-On (SSO) / OpenID) "),e("a",{class:"header-anchor",href:"#oauth-(single-sign-on-(sso)-%2F-openid)"},"#")],-1),w=e("p",null,"Directus\u2019 oAuth integration provides a powerful alternative way to authenticate into your project. Directus will ask you to login on the external service, and if your user exists in Directus, you\u2019ll be logged in automatically.",-1),L=e("p",null,[o("Directus relies on "),e("a",{href:"https://www.npmjs.com/package/grant",target:"_blank",rel:"noopener noreferrer"},[e("code",null,"grant")]),o(" for the handling of the oAuth flow. This means that there\u2019s hundreds of services that are supported out of the box. For example, enabling logging in through GitHub is as easy as creating an "),e("a",{href:"https://github.com/settings/developers",target:"_blank",rel:"noopener noreferrer"},"oAuth app in GitHub"),o(" and adding the following to Directus:")],-1),D=e("pre",null,[e("code",null,`OAUTH_PROVIDERS="github"
-OAUTH_GITHUB_KEY="99d3...c3c4"
-OAUTH_GITHUB_SECRET="34ae...f963"
-`)],-1),k=e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"PUBLIC_URL"),e("p",null,[o("The oAuth flow relies on the "),e("code",null,"PUBLIC_URL"),o(" variable for it\u2019s redirecting. Make sure that variable is configured correctly.")])],-1),U=e("h4",{id:"multiple-providers"},[o("Multiple Providers "),e("a",{class:"header-anchor",href:"#multiple-providers"},"#")],-1),G=e("p",null,[e("code",null,"OAUTH_PROVIDERS"),o(" accepts a CSV of providers, allowing you to specify multiple at the same time:")],-1),H=e("pre",null,[e("code",null,`OAUTH_PROVIDERS ="google,microsoft"
-OAUTH_GOOGLE_KEY = "<google_application_id>"
-OAUTH_GOOGLE_SECRET=  "<google_application_secret_key>"
-OAUTH_GOOGLE_SCOPE="openid email"
-OAUTH_MICROSOFT_KEY = "<microsoft_application_id>"
-OAUTH_MICROSOFT_SECRET = "<microsoft_application_secret_key>"
-OAUTH_MICROSOFT_SCOPE = "openid email"
-OAUTH_MICROSOFT_AUTHORIZE_URL = "https://login.microsoftonline.com/<microsoft_application_id>/oauth2/v2.0/authorize"
-OAUTH_MICROSOFT_ACCESS_URL = "https://login.microsoftonline.com/<microsoft_application_id>/oauth2/v2.0/token"
-PUBLIC_URL = "<public_url_of_directus_instance>"
-`)],-1),P=e("h3",{id:"provider-specific-configuration"},[o("Provider Specific Configuration "),e("a",{class:"header-anchor",href:"#provider-specific-configuration"},"#")],-1),B=e("p",null,[o("If you use one of the many supported providers, you often don\u2019t have to configure any more than just the key and secret for the service. That being said, if you use a more tailored service (like the specific Microsoft application in the example above), you might have to provide more configuration values yourself. Please see "),e("a",{href:"https://github.com/simov/grant#configuration-description",target:"_blank",rel:"noopener noreferrer"},"https://github.com/simov/grant#configuration-description"),o(" for a list of all available configuration flags.")],-1),M=e("h2",{id:"file-storage"},[o("File Storage "),e("a",{class:"header-anchor",href:"#file-storage"},"#")],-1),N=e("p",null,"By default, Directus stores every file you upload locally on disk. Instead of local file storage, you can configure Directus to use S3 or Google Cloud Storage instead:",-1),F=e("pre",null,[e("code",null,`STORAGE_LOCATIONS="aws"
-STORAGE_AWS_DRIVER="s3"
-STORAGE_AWS_KEY="tp15c...510vk"
-STORAGE_AWS_SECRET="yk29b...b932n"
-STORAGE_AWS_REGION="us-east-2"
-STORAGE_AWS_BUCKET="my-files"
-`)],-1),x=e("h3",{id:"multiple-storage-adapters"},[o("Multiple Storage Adapters "),e("a",{class:"header-anchor",href:"#multiple-storage-adapters"},"#")],-1),q=e("p",null,"You can configure multiple storage adapters at the same time. This allows you to choose where files are being uploaded on a file-by-file basis. To do this, you can provide a CSV of storage location names, and provide a config block for each of them:",-1),W=e("pre",null,[e("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),V=e("p",null,[o("In the Admin App, files will automatically be uploaded to the first configured storage location (in this case "),e("code",null,"local"),o("). The used storage location is saved under "),e("code",null,"storage"),o(" in "),e("code",null,"directus_files"),o(".")],-1),Y=e("h2",{id:"rate-limiting"},[o("Rate Limiting "),e("a",{class:"header-anchor",href:"#rate-limiting"},"#")],-1),j=e("p",null,"You can use the built-in rate-limiter to prevent users from hitting the API too much. To enable the rate-limiter, simply set",-1),K=e("pre",null,[e("code",null,`RATE_LIMITER_ENABLED="true"
-`)],-1),z=e("p",null,"This will kick-in the rate-limiter on a maximum of 50 requests a second. You can configure this using:",-1),Z=e("pre",null,[e("code",null,`// 10 requests per 5 seconds
-RATE_LIMITER_POINTS="10"
-RATE_LIMITER_DURATION="5"
-`)],-1),J=e("p",null,[o("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 "),e("code",null,"memcache"),o(" or "),e("code",null,"redis"),o(" instance to store the rate limiter data:")],-1),Q=e("pre",null,[e("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),X=e("h2",{id:"file-based-configuration"},[o("File-Based Configuration "),e("a",{class:"header-anchor",href:"#file-based-configuration"},"#")],-1),$=o("In case you prefer using a configuration file instead of environment variables, you can use the "),ee=e("code",null,"CONFIG_PATH",-1),oe=o(" environment variable to instruct Directus to use a local configuration file instead of environment variables. See "),te=o("Config Files"),ne=o(" for more information."),le={setup(ie,{expose:s}){const t={title:"Configuring the API",modularExtension:!1};return s({frontmatter:t}),(se,ae)=>{const a=n("router-link"),r=n("DocsWrapper");return l(),c(r,{frontmatter:t},{default:i(()=>[e("div",h,[d,_,p,f,g,m,T,E,A,O,S,R,y,b,v,C,I,w,L,D,k,U,G,H,P,B,M,N,F,x,q,W,V,Y,j,K,z,Z,J,Q,X,e("p",null,[$,ee,oe,u(a,{to:"/docs/reference/config-files.md"},{default:i(()=>[te]),_:1}),ne])])]),_:1})}}};export{le as default};

package/dist/assets/authentication.2962910f.js DELETED Viewed

@@ -1,54 +0,0 @@
-import{r,p as h,q as d,w as t,B as e,t as n,P as s}from"./vendor.62143b15.js";const c={class:"markdown-body"},u={class:"two-up"},p={class:"left"},_=s("By default, all data in the system is off limits for unauthenticated users. To gain access to protected data, you must include an access token with every request, or "),g=s("configure permissions for the public role"),f=s("."),v=e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#login"},"Login")]),e("li",null,[e("a",{href:"#refresh"},"Refresh")]),e("li",null,[e("a",{href:"#logout"},"Logout")]),e("li",null,[e("a",{href:"#request-password-reset"},"Request Password Reset")]),e("li",null,[e("a",{href:"#reset-a-password"},"Reset a Password")]),e("li",null,[e("a",{href:"#list-oauth-providers"},"List oAuth providers")]),e("li",null,[e("a",{href:"#login-using-oauth-provider"},"Login using oAuth provider")])])])])],-1),m=e("hr",null,null,-1),w=e("h2",{id:"login"},[s("Login "),e("a",{class:"header-anchor",href:"#login"},"#")],-1),b=e("p",null,"Retrieve a temporary access token and refresh token.",-1),k={class:"two-up"},q={class:"left"},y=e("h3",{id:"request-body"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")],-1),j=e("div",{class:"definitions"},[e("p",null,[e("code",null,"email"),s(),e("strong",null,"Required"),e("br"),s(" Email address of the user you\u2019re retrieving the access token for.")]),e("p",null,[e("code",null,"password"),s(),e("strong",null,"Required"),e("br"),s(" Password of the user.")]),e("p",null,[e("code",null,"otp"),e("br"),s(" The user\u2019s one-time-password (if MFA is enabled).")]),e("p",null,[e("code",null,"mode"),e("br"),s(" Whether to retrieve the refresh token in the JSON response, or in a "),e("code",null,"httpOnly"),s(),e("code",null,"secure"),s(" cookie. One of "),e("code",null,"json"),s(", "),e("code",null,"cookie"),s(". Defaults to "),e("code",null,"json"),s(".")])],-1),T=e("h3",{id:"response-attributes"},[s("Response Attributes "),e("a",{class:"header-anchor",href:"#response-attributes"},"#")],-1),R=e("div",{class:"definitions"},[e("p",null,[e("code",null,"access_token"),s(),e("strong",null,"string"),e("br"),s(" Temporary access token to be used in follow-up requests.")]),e("p",null,[e("code",null,"expires"),s(),e("strong",null,"integer"),e("br"),s(" How long before the access token will expire. Value is in milliseconds.")]),e("p",null,[e("code",null,"refresh_token"),s(),e("strong",null,"string"),e("br"),s(" The token that can be used to retrieve a new access token through "),e("a",{href:"#refresh"},[e("code",null,"/auth/refresh")]),s(". Note: if you used "),e("code",null,"cookie"),s(" as the mode in the request, the refresh token won\u2019t be returned in the JSON.")])],-1),P={class:"tip hint"},S=e("div",{class:"hint-title"},"Expiry time",-1),A=s("The token\u2019s expiration time can be configured through "),O=s("the "),L=e("code",null,"ACCESS_TOKEN_TTL",-1),x=s(" environment variable"),E=s("."),B=e("div",{class:"right"},[e("h3",{id:"rest-api"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")]),e("pre",null,[e("code",null,`POST /auth/login
-`)]),e("pre",null,[e("code",{class:"language-json"},[s(`{
-	`),e("span",{class:"hljs-attr"},'"email"'),s(": "),e("span",{class:"hljs-string"},'"admin@example.com"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"password"'),s(": "),e("span",{class:"hljs-string"},'"d1r3ct5us"'),s(`
-}
-`)])]),e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	auth_login(email: `),e("span",{class:"hljs-string"},'"admin@example.com"'),s(", password: "),e("span",{class:"hljs-string"},'"d1r3ctu5"'),s(`) {
-		access_token
-		refresh_token
-	}
-}
-`)])])],-1),N=e("hr",null,null,-1),G=e("h2",{id:"refresh"},[s("Refresh "),e("a",{class:"header-anchor",href:"#refresh"},"#")],-1),I=e("p",null,"Retrieve a new access token using a refresh token.",-1),C=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-2"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")]),e("div",{class:"definitions"},[e("p",null,[e("code",null,"refresh_token"),e("br"),s(" The refresh token to use. If you have the refresh token in a cookie through "),e("a",{href:"#login"},[e("code",null,"/auth/login")]),s(", you don\u2019t have to submit it here.")])]),e("h3",{id:"response-attributes-2"},[s("Response Attributes "),e("a",{class:"header-anchor",href:"#response-attributes-2"},"#")]),e("div",{class:"definitions"},[e("p",null,[e("code",null,"access_token"),s(),e("strong",null,"string"),e("br"),s(" Temporary access token to be used in follow-up requests.")]),e("p",null,[e("code",null,"expires"),s(),e("strong",null,"integer"),e("br"),s(" How long before the access token will expire. Value is in milliseconds.")]),e("p",null,[e("code",null,"refresh_token"),s(),e("strong",null,"string"),e("br"),s(" The token that can be used to retrieve a new access token through "),e("a",{href:"#refresh"},[e("code",null,"/auth/refresh")]),s(". Note: if you used "),e("code",null,"cookie"),s(" as the mode in the request, the refresh token won\u2019t be returned in the JSON.")])])]),e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",null,`POST /auth/refresh
-`)]),e("pre",null,[e("code",{class:"language-json"},[s(`{
-	`),e("span",{class:"hljs-attr"},'"refresh_token"'),s(": "),e("span",{class:"hljs-string"},'"gmPd...8wuB"'),s(`
-}
-`)])]),e("h3",{id:"graphql-2"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	auth_refresh(refresh_token: `),e("span",{class:"hljs-string"},'"abc...def"'),s(`) {
-		access_token
-		refresh_token
-	}
-}
-`)])])])],-1),W=e("hr",null,null,-1),J=e("h2",{id:"logout"},[s("Logout "),e("a",{class:"header-anchor",href:"#logout"},"#")],-1),Q=e("p",null,"Invalidate the refresh token thus destroying the user\u2019s session.",-1),V=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-3"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-3"},"#")]),e("div",{class:"definitions"},[e("p",null,[e("code",null,"refresh_token"),e("br"),s(" The refresh token to invalidate. If you have the refresh token in a cookie through "),e("a",{href:"#login"},[e("code",null,"/auth/login")]),s(", you don\u2019t have to submit it here.")])])]),e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",null,`POST /auth/logout
-`)]),e("pre",null,[e("code",{class:"language-json"},[s(`{
-	`),e("span",{class:"hljs-attr"},'"refresh_token"'),s(": "),e("span",{class:"hljs-string"},'"gmPd...8wuB"'),s(`
-}
-`)])]),e("h3",{id:"graphql-3"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	auth_logout(refresh_token: `),e("span",{class:"hljs-string"},'"gmPd...8wuB"'),s(`)
-}
-`)])])])],-1),D=e("hr",null,null,-1),H=e("h2",{id:"request-password-reset"},[s("Request Password Reset "),e("a",{class:"header-anchor",href:"#request-password-reset"},"#")],-1),K=e("p",null,"Request a password reset email to be sent to the given user.",-1),U={class:"two-up"},F={class:"left"},M=e("h3",{id:"request-body-4"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-4"},"#")],-1),Y={class:"definitions"},z=e("p",null,[e("code",null,"email"),s(),e("strong",null,"Required"),e("br"),s(" Email address of the user you\u2019re requesting a password reset for.")],-1),X=e("code",null,"reset_url",-1),Z=e("br",null,null,-1),$=s(" Provide a custom reset url which the link in the email will lead to. The reset token will be passed as a parameter."),ee=e("br",null,null,-1),se=e("strong",null,"Note",-1),te=s(": You need to configure the "),oe=e("code",null,"PASSWORD_RESET_URL_ALLOW_LIST",-1),ne=s(" environment variable"),le=s(" to enable this feature."),re=e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",null,`POST /auth/password/request
-`)]),e("pre",null,[e("code",{class:"language-json"},[s(`{
-	`),e("span",{class:"hljs-attr"},'"email"'),s(": "),e("span",{class:"hljs-string"},'"admin@example.com"'),s(`
-}
-`)])]),e("h3",{id:"graphql-4"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	auth_password_request(email: `),e("span",{class:"hljs-string"},'"admin@example.com"'),s(`)
-}
-`)])])],-1),ae=e("hr",null,null,-1),ie=e("h2",{id:"reset-a-password"},[s("Reset a Password "),e("a",{class:"header-anchor",href:"#reset-a-password"},"#")],-1),he=e("p",null,"The request a password reset endpoint sends an email with a link to the admin app (or a custom route) which in turn uses this endpoint to allow the user to reset their password.",-1),de=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"request-body-5"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-5"},"#")]),e("div",{class:"definitions"},[e("p",null,[e("code",null,"token"),s(),e("strong",null,"Required"),e("br"),s(" Password reset token, as provided in the email sent by the request endpoint.")]),e("p",null,[e("code",null,"password"),s(),e("strong",null,"Required"),e("br"),s(" New password for the user.")])])]),e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",null,`POST /auth/password/reset
-`)]),e("pre",null,[e("code",{class:"language-json"},[s(`{
-	`),e("span",{class:"hljs-attr"},'"token"'),s(": "),e("span",{class:"hljs-string"},'"eyJh...KmUk"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"password"'),s(": "),e("span",{class:"hljs-string"},'"d1r3ctu5"'),s(`
-}
-`)])]),e("h3",{id:"graphql-5"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",null,`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	auth_password_reset(token: `),e("span",{class:"hljs-string"},'"eyJh...KmUk"'),s(", password: "),e("span",{class:"hljs-string"},'"d1r3ctu5"'),s(`)
-}
-`)])])])],-1),ce=e("hr",null,null,-1),ue=e("h2",{id:"list-oauth-providers"},[s("List oAuth providers "),e("a",{class:"header-anchor",href:"#list-oauth-providers"},"#")],-1),pe=e("p",null,"List all the configured oAuth providers.",-1),_e={class:"two-up"},ge={class:"left"},fe={class:"tip hint"},ve=e("div",{class:"hint-title"},"Configuring oAuth",-1),me=s("To learn more about setting up oAuth providers, see "),we=s("Configuring SSO through oAuth"),be=s("."),ke=e("h3",{id:"response-attributes-3"},[s("Response Attributes "),e("a",{class:"header-anchor",href:"#response-attributes-3"},"#")],-1),qe=e("div",{class:"definitions"},[e("p",null,[e("code",null,"data"),s(),e("strong",null,"Array"),e("br"),s(" Array of configured oAuth providers.")])],-1),ye=e("div",{class:"right"},[e("pre",null,[e("code",null,`GET /auth/oauth
-`)]),e("pre",null,[e("code",{class:"language-json"},[s(`{
-	`),e("span",{class:"hljs-attr"},'"data"'),s(": ["),e("span",{class:"hljs-string"},'"GitHub"'),s(", "),e("span",{class:"hljs-string"},'"Google"'),s(", "),e("span",{class:"hljs-string"},'"Okta"'),s(`]
-}
-`)])])],-1),je=e("hr",null,null,-1),Te=e("h2",{id:"login-using-oauth-provider"},[s("Login using oAuth provider "),e("a",{class:"header-anchor",href:"#login-using-oauth-provider"},"#")],-1),Re=e("p",null,"Will redirect to the configured oAuth provider for the user to login.",-1),Pe=e("div",{class:"two-up"},[e("div",{class:"right"},[e("pre",null,[e("code",null,`GET /auth/oauth/:provider
-`)])])],-1),Se=e("hr",null,null,-1),Ee={setup(Ae,{expose:a}){const l={title:"Authentication",modularExtension:!1,pageClass:"page-reference"};return a({frontmatter:l}),(Oe,Le)=>{const o=r("router-link"),i=r("DocsWrapper");return h(),d(i,{frontmatter:l},{default:t(()=>[e("div",c,[e("div",u,[e("div",p,[e("blockquote",null,[e("p",null,[_,n(o,{to:"/docs/guides/roles-and-permissions"},{default:t(()=>[g]),_:1}),f])])]),v]),m,w,b,e("div",k,[e("div",q,[y,j,T,R,e("div",P,[S,e("p",null,[A,n(o,{to:"/docs/reference/environment-variables"},{default:t(()=>[O,L,x]),_:1}),E])])]),B]),N,G,I,C,W,J,Q,V,D,H,K,e("div",U,[e("div",F,[M,e("div",Y,[z,e("p",null,[X,Z,$,ee,se,te,n(o,{to:"/docs/reference/environment-variables/#security"},{default:t(()=>[oe,ne]),_:1}),le])])]),re]),ae,ie,he,de,ce,ue,pe,e("div",_e,[e("div",ge,[e("div",fe,[ve,e("p",null,[me,n(o,{to:"/docs/guides/api-config/#oauth-single-sign-on-sso-openid"},{default:t(()=>[we]),_:1}),be])]),ke,qe]),ye]),je,Te,Re,Pe,Se])]),_:1})}}};export{Ee as default};

package/dist/assets/en-au.175fcb2b.js DELETED Viewed

@@ -1 +0,0 @@

- function a(t,n){return n.forEach(function(r){Object.keys(r).forEach(function(e){if(e!=="default"&&!(e in t)){var o=Object.getOwnPropertyDescriptor(r,e);Object.defineProperty(t,e,o.get?o:{enumerable:!0,get:function(){return r[e]}})}})}),Object.freeze(t)}var u={};Object.defineProperty(u,"__esModule",{value:!0});var c={code:"en-au",week:{dow:1,doy:4}},f=u.default=c,l=Object.freeze(a({__proto__:null,[Symbol.toStringTag]:"Module",default:f},[u]));export{l as e};

package/dist/assets/en-gb.018f9a21.js DELETED Viewed

@@ -1 +0,0 @@

- function u(t,a){return a.forEach(function(r){Object.keys(r).forEach(function(e){if(e!=="default"&&!(e in t)){var n=Object.getOwnPropertyDescriptor(r,e);Object.defineProperty(t,e,n.get?n:{enumerable:!0,get:function(){return r[e]}})}})}),Object.freeze(t)}var o={};Object.defineProperty(o,"__esModule",{value:!0});var c={code:"en-gb",week:{dow:1,doy:4}},f=o.default=c,b=Object.freeze(u({__proto__:null,[Symbol.toStringTag]:"Module",default:f},[o]));export{b as e};

package/dist/assets/en-nz.2f0f7e5c.js DELETED Viewed

@@ -1 +0,0 @@

- function u(t,a){return a.forEach(function(r){Object.keys(r).forEach(function(e){if(e!=="default"&&!(e in t)){var o=Object.getOwnPropertyDescriptor(r,e);Object.defineProperty(t,e,o.get?o:{enumerable:!0,get:function(){return r[e]}})}})}),Object.freeze(t)}var n={};Object.defineProperty(n,"__esModule",{value:!0});var c={code:"en-nz",week:{dow:1,doy:4}},f=n.default=c,l=Object.freeze(u({__proto__:null,[Symbol.toStringTag]:"Module",default:f},[n]));export{l as e};

package/dist/assets/environment-variables.41ac3cc1.js DELETED Viewed

@@ -1,25 +0,0 @@
-import{r as d,p as r,q as i,w as n,B as l,t as o,P as e}from"./vendor.62143b15.js";const c={class:"markdown-body"},h=l("blockquote",null,[l("p",null,[e("Environment variables are used for all configuration within Directus projects. They can either be defined as plain environment variables or via the "),l("code",null,".env"),e(" file in the root directory, which is created during the installation process.")])],-1),_=l("p",null,[l("div",{class:"table-of-contents"},[l("ul",null,[l("li",null,[l("a",{href:"#general"},"General")]),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:"#sessions"},"Sessions")]),l("li",null,[l("a",{href:"#file-storage"},"File Storage")]),l("li",null,[l("a",{href:"#assets"},"Assets")]),l("li",null,[l("a",{href:"#oauth"},"OAuth")]),l("li",null,[l("a",{href:"#extensions"},"Extensions")]),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:"#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:"#file-based-environment-variables-(docker-secrets)"},"File Based Environment Variables (Docker Secrets)")])])])],-1),f=l("h2",{id:"general"},[e("General "),l("a",{class:"header-anchor",href:"#general"},"#")],-1),m=l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])],-1),p=l("td",null,[l("code",null,"CONFIG_PATH")],-1),E=e("Where your config file is located. See "),g=e("Config Files"),A=l("td",null,[l("code",null,".env")],-1),b=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")])],-1),S=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,"/")])],-1),y=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")])],-1),T=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")])],-1),O=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")])],-1),R=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")])],-1),D=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")])],-1),I=l("p",null,[l("sup",null,"[1]"),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.")],-1),C=l("h2",{id:"database"},[e("Database "),l("a",{class:"header-anchor",href:"#database"},"#")],-1),v=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(", or "),l("code",null,"sqlite3"),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")])]),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")])])])],-1),L=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),N=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 "),l("a",{href:"https://github.com/vincit/tarn.js#usage",target:"_blank",rel:"noopener noreferrer"},[e("to "),l("code",null,"tarn.js")]),e(" through "),l("a",{href:"http://knexjs.org/#Installation-pooling",target:"_blank",rel:"noopener noreferrer"},"Knex")])],-1),w=l("h2",{id:"security"},[e("Security "),l("a",{class:"header-anchor",href:"#security"},"#")],-1),M=l("thead",null,[l("tr",null,[l("th",null,"Variable"),l("th",null,"Description"),l("th",null,"Default Value")])],-1),V=l("tr",null,[l("td",null,[l("code",null,"KEY")]),l("td",null,"Unique identifier for the project."),l("td",null,"\u2013")],-1),x=l("tr",null,[l("td",null,[l("code",null,"SECRET")]),l("td",null,"Secret string for the project."),l("td",null,"\u2013")],-1),H=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),P=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),k=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),U=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),B=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),G=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),W=l("td",null,[l("code",null,"PASSWORD_RESET_URL_ALLOW_LIST")],-1),q=e("List of URLs that can be used "),F=e("as "),K=l("code",null,"reset_url",-1),z=e(" in /password/request"),Y=l("td",null,"\u2013",-1),j=l("td",null,[l("code",null,"USER_INVITE_URL_ALLOW_LIST")],-1),X=e("List of URLs that can be used "),$=e("as "),Z=l("code",null,"invite_url",-1),J=e(" in /users/invite"),Q=l("td",null,"\u2013",-1),ll=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),el=l("h3",{id:"hashing"},[e("Hashing "),l("a",{class:"header-anchor",href:"#hashing"},"#")],-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,"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),tl=l("p",null,[e("Argon2\u2019s hashing function is used by Directus for three purposes: 1) hashing user passwords, 2) generating hashes for the "),l("code",null,"Hash"),e(" field type in collections, and 3) the "),l("a",{href:"https://docs.directus.io/reference/api/system/utilities/#generate-a-hash",target:"_blank",rel:"noopener noreferrer"},"generate a hash API endpoint"),e(".")],-1),ol=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),ul=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),dl=l("h2",{id:"cors"},[e("CORS "),l("a",{class:"header-anchor",href:"#cors"},"#")],-1),al=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,"true")])]),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,"true")])]),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),sl=l("h2",{id:"rate-limiting"},[e("Rate Limiting "),l("a",{class:"header-anchor",href:"#rate-limiting"},"#")],-1),rl=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),il=l("p",null,[e("Based on the "),l("code",null,"RATE_LIMITER_STORE"),e(" used, you must also provide the following configurations:")],-1),cl=l("h3",{id:"memory"},[e("Memory "),l("a",{class:"header-anchor",href:"#memory"},"#")],-1),hl=l("p",null,"No additional configuration required.",-1),_l=l("h3",{id:"redis"},[e("Redis "),l("a",{class:"header-anchor",href:"#redis"},"#")],-1),fl=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),ml=l("p",null,"Alternatively, you can provide the individual connection parameters:",-1),pl=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),El=l("h3",{id:"memcache"},[e("Memcache "),l("a",{class:"header-anchor",href:"#memcache"},"#")],-1),gl=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),Al=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),bl=l("h2",{id:"cache"},[e("Cache "),l("a",{class:"header-anchor",href:"#cache"},"#")],-1),Sl=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 caching is enabled."),l("td",null,[l("code",null,"false")])]),l("tr",null,[l("td",null,[l("code",null,"CACHE_TTL")]),l("td",null,"How long the cache is persisted."),l("td",null,[l("code",null,"30m")])]),l("tr",null,[l("td",null,[l("code",null,"CACHE_CONTROL_S_MAXAGE")]),l("td",null,"Whether to not to add the s-maxage 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("td",null,[e("Automatically purge the cache on "),l("code",null,"create"),e("/"),l("code",null,"update"),e("/"),l("code",null,"delete"),e(" actions.")]),l("td",null,[l("code",null,"false")])]),l("tr",null,[l("td",null,[l("code",null,"CACHE_SCHEMA"),e(),l("sup",null,"[1]")]),l("td",null,[e("Whether or not the database schema is cached. One of "),l("code",null,"false"),e(", "),l("code",null,"true"),e(", or a string time value")]),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("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")])])])],-1),yl=l("p",null,[l("sup",null,"[1]"),e(),l("code",null,"CACHE_SCHEMA"),e(" ignores the "),l("code",null,"CACHE_ENABLED"),e(" value")],-1),Tl=l("p",null,[e("Based on the "),l("code",null,"CACHE_STORE"),e(" used, you must also provide the following configurations:")],-1),Ol=l("h3",{id:"memory-2"},[e("Memory "),l("a",{class:"header-anchor",href:"#memory-2"},"#")],-1),Rl=l("p",null,"No additional configuration required.",-1),Dl=l("h3",{id:"redis-2"},[e("Redis "),l("a",{class:"header-anchor",href:"#redis-2"},"#")],-1),Il=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),Cl=l("p",null,"Alternatively, you can provide the individual connection parameters:",-1),vl=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),Ll=l("h3",{id:"memcache-2"},[e("Memcache "),l("a",{class:"header-anchor",href:"#memcache-2"},"#")],-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,"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),wl=l("h2",{id:"sessions"},[e("Sessions "),l("a",{class:"header-anchor",href:"#sessions"},"#")],-1),Ml=l("p",null,"Sessions are only used in the oAuth authentication flow.",-1),Vl=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,"SESSION_STORE")]),l("td",null,[e("Where to store the session data. Either "),l("code",null,"memory"),e(", "),l("code",null,"redis"),e(", "),l("code",null,"memcache"),e(" or "),l("code",null,"database"),e(".")]),l("td",null,[l("code",null,"memory")])])])],-1),xl=l("p",null,[e("Based on the "),l("code",null,"SESSION_STORE"),e(" used, you must also provide the following configurations:")],-1),Hl=l("h3",{id:"memory-3"},[e("Memory "),l("a",{class:"header-anchor",href:"#memory-3"},"#")],-1),Pl=l("p",null,"No additional configuration required.",-1),kl=l("h3",{id:"redis-3"},[e("Redis "),l("a",{class:"header-anchor",href:"#redis-3"},"#")],-1),Ul=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,"SESSION_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),Bl=l("p",null,"Alternatively, you can provide the individual connection parameters:",-1),Gl=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,"SESSION_REDIS_HOST")]),l("td",null,"Hostname of the Redis instance"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"SESSION_REDIS_PORT")]),l("td",null,"Port of the Redis instance"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"SESSION_REDIS_PASSWORD")]),l("td",null,"Password for your Redis instance"),l("td",null,"\u2013")])])],-1),Wl=l("h3",{id:"memcache-3"},[e("Memcache "),l("a",{class:"header-anchor",href:"#memcache-3"},"#")],-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,"SESSION_MEMCACHE_HOSTS")]),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),Fl=l("h3",{id:"database-2"},[e("Database "),l("a",{class:"header-anchor",href:"#database-2"},"#")],-1),Kl=l("p",null,"No additional configuration required.",-1),zl=l("h2",{id:"file-storage"},[e("File Storage "),l("a",{class:"header-anchor",href:"#file-storage"},"#")],-1),Yl=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),jl=l("p",null,"For each of the storage locations listed, you must provide the following configuration:",-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,"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),$l=l("p",null,"Based on your configured driver, you must also provide the following configurations:",-1),Zl=l("h3",{id:"local-(local)"},[e("Local ("),l("code",null,"local"),e(") "),l("a",{class:"header-anchor",href:"#local-(local)"},"#")],-1),Jl=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),Ql=l("h3",{id:"s3-(s3)"},[e("S3 ("),l("code",null,"s3"),e(") "),l("a",{class:"header-anchor",href:"#s3-(s3)"},"#")],-1),le=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),ee=l("h3",{id:"azure-(azure)"},[e("Azure ("),l("code",null,"azure"),e(") "),l("a",{class:"header-anchor",href:"#azure-(azure)"},"#")],-1),ne=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),te=l("h3",{id:"google-cloud-storage-(gcs)"},[e("Google Cloud Storage ("),l("code",null,"gcs"),e(") "),l("a",{class:"header-anchor",href:"#google-cloud-storage-(gcs)"},"#")],-1),oe=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),ue=l("p",null,"If you don\u2019t provide any configuration for storage adapters, Directus will default to the following:",-1),de=l("pre",null,[l("code",null,`STORAGE_LOCATIONS="local"
-STORAGE_LOCAL_ROOT="./uploads"
-`)],-1),ae=l("h2",{id:"assets"},[e("Assets "),l("a",{class:"header-anchor",href:"#assets"},"#")],-1),se=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")])])])],-1),re=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),ie=l("h2",{id:"oauth"},[e("OAuth "),l("a",{class:"header-anchor",href:"#oauth"},"#")],-1),ce=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,"OAUTH_PROVIDERS")]),l("td",null,"CSV of oAuth providers you want to use."),l("td",null,"\u2013")])])],-1),he=l("p",null,"For each of the OAuth providers you list, you must also provide a number of extra variables. These differ per external service. The following is a list of common required configuration options:",-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,"OAUTH_<PROVIDER>_KEY")]),l("td",null,"oAuth key (a.k.a. application id) for the external service."),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"OAUTH_<PROVIDER>_SECRET")]),l("td",null,"oAuth secret for the external service."),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"OAUTH_<PROVIDER>_SCOPE")]),l("td",null,[e("A white-space separated list of privileges directus should ask for. A common value is: "),l("code",null,"openid email"),e(".")]),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"OAUTH_<PROVIDER>_AUTHORIZE_URL")]),l("td",null,"The authorize page URL of the external service"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"OAUTH_<PROVIDER>_ACCESS_URL")]),l("td",null,"The access URL of the external service"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"OAUTH_<PROVIDER>_PROFILE_URL")]),l("td",null,"Where Directus can fetch the profile information of the authenticated user."),l("td",null,"\u2013")])])],-1),fe=l("p",null,[e("Directus relies on "),l("a",{href:"https://www.npmjs.com/package/grant",target:"_blank",rel:"noopener noreferrer"},[l("code",null,"grant")]),e(" for the handling of the oAuth flow. Grant includes "),l("a",{href:"https://github.com/simov/grant/blob/master/config/oauth.json",target:"_blank",rel:"noopener noreferrer"},"a lot of default values"),e(" for popular services. For example, if you use "),l("code",null,"apple"),e(" as one of your providers, you only have to specify the key and secret, as Grant has the rest covered. Checkout "),l("a",{href:"https://github.com/simov/grant",target:"_blank",rel:"noopener noreferrer"},"the grant repo"),e(" for more information.")],-1),me=l("h2",{id:"extensions"},[e("Extensions "),l("a",{class:"header-anchor",href:"#extensions"},"#")],-1),pe=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")])])])],-1),Ee=l("h2",{id:"email"},[e("Email "),l("a",{class:"header-anchor",href:"#email"},"#")],-1),ge=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_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("td",null,[l("code",null,"sendmail")])])])],-1),Ae=l("p",null,[e("Based on the "),l("code",null,"EMAIL_TRANSPORT"),e(" used, you must also provide the following configurations:")],-1),be=l("h3",{id:"sendmail-(sendmail)"},[e("Sendmail ("),l("code",null,"sendmail"),e(") "),l("a",{class:"header-anchor",href:"#sendmail-(sendmail)"},"#")],-1),Se=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),ye=l("h3",{id:"smtp-(smtp)"},[e("SMTP ("),l("code",null,"smtp"),e(") "),l("a",{class:"header-anchor",href:"#smtp-(smtp)"},"#")],-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,"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),Oe=l("h3",{id:"mailgun-(mailgun)"},[e("Mailgun ("),l("code",null,"mailgun"),e(") "),l("a",{class:"header-anchor",href:"#mailgun-(mailgun)"},"#")],-1),Re=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),De=l("h2",{id:"admin-account"},[e("Admin Account "),l("a",{class:"header-anchor",href:"#admin-account"},"#")],-1),Ie=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),Ce=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),ve=l("h2",{id:"telemetry"},[e("Telemetry "),l("a",{class:"header-anchor",href:"#telemetry"},"#")],-1),Le=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),Ne=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),we=l("hr",null,null,-1),Me=l("h2",{id:"type-casting-and-nesting"},[e("Type Casting and Nesting "),l("a",{class:"header-anchor",href:"#type-casting-and-nesting"},"#")],-1),Ve=l("p",null,"Environment variables are automatically type cast based on the structure of the variable, for example:",-1),xe=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),He=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),Pe=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),ke=l("h2",{id:"environment-syntax-prefix"},[e("Environment Syntax Prefix "),l("a",{class:"header-anchor",href:"#environment-syntax-prefix"},"#")],-1),Ue=l("p",null,[e("Directus will attempt to automatically type cast environment variables based on context clues ("),l("a",{href:"#type-casting-and-nesting"},"see above"),e("). 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),Be=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),Ge=l("h2",{id:"file-based-environment-variables-(docker-secrets)"},[e("File Based Environment Variables (Docker Secrets) "),l("a",{class:"header-anchor",href:"#file-based-environment-variables-(docker-secrets)"},"#")],-1),We=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. For example: "),l("code",null,'DB_PASSWORD_FILE="/run/secrets/db_password"'),e(".")],-1),qe=l("p",null,"This is especially useful when used in conjunction with Docker Secrets, so you can keep sensitive data out of your compose files.",-1),je={setup(Fe,{expose:a}){const u={title:"Environment Variables",modularExtension:!1};return a({frontmatter:u}),(Ke,ze)=>{const t=d("router-link"),s=d("DocsWrapper");return r(),i(s,{frontmatter:u},{default:n(()=>[l("div",c,[h,_,f,l("table",null,[m,l("tbody",null,[l("tr",null,[p,l("td",null,[E,o(t,{to:"/docs/reference/config-files/"},{default:n(()=>[g]),_:1})]),A]),b,S,y,T,O,R,D])]),I,C,v,L,N,w,l("table",null,[M,l("tbody",null,[V,x,H,P,k,U,B,G,l("tr",null,[W,l("td",null,[q,o(t,{to:"/docs/reference/api/system/authentication/#request-password-reset"},{default:n(()=>[F,K,z]),_:1})]),Y]),l("tr",null,[j,l("td",null,[X,o(t,{to:"/docs/reference/api/system/users/#invite-a-new-user"},{default:n(()=>[$,Z,J]),_:1})]),Q])])]),ll,el,nl,tl,ol,ul,dl,al,sl,rl,il,cl,hl,_l,fl,ml,pl,El,gl,Al,bl,Sl,yl,Tl,Ol,Rl,Dl,Il,Cl,vl,Ll,Nl,wl,Ml,Vl,xl,Hl,Pl,kl,Ul,Bl,Gl,Wl,ql,Fl,Kl,zl,Yl,jl,Xl,$l,Zl,Jl,Ql,le,ee,ne,te,oe,ue,de,ae,se,re,ie,ce,he,_e,fe,me,pe,Ee,ge,Ae,be,Se,ye,Te,Oe,Re,De,Ie,Ce,ve,Le,Ne,we,Me,Ve,xe,He,Pe,ke,Ue,Be,Ge,We,qe])]),_:1})}}};export{je as default};

package/dist/assets/es.18d3cc7b.js DELETED Viewed

@@ -1 +0,0 @@

- function u(t,n){return n.forEach(function(r){Object.keys(r).forEach(function(e){if(e!=="default"&&!(e in t)){var a=Object.getOwnPropertyDescriptor(r,e);Object.defineProperty(t,e,a.get?a:{enumerable:!0,get:function(){return r[e]}})}})}),Object.freeze(t)}var o={};Object.defineProperty(o,"__esModule",{value:!0});var s={code:"es",week:{dow:1,doy:4},buttonText:{prev:"Ant",next:"Sig",today:"Hoy",month:"Mes",week:"Semana",day:"D\xEDa",list:"Agenda"},weekText:"Sm",allDayText:"Todo el d\xEDa",moreLinkText:"m\xE1s",noEventsText:"No hay eventos para mostrar"},c=o.default=s,d=Object.freeze(u({__proto__:null,[Symbol.toStringTag]:"Module",default:c},[o]));export{d as e};