This document covers the installation steps common to all sr.ht services.

If you would like to hack on or contribute sr.ht, see the Hacking page.
Warning: Currently, the only officially supported method for installing sr.ht software is through packages on Alpine Linux hosts.

sr.ht is a distributed system in which each service (e.g., git.sr.ht, builds.sr.ht) runs independently with its own database and resources, communicates with other services through their respective APIs and webhooks, and is highly tolerant to the temporary or permanent absence of its peers. This type of design allows you to choose and deploy any subset of services depending on your needs, making it ideal for both large-scale deployments and small-scale installations.

However, being distributed also means that the installation and deployment process of can become a bit more involved. In particular, many sr.ht services have their own, unique requirements that necessitate extra installation steps. Consult each service's installation page for more details:

#sr.ht-admins

If you are a sr.ht system administrator, we encourage you to to subscribe to the sr.ht-admins mailing list, a low-volume list of sysadmin-oriented announcements regarding breaking changes, security vulnerabilities, and so on.

#Prerequisites

Most sr.ht services require the following:

  • A PostgreSQL server - persistent storage

  • A Redis server - ephemeral storage, caching, work distribution

  • A mail server - incoming/outgoing mail

  • A cron daemon - scheduled tasks

#Installing From Packages

  1. Add the appropriate SourceHut package repository to your package manager.

  2. Install your sr.ht services!

Note: For any distribution-related issues, please contact the appropriate maintainers listed on the Packages page.
Note: Packages ship with the correct users and groups set up, as well as the correct daemon configurations for your distribution's init system.

#Next Steps

After installing your sr.ht services, you'll need to configure them. For more information, see the Configuration page.

About this wiki

commit 20a59da64e2177e4516596f20100fbb69d82e520
Author: Drew DeVault <sir@cmpwn.com>
Date:   2020-11-24T11:15:33-05:00

Add API configuration to installation docs
Clone this wiki
https://git.sr.ht/~sircmpwn/sr.ht-docs (read-only)
git@git.sr.ht:~sircmpwn/sr.ht-docs (read/write)