Skip to content

Commit 9a785a7

Browse files
committed
chore:: add config options to readme
1 parent ec08ab3 commit 9a785a7

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,20 @@ docker compose up -d
2020
> [!NOTE]
2121
> The docker compose file builds the image from scratch by default but there are also available prebuilt images in the packages section.
2222
23+
## Configuration
24+
25+
The server is configured using environment variables, the following options are supported:
26+
27+
| Name | Type | Description | Default |
28+
| ---------------------- | ------------ | ---------------------------------------------------------- | -------------------- |
29+
| `DB_PATH` | string | Path to the SQLite database file. | `/data/analytics.db` |
30+
| `PORT` | number | The port to run the server on. | `8080` |
31+
| `ADDRESS` | string | The address to bind the server to. | `0.0.0.0` |
32+
| `RATE_LIMIT_COUNT` | number | Maximum number of requests per minute per IP. | `3` |
33+
| `CORS_ALLOWED_ORIGINS` | string/array | Comma-separated list of allowed CORS origins. | `*` |
34+
| `TRUSTED_PROXIES` | string/array | Comma-separated list of trusted proxy IPs. | `""` (empty) |
35+
| `LOG_LEVEL` | string | Log level (trace, debug, info, warn, error, fatal, panic). | `info` |
36+
2337
## Contributing
2438

2539
If you like you can contribute to this project by picking up an [issue](https://github.com/steveiliop56/tinyauth-analytics/issues) or creating a [pull request](https://github.com/steveiliop56/tinyauth-analytics/pulls). Contributing is appreciated a lot!

0 commit comments

Comments
 (0)