init - no version yet

README.md

@@ -0,0 +1,80 @@
+# Chorus Monitoring
+
+Status: Beta
+
+Chorus is supposed to be a serverless mesh monitoring 'solution'.
+
+It is a simple script that checks endpoints via ICMP, HTTP and TCP. Rollout it manually or with any automation tool and use cronjob, systemd timers to run it in your preferred freqyency.
+
+Goals:
+- keeping it simple to understand and to modify
+- avoiding a single-point-of-failure
+
+Use cases:
+- let hosts monitor eachother
+- let many hosts monitor some endpoints
+
+Suited for:
+- small envs
+- homelabs
+- temporary envs
+- backup monitoring for critical endpoints
+
+---
+
+## Features
+
+**Available**:
+- Check via ICMP,HTTP and TCP
+- temp files with down endpoints to avoid notification spam
+- modular functions
+- simple with board tools only
+
+**Ideas**:
+- host based exclusions
+- optional server for logs and status page?
+- DNS checks
+- file integrity check?
+- systemd checks?
+- Windows and other platforms?
+
+**Not planned**:
+
+---
+
+## Installation
+
+1. modify the script
+    a. notification methods
+    b. what endpoint should be monitored.
+    c. maybe modify threshold of retries after fail
+2. rollout script too all endpoints manually or via automation
+3. run script perioidicly (cronjob, systemd timers, etc)
+
+Will rework this section later.
+
+---
+
+## Security
+
+For security concerns or reports, please contact via `hello a t uphillsecurity d o t com` [gpg](https://uphillsecurity.com/gpg).
+
+---
+
+## License
+
+**Apache License**
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+- ✅ Commercial use
+- ✅ Modification
+- ✅ Distribution
+- ✅ Patent use
+- ✅ Private use
+- ✅ Limitations
+- ❌Trademark use
+- ❌Liability
+- ❌Warranty