diff --git a/INSTALL b/INSTALL index f30714cf..763da3b7 100644 --- a/INSTALL +++ b/INSTALL @@ -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. diff --git a/doc/git-interface.txt b/doc/git-interface.txt index f9409612..8c6806f7 100644 --- a/doc/git-interface.txt +++ b/doc/git-interface.txt @@ -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`