Sourcehut

Contents

  1. Sourcehut
    1. Installation
      1. Community Packages
      2. Development Setup
    2. Configuration
      1. Web Server
      2. Mail Server
      3. Redis
      4. PostgreSQL
      5. SSH
    3. Administration
      1. Users
      2. Git
      3. Mercurial
      4. Bug Tracker
      5. Page Hosting
      6. Mail Lists
      7. Automated Builds

Installation

Upstream only officially supports Alpine Linux 3.15 through 3.17.

To enable the package repository, add the following line to /etc/apk/repositories. It must be the first repository checked. 

https://mirror.sr.ht/alpine/v3.15/sr.ht

The community package repository must be enabled. See here for more details.

Install the packager's key and update the package index. 

wget -q -O /etc/apk/keys/[email protected] https://mirror.sr.ht/alpine/[email protected]
apk update

Sourcehut is a modular ecosystem, with meta.sr.ht being the only mandatory package (as it handles authentication and authorization). For example, to run the git and mercurial services, use git.sr.ht and hg.sr.ht, respectively. Installation and configuration of these modular services is detailed in a corresponding section under Administration.

Install the meta.sr.ht package. Start and enable three services: meta.sr.ht, meta.sr.ht-api, and meta.sr.ht-webhooks. Finally enable the metasrht-daily cronjob and set it to run daily.

Community Packages

Eli Schwartz maintains a set of packages for Arch Linux.

Add the mirror to /etc/pacman.conf: 

[sr.ht]
Server = https://mirror.sr.ht/archlinux/sr.ht

Then install the packagers' keys: 

sudo pacman-key --recv-keys C0AAFC1676BD998617C94C42DC59670F1EB0A189
sudo pacman-key --lsign-key C0AAFC1676BD998617C94C42DC59670F1EB0A189

Development Setup

TODO: copy from https://emersion.fr/blog/2021/setting-up-sr.ht-for-local-development/

Configuration

Several Sourcehut services depend on additional local services.

Web Server

Sourcehut depends on a reverse proxy to dispatch between services. Furthermore, HTTP(S) cloning is not supported for git repositories, so an external web server is required.

See Web Server for configuration information.

Mail Server

See Mail for configuration information.

To test the configuration, add an SSH key to the admin user. An automatic notification email will be generated by that trigger.

Redis

Redis will work out of the box. Configure Sourcehut with the database URI. 

[sr.ht]
...
redis-host=redis://localhost

[git.sr.ht]
...
webhooks=redis://localhost:6379/1

[meta.sr.ht]
...
webhooks=redis://localhost:6379/1

[todo.sr.ht]
...
webhooks=redis://localhost:6379/1

Note that each service can use an independent database if desired.

PostgreSQL

SSH

See SSH for setup information.

Administration

Users

To create an admin user, try: 

metasrht-manageuser -t admin -e <email> <username>

Note that admin users will permanently see a 'PRODUCTION ENVIRONMENT' banner on all pages.

With an existing admin user, users can be managed in the web UI.

Individual users then need to upload their own SSH and PGP keys, also through the web UI.

Git

Mercurial

Bug Tracker

Page Hosting

Mail Lists

Automated Builds

Anecdotally the build service is the most unreliable component of the Sourcehut ecosystem.

The master server runs the builds.sr.ht package and service. Each runner corresponds to a builds.sr.ht-worker service, which depends on the builds.sr.ht-worker and builds.sr.ht-images packages.

Upstream's production architecture thoroughly encapsulates the runners.

CategoryRicottone