crimson/base.env

69 lines
2.8 KiB
Bash

### CRIMSON --- A simple PHP framework.
### Copyright © 2024 Freya Murphy <contact@freyacat.org>
###
### This file is part of CRIMSON.
###
### CRIMSON is free software; you can redistribute it and/or modify it
### under the terms of the GNU General Public License as published by
### the Free Software Foundation; either version 3 of the License, or (at
### your option) any later version.
###
### CRIMSON is distributed in the hope that it will be useful, but
### WITHOUT ANY WARRANTY; without even the implied warranty of
### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
### GNU General Public License for more details.
###
### You should have received a copy of the GNU General Public License
### along with CRIMSON. If not, see <http://www.gnu.org/licenses/>.
# ===================================================================== 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="crimson"
# ============================================================== 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=false
POSTGRES_DB=postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
# ====================================================================== 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
API_SECRET="" # CHANGE ME!
API_ROLE="anonymous"
API_SCHEMA="api"