From f6cd3afcf3215ab9efd6cc354dca34ced618b280 Mon Sep 17 00:00:00 2001
From: Ophestra Umiker <cat@ophivana.moe>
Date: Thu, 17 Oct 2024 17:49:48 +0900
Subject: [PATCH] docs(conf): document configuration environment variables
Signed-off-by: Ophestra Umiker <cat@ophivana.moe>
---
README.md | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/README.md b/README.md
index 9a84054..3738338 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,19 @@ A lightweight, high-performance waitlist backend written in Go, using [Fiber v3]
```
+## Configuration Documentation
+
+| Name | Usage | Default |
+|---------------------|--------------------------------------------------|------------------|
+| DB | Filesystem path to database. Can be relative. | db |
+| LISTEN | Filesystem path to UNIX socket to listen on. | unset |
+| LISTEN_ADDR | Address to listen on if LISTEN is unset. | 127.0.0.1:3000 |
+| ALLOWED_URL | Allowed URL enforced by CORS. | https://hizla.io |
+| HCAPTCHA_SITE_KEY | hCaptcha site key. Disables hCaptcha if unset. | unset |
+| HCAPTCHA_SECRET_KEY | hCaptcha secret key. Disables hCaptcha if unset. | unset |
+| VERBOSE | Verbose logging. Set 0 to disable. | 1 |
+
+
## API Documentation
### Routes
--
GitLab