Renaming stuff

This commit is contained in:
southerntofu 2020-04-28 11:39:44 +02:00
parent 3608b19641
commit ac75b0536a
3 changed files with 5 additions and 5 deletions

View File

@ -32,8 +32,8 @@ forgehook is a collection of scripts to let users manage their subscriptions to
The three components of forgehook are:
- **endpoints** which receive and validate webhooks of dubious authenticity (through a shared secret) (TODO: no endpoint is implemented yet!)
- **databases** which retrieve/store subscriptions and secrets (TODO: rename webhook-backend into databases/unix.sh in the repo)
- **triggers** which does stuff as a subscribed user in case of update (TODO: rename webhook-run-backend into triggers/git-build)
- **databases** which retrieve/store subscriptions and secrets
- **triggers** which does stuff as a subscribed user in case of update
Although there can be many endpoints, there can only ever be one database and one trigger configured for the system. These components are interchangeable as they follow simple interfaces described in the [Endpoints](#endpoints), [Triggers](#triggers) and [Databases](#databases) sections.
@ -117,7 +117,7 @@ There are two [entry points](https://en.wikipedia.org/wiki/Entry_point) for the
- an endpoint running `forgehook-notify` to announce a legitimate update was received for a remote
`forgehook-notify` takes the URL of the updated repository as argument, checks for current user subscription, and runs the trigger backend `/usr/local/bin/forgehook-trigger-backend` as each user currently subscribed. The forgehook CLI interface is further described [here](docs/cli.md).
`forgehook-notify` takes the URL of the updated repository as argument, checks for current user subscription, and runs the trigger (`/usr/local/bin/forgehook-trigger`) as each user currently subscribed. The forgehook CLI interface is further described [here](docs/cli.md).
In the following sections, we'll explore how [endpoints](#endpoints), [triggers](#triggers) and [databases](#databases) are.

View File

@ -8,7 +8,7 @@ if [[ $? != 0 ]]; then
exit 1
fi
# Start the backend escalating privileges to its owner
# Start forgehook-db escalating privileges to its owner
# TODO: introduce timeout on a dummy sudo to check sudo rules
# are setup properly
sudo -u "$owner" forgehook-db $@

View File

@ -5,7 +5,7 @@
DEST="/usr/local/bin"
# TODO: Make trigger configurable
TRIGGER=./backends/git-build
TRIGGER=./triggers/git-build
DATABASE=./databases/unix
# Autodetect forgehook user if it's already setup