update documentation

Signed-off-by: Kevin Morris <kevr@0cost.org>
This commit is contained in:
Kevin Morris 2022-01-18 01:40:47 -08:00
parent ce7c44758e
commit 3102736b13
No known key found for this signature in database
GPG key ID: F7E46DED420788F3
2 changed files with 25 additions and 0 deletions

View file

@ -186,3 +186,10 @@ and call it below:
And edit the configuration file to enabled redis caching
(`[options] cache = redis`).
11) Start `aurweb.service`.
An example systemd unit has been included at `examples/aurweb.service`.
This unit can be used to manage the aurweb asgi backend. By default,
it is configured to use `poetry` as the `aur` user; this should be
configured as needed.

View file

@ -111,3 +111,21 @@ receive.autogc to false. Remember to periodically run `git gc` manually or
setup a maintenance script which initiates the garbage collection if you follow
this advice. For gc.pruneExpire, we recommend "3.months.ago", such that commits
that became unreachable by TU intervention are kept for a while.
Script Wrappers (poetry)
------------------------
When aurweb is installed within a poetry virtualenv, commands need
to be prefixed with `poetry run`. A few wrapper scripts are provided
which automate this, as long as the executing user's `$HOME` is
aurweb's project root.
- `examples/aurweb-git-auth.sh`
- `examples/aurweb-git-serve.sh`
- `examples/aurweb-git-update.sh`
These scripts should be installed somewhere on the aurweb host. The
following options need to be updated to the installed wrappers:
- `[auth] git-serve-cmd`
- `[serve] git-update-cmd`