From 2c3a24afb749b99e4ed5bee833c01b74d48e560a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Mierzwa?= Date: Sat, 22 Apr 2017 21:06:34 -0700 Subject: [PATCH] Add a note about security --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index db7fb2743..573fb72e0 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,17 @@ to alert data, therefore safe to be accessed by wider audience. Alertmanager's API isn't stable yet and can change between releases. unsee currently supports Alertmanager `0.4` and `0.5`. +## Security + +The unsee process doesn't send any API request to the Alertmanager that could +modify alerts or silence state, but it does provide a web interface that allows +a user to send such requests directly to the Alertmanager API. +If you wish to deploy unsee as a read-only tool please ensure that: + + * the unsee process is able to connect to the Alertmanager API + * read-only users are able to connect to the unsee web interface + * read-only users are NOT able to connect to the Alertmanager API + ## Metrics unsee process metrics are accessible under `/metrics` path by default.