From cb00ecadb14ddbb8961a7120487359708dd44e65 Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Fri, 13 Nov 2020 09:34:08 +0100 Subject: [PATCH] document all environment variables --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 417b514..8b80039 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,25 @@ go run start.go --help ``` to get a list of available parameters and default values +## Environment variables + +| Variable | Description | +|:-- |:-- | +| `DB_HOST` | PostgreSQL hostname | +| `DB_NAME` | PostgreSQL database | +| `DB_USER` | PostgreSQL username | +| `DB_PASS` | PostgreSQL password | +| `DB_SSLMODE` | PostgreSQL SSL enabled | +| `AMQP_HOST` | AMQP hostname | +| `AMQP_USER` | AMQP username | +| `AMQP_PASS` | AMQP password | +| `BASE_HOST` | Hostname of VILLASweb | +| `BASE_PATH` | Base URL of VILLASweb | +| `MODE` | Mode: debug/release/test | +| `PORT` | Port on which the internal HTTP server listens | +| `ADMIN_USER` | Username for initial admin user | +| `ADMIN_PASS` | Password for initial admin user | +| `ADMIN_MAIL` | Mail for initial admin user | ## PostgreSQL Database Before running the application the user has to setup and configure