diff options
Diffstat (limited to 'example.env')
| -rw-r--r-- | example.env | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/example.env b/example.env new file mode 100644 index 0000000..9e76dc6 --- /dev/null +++ b/example.env @@ -0,0 +1,71 @@ +### CRIMSON --- A simple PHP framework. +### XSSBook --- Post posts postfully. +### Copyright © 2024 Freya Murphy <contact@freyacat.org> +### +### This file is part of CRIMSON. +### This file is part of XSSBook. + +# ===================================================================== INFO == +# This is the CRIMSON configuration file. Copy this file as `.env` in your +# project checkout to override default crimson configuration values. +# +# This is XSSBooks example `.env` file. Most settings in here SHOULD NOT BE +# CHANGED. Doing so MAY result in issues. +# +# NOTE: Options labeled "CHANGE ME!" MUST be modified. + +# ================================================================== GENERAL == +# Contains options for project metadata. +# PROJECT_NAME - Sets the project name in the docker compose stack. +# i.e: crimson-web-1 +PROJECT_NAME="xssbook" + +# ============================================================== DEVELOPMENT == +# Sets if CRIMSON should run in "production" or "development" mode. Read +# `src/config.php` in crimson for more information. +ENVIRONMENT="production" + +# ====================================================================== WEB == +# Sets what port and bind that nginx will listen on. This is how you will +# externally access your app. +# +HTTP_BIND=127.0.0.1 +HTTP_PORT=80 + +# ================================================================= DATABASE == +# If POSTGRES_ENABLED is set to `true`, then the crimson postgres database will +# be enabled. Configure the below settings for the connetions options to this +# database. +# +# WARNING: Do NOT change these values after the fist run. +# +POSTGRES_ENABLED=true +POSTGRES_DB=xssbook +POSTGRES_USER=xssbook +POSTGRES_PASSWORD=xssbook + +# ====================================================================== API == +# If API_ENABLED is set to `true`, then the crimson postgrest container will be +# enabled. Postgres uses JWTs to do verification, so you MUST set a API_SECRET +# if the api is enabled. API_ROLE sets which role will unauthenticated api +# users will be inside postgres. API_SCHEMA sets which postgres schema that +# postgrest will use. +# +# For more information about postgres: <https://docs.postgrest.org/en/v12/>. +# +# WARNING: POSTGRES_ENABLED must be set to `true` if the API is also enabled. +# +API_ENABLED=true +API_SECRET="" # CHANGE ME! +API_ROLE="rest_anon" +API_SCHEMA="api" + +# ================================================================== XSSBOOK == +# These settings tell XSSBook where you are hosting your site. This is required +# since all links in XSSBook are generated using these values. +# +# CHANGE ME! +# +XSSBOOK_HOST="xssbook.com" +XSSBOOK_ALLOWED_HOSTS="www.xssbook.com xssbook.com" +XSSBOOK_BASE_PATH="/" |