~sircmpwn/sr.ht-docs

ref: 1370dbbb39ffc74a77b448586b4f207a1bf47db5 sr.ht-docs/hg.sr.ht/installation.md -rw-r--r-- 1.8 KiB
1370dbbbDrew DeVault Remove headers from git/hg tutorials 2 years ago

#title: hg.sr.ht installation

hg.sr.ht is the hg repository hosting service for the sr.ht network.

#Installation

hg.sr.ht is a standard sr.ht web service and can be installed through the standard procedure. However, there are several additional steps required.

#Repository storage

You will need to set up a directory for repositories to be stored in - we suggest /var/lib/hg/. Also configure a hg user and assign ownership over /var/lib/hg/ to this user. The hg.sr.ht package will automatically prepare these for you. If you do not use the package, you must create the user yourself and ensure that the hg.sr.ht web application runs as this user.

#SSH dispatch

At the moment, hg.sr.ht uses git.sr.ht's SSH dispatcher, which you need to setup as the system-wide SSH authorization hook. See the git.sr.ht documentation for more information.

Once this is done, you need to make the hg.sr.ht authorization hook be part of the SSH dispatching, via the hgsrht-keys and hgsrht-shell scripts. See the [dispatch] section of you hg.sr.ht configuration for details on how this works.

Authorization logs are written to hg-srht-shell.

#Cronjobs

You must also configure hgsrht-periodic to run periodically with your favorite cron daemon. We recommend the following crontab:

*/20 * * * * hgsrht-periodic

#HTTP(s) Cloning

hg.sr.ht does not do this for you - you need to wire it up in nginx. Here's an example config:

location = /authorize {
		proxy_pass http://127.0.0.1:5001;
		proxy_pass_request_body off;
		proxy_set_header Content-Length "";
		proxy_set_header X-Original-URI $request_uri;
}

location ~ ^/[~^][a-z0-9_]+/[a-zA-Z0-9_.-]+/\.hg.*$ {
		auth_request /authorize;
		root /var/lib/mercurial;
}