aboutsummaryrefslogtreecommitdiff
path: root/cmd/silentct-mon/examples.help2man
diff options
context:
space:
mode:
Diffstat (limited to 'cmd/silentct-mon/examples.help2man')
-rw-r--r--cmd/silentct-mon/examples.help2man38
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.