X-Git-Url: https://git.siccegge.de//index.cgi?p=dane-monitoring-plugins.git;a=blobdiff_plain;f=README.md;h=15af1fa4a7bb971230d244ac2b6a1e951ae5253d;hp=13d79efede1b54a21227acde0acd9cd21bc5f901;hb=19426697a401ad52cf88d88700b3e14f05a9d4a7;hpb=3802771a4750bb8666b6f610850b2573e2823285 diff --git a/README.md b/README.md index 13d79ef..15af1fa 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ +# Scope + +The set of monitoring plugins in this repository is intended to serve +as icinga / nagios / .. checks for DANE enabled network services. The +central functionality therefore is checking whether the services +conforms with the DANE records. However, all service plugins are also +supposed to work as *the* plugin for each service and should be able +to monitor all relevant properties. + # Getting the Code The main repository is located at [git.siccegge.de][1] but mirrors can @@ -10,10 +19,11 @@ processed by mail as well as on both platforms. # Dependencies -The plugins need pyasn1, pyasn1-modules and pyunbound as well as -python3. Unfortunately the unbound package in Debian only provides -python2 modules currently. Building pyunbound from source works fine -however. +The plugins need `pyasn1`, `pyasn1-modules` and the python `unbound` +as well as python3. The `check_dnssec` module needs additionally the +python `ldns` module. Unfortunately the unbound package in Debian only +provides python2 modules currently. Building unbound with python3 +support from source works fine however. # License