Note: The dependencies in
setup.py may
not be up-to-date. For an up-to-date list of dependencies, consult
the latest
Alpine package.
- [meta.sr.ht][meta] — Performs various administrative tasks (e.g., storing
account details, handling logins, SSH and PGP key storage).
[meta]: https://git.sr.ht/~sircmpwn/meta.sr.ht
[core]: https://git.sr.ht/~sircmpwn/core.sr.ht
# Files
## `config.ini`
sr.ht services all use a shared configuration file, located at
`/etc/sr.ht/config.ini`. The specific options you will configure will depend on
the subset of and configuration of sr.ht services you choose to run.
Each service provides an example configuration file, called
`config.example.ini`, in their source code repository, with annotations
explaining each configuration option. You should consult these when creating
your unified `config.ini`.
## Service Files
Service files for daemons are pre-configured by their distribution packages.
After setting up your `config.ini` appropriately, you may start them using your
distribution's service manager (e.g., `service git.sr.ht start`).
The list of daemons available for each service are documented on their
respective installation page.
# Web services
Most sr.ht services include a web component, and the standard installation
procedure requires you to configure a reverse proxy to serve them. A typical
nginx configuration may look something like this:
```
server {
listen 80;
server_name meta.sr.ht;
location / {
return 302 https://$server_name$request_uri;
}
location ^~ /.well-known {
root /var/www;
}
}
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
server_name meta.sr.ht;
client_max_body_size 100M;
ssl_certificate /etc/ssl/uacme/meta.sr.ht/cert.pem;
ssl_certificate_key /etc/ssl/uacme/private/meta.sr.ht/key.pem;
location / {
proxy_pass http://127.0.0.1:5000;
}
location /query {
proxy_pass http://127.0.0.1:5100;
}
location /static {
root /usr/lib/python3.8/site-packages/metasrht;
}
}
```
Note the following requirements:
- Proxy `/` to the web application
- Serve static assets from `/static` (optional, but recommended)
- For many services, `/query` should be proxied to the API service
See [sr.ht-nginx](https://git.sr.ht/~sircmpwn/sr.ht-nginx) for the nginx
configurations we use in production.
# Databases
Each service requires its own database. It is recommended to give each service
its own database login, with full permissions for its database so that it may
manage its own schema migrations.
Once you populate the `connection-string` field in your `config.ini`, you may
use the `schema.sql` file to populate the database (e.g.
`psql -d meta.sr.ht -f schema.sql` to set up meta.sr.ht's database).
Note that if you have not configured SSL for your PostgreSQL server, you may
have to append `?sslmode=disable` to your connection string for some services
to work.
## Schema Upgrades
We use [alembic](https://alembic.zzzcomputing.com/en/latest/) to manage schema
migrations. We use custom scripts to automatically retrieve database
credentials from your `config.ini`. If you have installed from distribution
packages, set `[