From c3947e10163b6133f6cdad9ecd05f8ba0b663a40 Mon Sep 17 00:00:00 2001
From: kolaente <k@knt.li>
Date: Tue, 17 Oct 2023 19:47:23 +0200
Subject: [PATCH] docs(webhooks): add webhook config to sample config

---
 config.yml.sample                | 10 +++++++
 docs/content/doc/setup/config.md | 50 ++++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+)

diff --git a/config.yml.sample b/config.yml.sample
index 3a56d948b69..954118d9cd4 100644
--- a/config.yml.sample
+++ b/config.yml.sample
@@ -346,3 +346,13 @@ defaultsettings:
   language: <unset>
   # The time zone of each individual user. This will affect when users get reminders and overdue task emails.
   timezone: <time zone set at service.timezone>
+
+webhooks:
+  # Whether to enable support for webhooks
+  enabled: true
+  # The timout in seconds until a webhook request fails when no response has been received.
+  timoutseconds: 30
+  # The URL of [a mole instance](https://github.com/frain-dev/mole) to use to proxy outgoing webhook requests. You should use this and configure appropriately if you're not the only one using your Vikunja instance. More info about why: https://webhooks.fyi/best-practices/webhook-providers#implement-security-on-egress-communication. Must be used in combination with `webhooks.password` (see below).
+  proxyurl:
+  # The proxy password to use when authenticating against the proxy.
+  proxypassword:
diff --git a/docs/content/doc/setup/config.md b/docs/content/doc/setup/config.md
index ba4002a971d..b1030685077 100644
--- a/docs/content/doc/setup/config.md
+++ b/docs/content/doc/setup/config.md
@@ -1327,3 +1327,53 @@ Full path: `defaultsettings.timezone`
 Environment path: `VIKUNJA_DEFAULTSETTINGS_TIMEZONE`
 
 
+---
+
+## webhooks
+
+
+
+### enabled
+
+Whether to enable support for webhooks
+
+Default: `true`
+
+Full path: `webhooks.enabled`
+
+Environment path: `VIKUNJA_WEBHOOKS_ENABLED`
+
+
+### timoutseconds
+
+The timout in seconds until a webhook request fails when no response has been received.
+
+Default: `30`
+
+Full path: `webhooks.timoutseconds`
+
+Environment path: `VIKUNJA_WEBHOOKS_TIMOUTSECONDS`
+
+
+### proxyurl
+
+The URL of [a mole instance](https://github.com/frain-dev/mole) to use to proxy outgoing webhook requests. You should use this and configure appropriately if you're not the only one using your Vikunja instance. More info about why: https://webhooks.fyi/best-practices/webhook-providers#implement-security-on-egress-communication. Must be used in combination with `webhooks.password` (see below).
+
+Default: `<empty>`
+
+Full path: `webhooks.proxyurl`
+
+Environment path: `VIKUNJA_WEBHOOKS_PROXYURL`
+
+
+### proxypassword
+
+The proxy password to use when authenticating against the proxy.
+
+Default: `<empty>`
+
+Full path: `webhooks.proxypassword`
+
+Environment path: `VIKUNJA_WEBHOOKS_PROXYPASSWORD`
+
+