diff options
| author | Drew DeVault <sir@cmpwn.com> | 2020-03-26 10:21:05 -0400 |
|---|---|---|
| committer | Drew DeVault <sir@cmpwn.com> | 2020-03-26 10:21:05 -0400 |
| commit | e62d312b36d5816b6ccfe7e23d04bf55d9425d38 (patch) | |
| tree | 2199e1ccf8c4a49240d726f3d72067242a5f360d /dispatch.sr.ht/installation.md | |
| parent | ef4f23fae41c927a529352a5e9f31a4d9b7346d9 (diff) | |
| download | sr.ht-docs-e62d312b36d5816b6ccfe7e23d04bf55d9425d38.tar.gz | |
Overhaul installation documentation
Diffstat (limited to 'dispatch.sr.ht/installation.md')
| -rw-r--r-- | dispatch.sr.ht/installation.md | 33 |
1 files changed, 28 insertions, 5 deletions
diff --git a/dispatch.sr.ht/installation.md b/dispatch.sr.ht/installation.md index eaf9dda..478286f 100644 --- a/dispatch.sr.ht/installation.md +++ b/dispatch.sr.ht/installation.md @@ -8,11 +8,34 @@ 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 -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 +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. |