phoenix/weblug
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Improve documentation

Browse source
This commit is contained in:
Felix Niederwanger 2022-12-29 16:12:39 +01:00
parent 495c14afcc
commit add0cdb119
Signed by: phoenix
GPG key ID: 31860289A704FB3C
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,8 +1,10 @@
# weblug
Simple webhook receiver program.
Simple webhook receiver program. `weblug` is is a configurable webhook receiver that allows users to define custom programs and script to be executed when a webhook is triggered.
weblug is the counter-part for web-hooks that allows custom programs and scripts to be executed when a configurable webook is triggered.
The configuration happens via a simple [yaml file](weblug.yaml).
`weblug` supports multiple webhooks, limitations for concurrent web hooks to be executed, background execution and running webhooks as separate user (`uid`/`gid`). And all of this in a tidy, easy-to-use yaml file!
## Usage
@ -12,7 +14,9 @@ To use `weblug` you need to define webooks in a yaml file. See [weblug.yaml](web
This starts the webserver and listens for incoming webhooks.
Note: for custom `uid`/`gid` webhooks, the program needs to run as root.
## Build
make # Build weblug
make static # Make a static binary
make static # Make a static binary