summaryrefslogtreecommitdiff
path: root/example.env
diff options
context:
space:
mode:
authorFreya Murphy <freya@freyacat.org>2026-02-23 22:57:27 -0500
committerFreya Murphy <freya@freyacat.org>2026-02-23 22:57:27 -0500
commitf373ead95fb5beb962c376b5b7b46dfde8ac4e57 (patch)
treec99df23521ff2a5e5e2e4627c525a5e99dc2e3ae /example.env
parentadd 96x96 logo (diff)
downloadwebsite-f373ead95fb5beb962c376b5b7b46dfde8ac4e57.tar.gz
website-f373ead95fb5beb962c376b5b7b46dfde8ac4e57.tar.bz2
website-f373ead95fb5beb962c376b5b7b46dfde8ac4e57.zip
update website to work with crimson framework
Diffstat (limited to '')
-rw-r--r--example.env65
1 files changed, 65 insertions, 0 deletions
diff --git a/example.env b/example.env
new file mode 100644
index 0000000..5bac88b
--- /dev/null
+++ b/example.env
@@ -0,0 +1,65 @@
+### CRIMSON --- A simple PHP framework.
+### Website --- freya.cat website
+### Copyright © 2024 Freya Murphy <contact@freyacat.org>
+###
+### This file is part of CRIMSON.
+### This file is part of Website.
+
+# ===================================================================== INFO ==
+# This is the CRIMSON configuration file. Copy this file as `.env` in your
+# project checkout to override default crimson configuration values.
+#
+# 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="website"
+
+# ============================================================== DEVELOPMENT ==
+# Sets if CRIMSON should run in "production" or "development" mode. Read
+# `src/config.php` in crimson for more information.
+ENVIRONMENT="development"
+
+# ====================================================================== 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=website
+POSTGRES_USER=website
+POSTGRES_PASSWORD=cannothackme
+
+# ====================================================================== 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=false
+
+# ================================================================== Website ==
+# These settings tell Website where you are hosting your site. This is required
+# since all links in Website are generated using these values.
+#
+# CHANGE ME!
+#
+WEBSITE_HOST="freya.cat"
+WEBSITE_ALLOWED_HOSTS="www.freya.cat freya.cat"
+WEBSITE_BASE_PATH="/"