diff options
author | Rasmus Dahlberg <rgdd@glasklarteknik.se> | 2024-05-16 12:48:22 +0200 |
---|---|---|
committer | Rasmus Dahlberg <rgdd@glasklarteknik.se> | 2024-05-16 17:26:38 +0200 |
commit | aba0f17953c9947bb51e78ed581f4e66b7012518 (patch) | |
tree | 6fbbbfe369224ca17088e429e49082f6ce9d5f5a /cmd/silentct-mon/examples.help2man | |
parent | 6567c8f4ec3eefb855c6ef630a53b0fb8d8bf1e9 (diff) |
Add man pages and installer Makefile
Includes renaming of the tools, part one of trying to simplify
terminology and letting go of "node" and "moon". Improving the
terminology was suggested by Martin H a while back, thank you.
Diffstat (limited to 'cmd/silentct-mon/examples.help2man')
-rw-r--r-- | cmd/silentct-mon/examples.help2man | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/cmd/silentct-mon/examples.help2man b/cmd/silentct-mon/examples.help2man new file mode 100644 index 0000000..7a1e8fc --- /dev/null +++ b/cmd/silentct-mon/examples.help2man @@ -0,0 +1,38 @@ +[EXAMPLES] + +A basic configuration is shown below. + + { + "monitor": [ + { + "bootstrap_at": "2024-05-16T00:00:00Z", + "wildcard": "example.org", + "excludes": [ + "test" + ] + } + ], + "nodes": [ + { + "name": "example.org", + "secret": "sikritpassword", + "url": "https://www.example.org/silent-ct/allowlist", + "issues": [ + "example.org", + "www.example.org" + ] + } + ] + } + +Bootstrap a new monitor in a non-existent directory: + +.B $ silentct-mon -b -d ~/.local/lib/silent-ct -f ~/.config/silent-ct/config.json + +Run the monitor continuously: + +.B $ silentct-mon -d ~/.local/lib/silent-ct -f ~/.config/silent-ct/config.json + +Use +.B -v DEBUG +to see what's happening underneath the hood. |