From 796545d6846ea007b2bd98e5790730146250bc07 Mon Sep 17 00:00:00 2001 From: Chaos Date: Fri, 4 Jul 2025 13:38:17 +0200 Subject: [PATCH 1/5] add envvars.md --- envvars.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 envvars.md diff --git a/envvars.md b/envvars.md new file mode 100644 index 0000000..bbb1ba2 --- /dev/null +++ b/envvars.md @@ -0,0 +1,39 @@ +# Daemon +--- + +- DAEMON_ENABLED default: false +- DAEMON_FREQUENCY default: 30s +- DAEMON_EXECUTION_TIMEOUT default: 30m + +# Discord +--- + +- DISCORD_TOKEN +- DISCORD_PUBLIC_KEY +- DISCORD_GUILD_ID +- DISCORD_CHANNEL_ID +- DISCORD_UPDATE_ROLE_ID +- DISCORD_SHOULD_CROSSPOST default: true + +# Statuspage +--- + +- STATUSPAGE_API_KEY +- STATUSPAGE_PAGE_ID +- STATUSPAGE_URL default: status.ticketsbot.cloud + +# Gateway +--- + +- SERVER_ADDR default: 8080 + +# Database +--- + +- DATABASE_URI + +# Debug +--- + +- JSON_LOGS default: false +- LOG_LEVEL default: info \ No newline at end of file From 5e1c2fe7080a1034273e03a5a18076dc30a45e1e Mon Sep 17 00:00:00 2001 From: Chaos Date: Fri, 4 Jul 2025 13:41:52 +0200 Subject: [PATCH 2/5] add envvars.md to the readme.md replacing config.go file searches for all env vars --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9677b1f..4e3fc11 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ Status Updates is a backend service that keeps your Discord community informed b ## Configuration -Configuration is managed via environment variables or a config file. See `internal/config/config.go` for all options. +Configuration is managed via environment variables or a config file. See [envvars.md](envvars.md) for all options. **Example environment variables:** ```env From 42a607c9f5dcbf91ad04ba799b91b748cc25399b Mon Sep 17 00:00:00 2001 From: Chaos Date: Fri, 4 Jul 2025 13:45:31 +0200 Subject: [PATCH 3/5] add more space between var sections --- envvars.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/envvars.md b/envvars.md index bbb1ba2..7125bf8 100644 --- a/envvars.md +++ b/envvars.md @@ -5,6 +5,7 @@ - DAEMON_FREQUENCY default: 30s - DAEMON_EXECUTION_TIMEOUT default: 30m + # Discord --- @@ -15,6 +16,7 @@ - DISCORD_UPDATE_ROLE_ID - DISCORD_SHOULD_CROSSPOST default: true + # Statuspage --- @@ -22,16 +24,19 @@ - STATUSPAGE_PAGE_ID - STATUSPAGE_URL default: status.ticketsbot.cloud + # Gateway --- - SERVER_ADDR default: 8080 + # Database --- - DATABASE_URI + # Debug --- From 50cd4bd3179d57ac570a73c4ac95f6962fc9c2e4 Mon Sep 17 00:00:00 2001 From: Chaos Date: Fri, 4 Jul 2025 15:57:50 +0200 Subject: [PATCH 4/5] Update envvars.md --- envvars.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/envvars.md b/envvars.md index 7125bf8..0549046 100644 --- a/envvars.md +++ b/envvars.md @@ -1,10 +1,3 @@ -# Daemon ---- - -- DAEMON_ENABLED default: false -- DAEMON_FREQUENCY default: 30s -- DAEMON_EXECUTION_TIMEOUT default: 30m - # Discord --- @@ -14,7 +7,7 @@ - DISCORD_GUILD_ID - DISCORD_CHANNEL_ID - DISCORD_UPDATE_ROLE_ID -- DISCORD_SHOULD_CROSSPOST default: true +- DISCORD_SHOULD_CROSSPOST default: `true` # Statuspage @@ -22,23 +15,33 @@ - STATUSPAGE_API_KEY - STATUSPAGE_PAGE_ID -- STATUSPAGE_URL default: status.ticketsbot.cloud +- STATUSPAGE_URL default: `status.ticketsbot.cloud` # Gateway --- -- SERVER_ADDR default: 8080 +- SERVER_ADDR default: `8080` # Database --- -- DATABASE_URI +- DATABASE_URI default: `postgres://postgres:${DATABASE_PASSWORD:-null}@postgres-statusbot:5432/postgres` +- DATABASE_PASSWORD default: `null` + + +# Optional Variables: + +# Daemon +--- +- DAEMON_ENABLED default: `false` +- DAEMON_FREQUENCY default: `30s` +- DAEMON_EXECUTION_TIMEOUT default: `30m` # Debug --- -- JSON_LOGS default: false -- LOG_LEVEL default: info \ No newline at end of file +- JSON_LOGS default: `false` +- LOG_LEVEL default: `info` \ No newline at end of file From a3efb73bea739ceae6128a35dad94a3e70d445e2 Mon Sep 17 00:00:00 2001 From: Chaos Date: Fri, 4 Jul 2025 18:52:38 +0200 Subject: [PATCH 5/5] Update envvars.md --- envvars.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/envvars.md b/envvars.md index 0549046..fecb938 100644 --- a/envvars.md +++ b/envvars.md @@ -1,5 +1,5 @@ -# Discord +## Discord --- - DISCORD_TOKEN @@ -10,7 +10,7 @@ - DISCORD_SHOULD_CROSSPOST default: `true` -# Statuspage +## Statuspage --- - STATUSPAGE_API_KEY @@ -18,30 +18,32 @@ - STATUSPAGE_URL default: `status.ticketsbot.cloud` -# Gateway +## Gateway --- - SERVER_ADDR default: `8080` -# Database +## Database --- -- DATABASE_URI default: `postgres://postgres:${DATABASE_PASSWORD:-null}@postgres-statusbot:5432/postgres` +**Note:** The default values below are only used when using the provided `docker-compose.yaml` file. +- DATABASE_URI default: `postgres://postgres:${DATABASE_PASSWORD:-null}@postgres-statusbot:5432/postgres?sslmode=disable` - DATABASE_PASSWORD default: `null` + # Optional Variables: -# Daemon +## Daemon --- - DAEMON_ENABLED default: `false` - DAEMON_FREQUENCY default: `30s` - DAEMON_EXECUTION_TIMEOUT default: `30m` -# Debug +## Debug --- - JSON_LOGS default: `false` -- LOG_LEVEL default: `info` \ No newline at end of file +- LOG_LEVEL default: `info`