aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..a6015c8
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,14 @@
+# Node exporter
+
+Set up the node exporter on _almost_ any system that has runit configured
+to use `/var/service`
+
+You will need to tweak the checksum for each platform but it tested to
+work on OpenBSD, and Linux without issue.
+
+TLS configuration is fully supported with this role, check out
+`defaults/main.yml`
+
+If you're exposing this to the public internet I highly recommend utilizing
+TLS and enabling client certificate verification. ( Examples in defaults,
+commented out )