summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8cc7c16
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Icinga DB
+
+Icinga DB is a set of components for publishing, synchronizing and
+visualizing monitoring data in the Icinga ecosystem, consisting of:
+
+* The Icinga DB daemon, which synchronizes monitoring data between a Redis server and a database
+* Icinga 2 with its [Icinga DB feature](https://icinga.com/docs/icinga-2/latest/doc/14-features/#icinga-db) enabled,
+ responsible for publishing the data to the Redis server, i.e. configuration and its runtime updates, check results,
+ state changes, downtimes, acknowledgements, notifications, and other events such as flapping
+* And Icinga Web with the
+ [Icinga DB Web](https://icinga.com/docs/icinga-db-web) module enabled,
+ which connects to both Redis and the database to display and work with the most up-to-date data
+
+![Icinga DB Architecture](doc/images/icingadb-architecture.png)
+
+## Documentation
+
+Icinga DB documentation is available at [icinga.com/docs](https://icinga.com/docs/icinga-db).
+
+## License
+
+Icinga DB and the Icinga DB documentation are licensed under the terms of the
+[GNU General Public License Version 2](LICENSE).