Skip to content

Configuration Reference

Whether using Docker or Docker Compose (.env) deployment, configuration is done through environment variables.

Environment Variables List

Environment VariableDescriptionDefaultRequired
CFRAME_ADMIN_EMAILInitial admin user emailNoneYes, fill in the GitHub account email used for login
CFRAME_ADMIN_NAMEInitial admin usernameChronoframeNo
CFRAME_ADMIN_PASSWORDInitial admin user passwordCF1234@!No
NUXT_PUBLIC_APP_TITLEApplication titleChronoFrameNo
NUXT_PUBLIC_APP_SLOGANApplication sloganNoneNo
NUXT_PUBLIC_APP_AUTHORApplication authorNoneNo
NUXT_PUBLIC_APP_AVATAR_URLApplication avatar URLNoneNo
NUXT_PUBLIC_MAPBOX_ACCESS_TOKENMapbox access token (URL restricted), for map servicesNoneYes
NUXT_MAPBOX_ACCESS_TOKENMapbox access token (no URL restriction), for location servicesNoneNo
NUXT_STORAGE_PROVIDERStorage provider, supports s3, github, locals3Yes
NUXT_PROVIDER_S3_ENDPOINTS3 compatible storage service endpointNoneRequired when NUXT_STORAGE_PROVIDER is s3
NUXT_PROVIDER_S3_BUCKETS3 bucket namechronoframeRequired when NUXT_STORAGE_PROVIDER is s3
NUXT_PROVIDER_S3_REGIONS3 bucket regionautoRequired when NUXT_STORAGE_PROVIDER is s3
NUXT_PROVIDER_S3_ACCESS_KEY_IDS3 access key IDNoneRequired when NUXT_STORAGE_PROVIDER is s3
NUXT_PROVIDER_S3_SECRET_ACCESS_KEYS3 secret access keyNoneRequired when NUXT_STORAGE_PROVIDER is s3
NUXT_PROVIDER_S3_PREFIXS3 storage prefixphotos/No
NUXT_PROVIDER_S3_CDN_URLS3 storage CDN URLNoneNo
NUXT_OAUTH_GITHUB_CLIENT_IDGitHub OAuth app Client IDNoneYes
NUXT_OAUTH_GITHUB_CLIENT_SECRETGitHub OAuth app Client SecretNoneYes
NUXT_SESSION_PASSWORDPassword for encrypting sessions, 32-character random stringNoneYes

Released under the MIT License.