From a3a50fd9e0d41b157e434bbaf617151ba17011b2 Mon Sep 17 00:00:00 2001 From: Jason Phan Date: Mon, 2 Nov 2020 12:37:30 -0600 Subject: Update dispatch.sr.ht installation/config pages --- dispatch.sr.ht/configuration.md | 43 +++++++++++++++++++++++++++++++ dispatch.sr.ht/configuration_reference.md | 5 ++++ dispatch.sr.ht/installation.md | 40 +++++----------------------- 3 files changed, 55 insertions(+), 33 deletions(-) create mode 100644 dispatch.sr.ht/configuration.md create mode 100644 dispatch.sr.ht/configuration_reference.md diff --git a/dispatch.sr.ht/configuration.md b/dispatch.sr.ht/configuration.md new file mode 100644 index 0000000..5ef95aa --- /dev/null +++ b/dispatch.sr.ht/configuration.md @@ -0,0 +1,43 @@ +--- +title: dispatch.sr.ht Configuration +--- + +This document covers the configuration process for dispatch.sr.ht. + +Each dispatch.sr.ht provider is optional, you may skip the integrations you do +not need. + +# OAuth + +## GitHub + +To set up OAuth for GitHub: + +1. 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 (e.g., + `https://dispatch.sr.ht/github/callback`). +2. Place the `Client ID` and `Client Secret` provided by GitHub into your + `config.ini` in the `[dispatch.sr.ht::github]` section. + +## GitLab + +To set up OAuth for GitLab: + +1. 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/` appended (e.g. + `https://dispatch.sr.ht/gitlab/callback/gitlab.com`). +2. Add the instance to your `config.ini` 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. diff --git a/dispatch.sr.ht/configuration_reference.md b/dispatch.sr.ht/configuration_reference.md new file mode 100644 index 0000000..ec0e291 --- /dev/null +++ b/dispatch.sr.ht/configuration_reference.md @@ -0,0 +1,5 @@ +--- +title: dispatch.sr.ht Configuration Reference +--- + +This document covers the configuration options for the dispatch.sr.ht service. diff --git a/dispatch.sr.ht/installation.md b/dispatch.sr.ht/installation.md index 478286f..69345c6 100644 --- a/dispatch.sr.ht/installation.md +++ b/dispatch.sr.ht/installation.md @@ -1,41 +1,15 @@ --- -title: dispatch.sr.ht installation +title: dispatch.sr.ht Installation --- +This document covers the installation steps for dispatch.sr.ht, an event-driven +task automation service. + # 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. +dispatch.sr.ht can be installed with the [standard package +installation process](/installation.md#installing-from-packages). ## 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/` 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. +- `dispatch.sr.ht` - The web service. -- cgit