phoenix/weblug
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
Simple webhook receiver program https://codeberg.org/grisu48/weblug
37 commits 16 branches 0 tags 310 KiB
Go 82.8%
Shell 15.9%
Makefile 1.3%
Go to file
Felix Niederwanger 121ab40b02
Add possibility for priviledge drop 
Adds the `uid` and `gid` settings in the main configuration file, which
allows weblug to run under a unprivileged user account. This comes with
the limitation, that unless the program runs as root, custom webhook
`uid/gid` settings are not possible.
2023-06-05 17:00:30 +02:00
cmd/weblug Add possibility for priviledge drop 2023-06-05 17:00:30 +02:00
doc Add possibility for priviledge drop 2023-06-05 17:00:30 +02:00
test Add possibility for priviledge drop 2023-06-05 17:00:30 +02: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 Add env sanitation 2023-05-28 11:44:42 +02:00
README.md Add caveats 2023-05-28 11:48:18 +02:00
weblug.service Add systemd unit 2023-04-21 18:56:27 +02:00
weblug.spec Add spec file 2023-05-16 20:33:11 +02:00
weblug.yml Add possibility for priviledge drop 2023-06-05 17:00:30 +02:00

README.md

weblug

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 yaml file. Read the usage caveats!

weblug supports multiple webhooks, limitations for concurrent web hooks to be executed, background execution and running webhooks as separate user (uid/gid).

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.

Caveats

  1. weblug does not support https encryption!

weblug is expected to run behind a http reverse proxy (e.g. apache or nginx) which handles transport encryption. The program it self does not support https, nor are there any plans to implement this in the near future.

CAVE: Don't expose secrets and credentials by running this without any transport encryption!

  1. Do not run this without reverse proxy

weblug relies on the standart go http implementation. To avoid a whole class of securtiy concerns, weblug should never run on the open internet without a http reverse proxy.

  1. weblug runs as root, when using custom UID/GIDs

In it's current implementation, weblug requires to remain running as root without dropping privileges when using custom UID/GIDs. This is a current limitation that will be hopefully resolved soon.

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.