summaryrefslogtreecommitdiff
path: root/attic/root-watcher/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'attic/root-watcher/README.md')
-rw-r--r--attic/root-watcher/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/attic/root-watcher/README.md b/attic/root-watcher/README.md
new file mode 100644
index 00000000..ded6a63f
--- /dev/null
+++ b/attic/root-watcher/README.md
@@ -0,0 +1,8 @@
+Root Server Watcher
+======
+
+This is a small daemon written in NodeJS that watches a set of root servers and records peer status information into a Postgres database.
+
+To use type `npm install` to install modules. Then edit `config.json.example` and rename to `config.json`. For each of your roots you will need to configure a way for this script to reach it. You will also need to use `schema.sql` to initialize a Postgres database to contain your logs and set it up in `config.json` as well.
+
+This doesn't (yet) include any software for reading the log database and doing anything useful with the information inside, though given that it's a simple SQL database it should not be hard to compose queries to show interesting statistics.