aboutsummaryrefslogtreecommitdiffstats
path: root/dispatch.sr.ht/installation.md
blob: 478286fd88b605e049c2de5cd914052882aacc49 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
---
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.

## Daemons

- `dispatch.sr.ht`: the web service

## GitHub OAuth client

Register 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.

## GitLab OAuth Client

Register under [GitLab Applications](https://gitlab.com/profile/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.