From a2d83f5f21a21192505ad85f45c8bfb71b62a1cb Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Thu, 22 Sep 2022 02:19:42 +0300 Subject: [PATCH] docs: Add configuration page --- packages/docs/pages/.vitepress/config.js | 2 +- packages/docs/pages/advanced/configuration.md | 28 +++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 packages/docs/pages/advanced/configuration.md diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index 7155875b..1399aab8 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -67,7 +67,7 @@ export default defineConfig({ text: 'Advanced', collapsible: true, items: [ - { text: 'Configuration', link: '/introduction' }, + { text: 'Configuration', link: '/advanced/configuration' }, { text: 'Database', link: '/introduction' }, { text: 'Credentials', link: '/introduction' }, { text: 'Telemetry', link: '/advanced/telemetry' }, diff --git a/packages/docs/pages/advanced/configuration.md b/packages/docs/pages/advanced/configuration.md new file mode 100644 index 00000000..6092a865 --- /dev/null +++ b/packages/docs/pages/advanced/configuration.md @@ -0,0 +1,28 @@ +# Configuration + +## How to set environment variables? + +You can modify the `docker-compose.yml` file to override environment variables. Please do not forget to change in `main` and `worker` services of docker-compose since the following variables might be used in both. + +## Environment Variables + +:::warning +The default values for some environment variables might be different in our development setup but following table shows the default values for docker-compose setup, which is the recommended way to run the application. +::: + +| Variable Name | Type | Default Value | Description | +| ------------------- | ------- | ------------------ | ----------------------------------- | +| `HOST` | string | `localhost` | HTTP Host | +| `PROTOCOL` | string | `http` | HTTP Protocol | +| `PORT` | string | `3000` | HTTP Port | +| `APP_ENV` | string | `production` | Automatisch Environment | +| `POSTGRES_DATABASE` | string | `automatisch` | Database Name | +| `POSTGRES_PORT` | number | `5432` | Database Port | +| `POSTGRES_HOST` | string | `postgres` | Database Host | +| `POSTGRES_USERNAME` | string | `automatisch_user` | Database User | +| `POSTGRES_PASSWORD` | string | | Password of Database User | +| `ENCRYPTION_KEY` | string | | Encryption Key to store credentials | +| `APP_SECRET_KEY` | string | | Secret Key to authenticate the user | +| `REDIS_HOST` | string | `redis` | Redis Host | +| `REDIS_PORT` | number | `6379` | Redis Port | +| `TELEMETRY_ENABLED` | boolean | `true` | Enable/Disable Telemetry |