Sourcehut

Sourcehut is a software system providing git and mercurial version control hosts, a bug tracker, and a simple web UI.

Contents

  1. Sourcehut
    1. Installation
      1. Community Packages
    2. Setup and 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 on AMD64 (a.k.a. x86_64) hardware. The software is made available through custom package repositories. Enable the community repository and https://mirror.sr.ht/alpine/v3.17/sr.ht (matching the Alpine Linux version of the host). Also install the packaging key from https://mirror.sr.ht/alpine/[email protected].

Community Packages

Eli Schwartz maintains a set of packages for Arch Linux. Add https://mirror.sr.ht/archlinux/sr.ht as a custom repository and import Eli's key (at time of writing: C0AAFC1676BD998617C94C42DC59670F1EB0A189).

Setup and Configuration

Sourcehut is a modular system, with meta.sr.ht being the only mandatory 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.

Web Server

A reverse proxy is needed to dispatch between services; to serve static content; and to serve the HTTP git frontend. See Web Server for configuration information.

Mail Server

See Mail for configuration information.

A test email can be sent from https://meta.example.com/privacy.

Redis

The pools of web workers are managed through Redis queues. The connection string needs to be set in several parts of the configuration file. 

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

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

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

(And so on.) Note that each service can use an independent database if desired.

PostgreSQL

Each services is backed by a PostgreSQL database. The connection string needs to be set in several parts of the configuration file. 

[git.sr.ht]
connection-string=postgresql://postgres@localhost:5432/git.sr.ht?sslmode=disable
migrate-on-upgrade=yes

[meta.sr.ht]
connection-string=postgresql://postgres@localhost:5432/meta.sr.ht?sslmode=disable
migrate-on-upgrade=yes

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

SSH

See SSH for configuration 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