Add FAQ page

This commit is contained in:
southerntofu 2020-04-28 11:32:02 +02:00
parent 2c011a71df
commit 4350e43141
1 changed files with 22 additions and 0 deletions

22
docs/faq.md Normal file
View File

@ -0,0 +1,22 @@
# FAQ
## How can i manually trigger update for a repo
If you want to integrate third-party tooling as an unprivileged user (i.e. not an endpoint), you can use the unprivileged `forgehook-trigger` command:
```
$ forgehook-trigger https://tildegit.org/tilde-fr/infra
```
This is handy in case you do not have ownership over the repository (and nobody on the server does), but you've got another channel at hand to receive updates (maybe an IRC bot).
## How can i trigger update for a repo system-wide?
So basically, you're building an endpoint! All you need is running `forgehook-notify` command. This requires group membership to the forgehook group, or root privileges:
```
# adduser notifier forgehook
# su notifier
$ # I am now privileged to notify updates for all users
$ forgehook-notify https://tildegit.org/tilde-fr/infra
```