Document Directus production contract and repair auth

This commit is contained in:
makearmy 2026-07-10 10:51:04 -04:00
parent 0a7ee5ff35
commit 92ce8bce97
32 changed files with 24821 additions and 65 deletions

71
directus/env.example Normal file
View file

@ -0,0 +1,71 @@
# Names-and-placeholders contract only. Never place production values in this file.
# Classification: public-build = embedded/exposed by Next.js; server = Next.js server only;
# deployment = Directus container/bootstrap only.
# Shared Directus location
NEXT_PUBLIC_API_BASE_URL=<public-directus-base-url> # Next.js; public-build
NEXT_PUBLIC_ASSET_URL=<public-directus-assets-base-url> # Next.js; public-build
DIRECTUS_URL=<server-directus-base-url> # Next.js; server
# Next.js privileged Directus identities
DIRECTUS_TOKEN_ADMIN_REGISTER=<registration-static-credential> # Next.js; server
DIRECTUS_SERVICE_TOKEN=<legacy-service-credential-if-still-supported> # Next.js; server
DIRECTUS_ADMIN_TOKEN=<legacy-admin-credential-if-still-supported> # Next.js; server
DIRECTUS_TOKEN_ADMIN_SUPPORTER=<supporter-static-credential> # Next.js and backfill script; server
DIRECTUS_TOKEN_SUBMIT=<settings-submission-credential> # Next.js; server
# Next.js Directus role, collection, folder, and upload configuration
DIRECTUS_ROLE_MEMBER_NAME=<registered-user-role-name> # Next.js helper; server
DIRECTUS_PROJECTS_COLLECTION=<projects-collection-name> # Next.js helper; server
DIRECTUS_AVATAR_FOLDER_ID=<avatar-folder-id> # Next.js; server
DX_FOLDER_FIBER_PHOTOS=<folder-id> # Next.js; server
DX_FOLDER_FIBER_SCREENS=<folder-id> # Next.js; server
DX_FOLDER_GALVO_PHOTOS=<folder-id> # Next.js; server
DX_FOLDER_GALVO_SCREENS=<folder-id> # Next.js; server
DX_FOLDER_GANTRY_PHOTOS=<folder-id> # Next.js; server
DX_FOLDER_GANTRY_SCREENS=<folder-id> # Next.js; server
DX_FOLDER_UV_PHOTOS=<folder-id> # Next.js; server
DX_FOLDER_UV_SCREENS=<folder-id> # Next.js; server
FILE_MAX_MB=<positive-number> # Next.js project uploads; server
SETTINGS_IMAGE_MAX_MB=<positive-number> # Next.js settings uploads; server
# Directus container identity and cryptographic configuration
KEY=<directus-key> # Directus; deployment
SECRET=<directus-secret> # Directus; deployment
PUBLIC_URL=<public-directus-base-url> # Directus; deployment
ADMIN_EMAIL=<bootstrap-admin-address> # Directus bootstrap; deployment
ADMIN_PASSWORD=<bootstrap-admin-credential> # Directus bootstrap; deployment
# Directus database
DB_CLIENT=mysql # Directus; deployment
DB_HOST=<database-host> # Directus; deployment
DB_PORT=<database-port> # Directus; deployment
DB_DATABASE=<database-name> # Directus; deployment
DB_USER=<database-user> # Directus; deployment
DB_PASSWORD=<database-credential> # Directus; deployment
DB_FILENAME=<unused-for-mysql-or-database-file> # Directus environment name observed; deployment
# Directus mail
EMAIL_TRANSPORT=smtp # Directus; deployment
EMAIL_FROM=<sender-address> # Directus and Next.js supporter mail; deployment/server
EMAIL_SMTP_HOST=<smtp-host> # Directus; deployment
EMAIL_SMTP_PORT=465 # Directus; deployment
EMAIL_SMTP_SECURE=true # Directus; deployment
EMAIL_SMTP_USER=<smtp-user> # Directus; deployment
EMAIL_SMTP_PASSWORD=<smtp-credential> # Directus; deployment
# Next.js supporter mail uses a separate naming convention
SMTP_HOST=<smtp-host> # Next.js; server
SMTP_PORT=<smtp-port> # Next.js; server
SMTP_SECURE=<true-or-false> # Next.js; server
SMTP_USER=<smtp-user> # Next.js; server
SMTP_PASS=<smtp-credential> # Next.js; server
# Runtime classification
NODE_ENV=<production-or-development> # Directus and Next.js; deployment/server
# The production Directus environment also contains runtime-provided NODE_VERSION,
# NPM_CONFIG_UPDATE_NOTIFIER, PATH, and YARN_VERSION. They are not application
# integration configuration and therefore have no configurable placeholders here.
# AUTH_PROVIDERS, Directus CORS/cookie variables, and public-registration variables
# were explicitly reported as not set and are intentionally not implied here.