aboutsummaryrefslogtreecommitdiffstats
path: root/dispatch.sr.ht/installation.md
diff options
context:
space:
mode:
Diffstat (limited to 'dispatch.sr.ht/installation.md')
-rw-r--r--dispatch.sr.ht/installation.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/dispatch.sr.ht/installation.md b/dispatch.sr.ht/installation.md
new file mode 100644
index 0000000..eaf9dda
--- /dev/null
+++ b/dispatch.sr.ht/installation.md
@@ -0,0 +1,18 @@
+---
+title: dispatch.sr.ht installation
+---
+
+# Installation
+
+dispatch.sr.ht is a standard sr.ht web service and can be installed through the
+[standard procedure](/installation.md). However, there is an additional step
+required.
+
+## GitHub OAuth client
+
+You need to register your dispatch.sr.ht installation under [GitHub OAuth
+Apps](https://github.com/settings/developers). For the `Authorization callback
+URL` use the URL of your service instance with `/github/callback` appended (for
+example `https://dispatch.sr.ht/github/callback`). Put the `Client ID` and
+`Client Secret` you get from GitHub into your sourcehut config in the
+`[dispatch.sr.ht::github]` section.