summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..94a0059
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# icingaweb2-module-statusmap
+
+This is a very basic status map module for Icingaweb 2.
+
+## Installation
+
+To install, check out this repo to your icingaweb2 modules directory:
+```bash
+git clone https://github.com/invliD/icingaweb2-module-statusmap.git /usr/share/icingaweb2/modules/statusmap
+```
+
+In addition, the monitoring module does not contain an IDO model class and a DataView, so you need to link those files into that module:
+```bash
+ln -s ../../../../../../statusmap/library/Monitoring/Backend/Ido/Query/HostdependencyQuery.php /usr/share/icingaweb2/modules/monitoring/library/Monitoring/Backend/Ido/Query/HostdependencyQuery.php
+ln -s ../../../../statusmap/library/Monitoring/DataView/Hostdependency.php /usr/share/icingaweb2/modules/monitoring/library/Monitoring/DataView/Hostdependency.php
+```
+
+## Contributing
+If you want to contribute to this project:
+
+- Fork the repository
+- Hack your changes
+- Submit a Pull Request
+
+## License
+This project is licensed under the GNU GPLv2. See COPYING.md for the full license text.