Merge branch 'main' of ssh://github.com/jamesread/uncomplicated-alert…

…-receiver

README.md

@@ -1,4 +1,4 @@
-# uncomplicated-alert-receiver
+# uncomplicated-alert-receiver (UAR)
 
 A robust and reliable Prometheus alert receiver intended for heads up displays. It works without internet access, external dependencies, configuration files, storage, and generally has very few things to go wrong.
 
@@ -10,7 +10,36 @@ For years, I tried to create better and better Grafana dashboards on my heads up
 
 Additionally, this project is designed to be extremely robust, and reliable, and simple. It does one job (hopefully well). For day to day usage, or just referred to in emergencies, it should "just work".
 
-### **This is a No-Nonsense Open Source project;**
+## Installation
+
+UAR is distributed as a Linux container, it can run on any host port, in the example below the port is 1337;
+
+```
+docker run -p 1337:8080 --name uar ghcr.io/jamesread/uncomplicated-alert-receiver
+```
+
+## Setup 
+
+You should already have a prometheus running, as well as an alertmanager running, with at least one alert configured.
+
+Simply, edit your alertmanager.yml to add UAR as a webhook_config. Here is an example, assuming UAR is running at yourServer:8080;
+
+```yaml
+receivers:
+  - name: uar
+    webhook_configs:
+      - url: http://yourServer:8080/alerts
+        send_resolved: false
+
+route:
+  receiver: uar
+  repeat_interval: 30s
+  group_interval: 30s
+```
+
+Of course you are free to set the sending intervals to a duration that fits you. 
+
+## **This is a No-Nonsense Open Source project;**
 
 - All code and assets are Open Source (AGPL).
 - No company is paying for development, there is no paid-for support from the developers.