From fb0ec27bcd4918af8da631d11bf93a27cb37ca47 Mon Sep 17 00:00:00 2001 From: Judge40 Date: Sat, 19 Oct 2024 20:05:04 +0100 Subject: [PATCH] docs: add the config file names to the README Add the names of the config file values to the README, making it clear how to write the config file without first modifying the config in the GUI. Resolves aceberg/ExerciseDiary#14 --- README.md | 29 +++++++++++++---------------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 7c61540..90ed9da 100644 --- a/README.md +++ b/README.md @@ -34,25 +34,22 @@ Or use [docker-compose.yml](docker-compose.yml) ## Binary PPA for amd64 .deb is [here](https://github.com/aceberg/ppa). For other binary options plese look at the [latest release](https://github.com/aceberg/ExerciseDiary/releases/latest). - ## Config - - Configuration can be done through config file or environment variables -| Variable | Description | Default | -| -------- | ----------- | ------- | -| AUTH | Enable Session-Cookie authentication | false | -| AUTH_EXPIRE | Session expiration time. A number and suffix: **m, h, d** or **M**. | 7d | -| AUTH_USER | Username | "" | -| AUTH_PASSWORD | Encrypted password (bcrypt). [How to encrypt password with bcrypt?](docs/BCRYPT.md) | "" | -| HOST | Listen address | 0.0.0.0 | -| PORT | Port for web GUI | 8851 | -| THEME | Any theme name from https://bootswatch.com in lowcase or [additional](https://github.com/aceberg/aceberg-bootswatch-fork) (emerald, grass, grayscale, ocean, sand, wood)| grass | -| COLOR | Background color: light or dark | light | -| HEATCOLOR | HeatMap color | #03a70c | -| PAGESTEP | Items on one page | 10 | -| TZ | Set your timezone for correct time | "" | +| Variable | Config File | Description | Default | +| -------- | ----------- | ----------- | ------- | +| AUTH | auth | Enable Session-Cookie authentication | false | +| AUTH_EXPIRE | auth_expire | Session expiration time. A number and suffix: **m, h, d** or **M**. | 7d | +| AUTH_USER | auth_user | Username | "" | +| AUTH_PASSWORD | auth_password | Encrypted password (bcrypt). [How to encrypt password with bcrypt?](docs/BCRYPT.md) | "" | +| HOST | host | Listen address | 0.0.0.0 | +| PORT | port | Port for web GUI | 8851 | +| THEME | theme | Any theme name from https://bootswatch.com in lowcase or [additional](https://github.com/aceberg/aceberg-bootswatch-fork) (emerald, grass, grayscale, ocean, sand, wood) | grass | +| COLOR | color | Background color: light or dark | light | +| HEATCOLOR | heatcolor | HeatMap color | #03a70c | +| PAGESTEP | pagestep | Items on one page | 10 | +| TZ | | Set your timezone for correct time | "" | ## Options