875a60f90f
A free, open, self-hosted app platform (GNU AGPLv3): one-click app deploys, Traefik reverse proxy with automatic SSL, rootless Docker support, gluetun VPN routing, and a web dashboard to manage it all. Free & open forever to self-host; optional paid hosted services fund it. See PROMISE.md. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> Signed-off-by: librelad <librelad@digitalangels.vip>
77 lines
3.9 KiB
Plaintext
77 lines
3.9 KiB
Plaintext
#
|
|
# =============================================================================
|
|
# GENERAL CONFIGURATION
|
|
# =============================================================================
|
|
# APP_NAME = name of application for use in scripts
|
|
# COMPOSE_FILE = default for no app_name in docker-compose file name, app if there is
|
|
# BACKUP = if true, include this application in backup operations
|
|
# HEALTHCHECK = if true, default docker health checks for that container will be enabled
|
|
# AUTHELIA = if true, use Authelia authentication, if false turned off.
|
|
# HEADSCALE = options : false, local, remote (see general config). e.g false or local,remote
|
|
# ADMIN_EMAIL = email used for the Bookstack admin account
|
|
# ADMIN_PASSWORD = password used for the Bookstack admin account
|
|
#
|
|
CFG_BOOKSTACK_APP_NAME=bookstack
|
|
CFG_BOOKSTACK_BACKUP=true
|
|
CFG_BOOKSTACK_COMPOSE_FILE=default
|
|
CFG_BOOKSTACK_HEALTHCHECK=true
|
|
CFG_BOOKSTACK_AUTHELIA=false
|
|
CFG_BOOKSTACK_HEADSCALE=false
|
|
CFG_BOOKSTACK_ADMIN_EMAIL=admin@example.com
|
|
CFG_BOOKSTACK_ADMIN_PASSWORD=RANDOMIZEDPASSWORD3
|
|
# Secrets below feed the compose via #LIBREPORTAL|BOOKSTACK_<KEY>_TAG| tags —
|
|
# auto-generated, and (unlike a RANDOMIZED* placeholder in the compose)
|
|
# preserved across reinstalls. DB_PASSWORD is shared by the app + db services.
|
|
CFG_BOOKSTACK_APP_KEY=RANDOMIZEDAPPKEY1
|
|
CFG_BOOKSTACK_DB_PASSWORD=RANDOMIZEDPASSWORD1
|
|
CFG_BOOKSTACK_DB_ROOT_PASSWORD=RANDOMIZEDPASSWORD2
|
|
#
|
|
# =============================================================================
|
|
# METADATA
|
|
# =============================================================================
|
|
# CATEGORY = application category for grouping
|
|
# TITLE = display name for the application
|
|
# DESCRIPTION = short description of the application
|
|
# LONG_DESCRIPTION = detailed description of the application
|
|
# URL = source repository or documentation URL
|
|
# ACTIONS = available actions for this application
|
|
#
|
|
CFG_BOOKSTACK_CATEGORY="knowledge"
|
|
CFG_BOOKSTACK_TITLE="Bookstack"
|
|
CFG_BOOKSTACK_DESCRIPTION="Wiki/Knowledge Base"
|
|
CFG_BOOKSTACK_LONG_DESCRIPTION="BookStack is a simple, self-hosted wiki and documentation platform that provides a pleasant and simple way to organize and store information"
|
|
CFG_BOOKSTACK_URL="https://github.com/BookStackApp/BookStack"
|
|
CFG_BOOKSTACK_ACTIONS="configure|install|restart|shutdown|uninstall"
|
|
#
|
|
# =============================================================================
|
|
# NETWORK CONFIGURATION
|
|
# =============================================================================
|
|
# DOMAIN = number of domain from the general config, useful when using multiple domains
|
|
# HOST_NAME = subdomain name e.g test is the name for test.website.com
|
|
# WHITELIST = if true only allow whitelisted ips (see general config), if false allow all
|
|
#
|
|
CFG_BOOKSTACK_DOMAIN=1
|
|
CFG_BOOKSTACK_WHITELIST=false
|
|
CFG_BOOKSTACK_HOST_NAME=bookstack
|
|
CFG_BOOKSTACK_NETWORK=default
|
|
#
|
|
# =============================================================================
|
|
# PORT CONFIGURATION
|
|
# =============================================================================
|
|
# PORT_ = port configuration: app|name|external:internal|access|protocol|login|traefik|webui|description
|
|
# - app: application name
|
|
# - name: service identifier (webui, dns, ssh, etc.)
|
|
# - external:internal: port mapping (external can be 'random' for auto-allocation)
|
|
# - access: 'public' (internet accessible), 'private' (local network only), 'disabled' (not running)
|
|
# - protocol: 'tcp' or 'udp'
|
|
# - login: if true, this port requires basic-auth via Traefik (only meaningful when traefik=true)
|
|
# - traefik: if true, Traefik handles this port (reverse proxy)
|
|
# - webui: if true, this port serves the main web interface
|
|
# - description: human-readable description of the service
|
|
#
|
|
CFG_BOOKSTACK_PORT_1="bookstack-service|webui|random:80|public|tcp|false|true|true|Web Interface|"
|
|
|
|
# AUTH_PROFILE = capability tier for the WebUI auth tools (single_password | user_password | multi_user)
|
|
CFG_BOOKSTACK_AUTH_PROFILE=multi_user
|
|
CFG_BOOKSTACK_ADMIN_USER=
|