From 027426c4f7c95fc7bde23786d71ca677f8937633 Mon Sep 17 00:00:00 2001 From: phoenix Date: Sat, 23 Sep 2023 10:57:47 +0200 Subject: [PATCH] Improve the readability Change the wording and construction of the README file for better readability. --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4a253ed..2e60819 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,22 @@ # 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. +`weblug` is is a configurable webhook receiver that allows users to run arbitrary programs and script when a webhook is triggered. The configuration happens via a [yaml file](weblug.yml). Read the [usage caveats](#caveats)! -`weblug` supports multiple webhooks, limitations for concurrent web hooks to be executed, background execution and running webhooks as separate user (`uid`/`gid`). +`weblug` supports multiple webhooks via different URL paths, concurrency limitations, 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](weblug.yml) for an example configuration. Then run +Webooks are defined via a yaml file. See [weblug.yml](weblug.yml) for an example configuration. Pass the yaml file(s) to `weblug` to starting the webserver and waiting for incoming webhooks: ./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! +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. @@ -26,11 +24,11 @@ CAVE: Don't expose secrets and credentials by running this without any transport 2. 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. +`weblug` relies on the standart go http implementation. To avoid a whole class of security issues, `weblug` should never run on the open internet without a http reverse proxy. 3. `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. +In it's current implementation, `weblug` requires to remain running as root without dropping privileges when using custom UID/GIDs. ## Build