phoenix/weblug
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
Simple webhook receiver program https://codeberg.org/grisu48/weblug
24 commits 16 branches 0 tags 310 KiB
Go 82.8%
Shell 15.9%
Makefile 1.3%
Go to file
Felix Niederwanger bb075137cb
Improve the documentation 
Improve the wording to make it more clear, that weblug can run rootless.
Also adjust the yaml layout.
2023-04-22 10:58:40 +02:00
cmd/weblug Add allow and blocked to yaml definitions 2023-04-22 10:49:48 +02:00
test Add testing 2022-12-29 16:03:11 +01:00
.gitignore Initial commit 2022-02-08 09:58:24 +01:00
go.mod Increase to go1.18 2022-12-29 16:12:52 +01:00
go.sum First prototype 2022-02-08 11:25:22 +01:00
LICENSE Initial commit 2022-02-08 09:58:24 +01:00
Makefile Refactor hook 2023-04-22 10:23:03 +02:00
README.md Improve the documentation 2023-04-22 10:58:40 +02:00
weblug.service Add systemd unit 2023-04-21 18:56:27 +02:00
weblug.yml Improve the documentation 2023-04-22 10:58:40 +02:00

README.md

weblug

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.

The configuration happens via a simple yaml file.

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

To use weblug you need to define webooks in a yaml file. See weblug.yml for an example configuration. Then run

./weblug YAML-FILE

This starts the webserver and listens for incoming webhooks.

weblug can run as any user, however for custom uid/gid webhooks, the program needs to run as root.

Build

make               # Build weblug
make static        # Make a static binary

Run as systemd unit

This repository provides an example weblug.service, which can be used to start weblug as systemd service. This file can be placed in /etc/systemd/system/weblug.service and in conjunction with an adequate weblug.yml file e.g. in /etc/weblug.yml this provides a way of running weblug as a native systemd service.