~sircmpwn/sr.ht-docs

ref: e62d312b36d5816b6ccfe7e23d04bf55d9425d38 sr.ht-docs/dispatch.sr.ht/installation.md -rw-r--r-- 1.4 KiB View raw
e62d312bDrew DeVault Overhaul installation documentation 2 months ago

title: dispatch.sr.ht installation

Installation

dispatch.sr.ht is a standard sr.ht web service and can be installed through the standard procedure. However, there is an additional step required.

Daemons

  • dispatch.sr.ht: the web service

GitHub OAuth client

Register under GitHub OAuth Apps. 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.

GitLab OAuth Client

Register under GitLab Applications. For the scopes required, select api. For the callback, specify the URL of your service with /gitlab/callback/<gitlab instance> appended, e.g. https://dispatch.sr.ht/gitlab/callback/gitlab.com. Add the instance to your config file under [dispatch.sr.ht::gitlab] as a single option, whose key is the FQDN of the GitLab instance in question, and whose value is the instance name, Application ID and Secret, separated by a colon. For example:

[dispatch.sr.ht::gitlab]
# ...
gitlab.com=GitLab:application id...:secret...
gitlab.freedesktop.org=gitlab.freedesktop.org:application id...:secret...

Repeat this process for any additional instances you wish to support.