From aba0f17953c9947bb51e78ed581f4e66b7012518 Mon Sep 17 00:00:00 2001 From: Rasmus Dahlberg Date: Thu, 16 May 2024 12:48:22 +0200 Subject: 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. --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d60d933..eb0e74d 100644 --- a/README.md +++ b/README.md @@ -25,15 +25,15 @@ certificate is found that no node submitted, only then is an alert printed. ### Setup a node -You will need the `silent-ctnode` tool to create submissions that the monitor -can pull. Install: +You will need the `silentct-mac` tool to create submissions that the monitor can +pull. Install: - $ go install rgdd.se/silent-ct/cmd/silent-ctnode@latest + $ go install rgdd.se/silent-ct/cmd/silentct-mac@latest Locate the node's certificates that are still valid (i.e., not expired) and prepare a submission for them: - $ silent-ctnode -n NAME -s SECRET /path/to/chain-1.pem /path/to/chain-2.pem ... + $ silentct-mac -n NAME -s SECRET /path/to/chain-1.pem /path/to/chain-2.pem ... `NAME` is an arbitrary name of the node. @@ -56,7 +56,7 @@ Repeat this setup if there are multiple nodes. Install on the system that will run the monitor: - $ go install rgdd.se/silent-ct/cmd/silent-ctmoon@latest + $ go install rgdd.se/silent-ct/cmd/silentct-mon@latest Create a monitor policy file in JSON format. Below is an example that looks for all certificates related to `example.org`, expect for certificates that are @@ -95,12 +95,12 @@ your setup. Also add the domains each node is allowed to put into certificates. Bootstrap the monitor in a non-existent directory: - $ silent-ctmoon --bootstrap -f policy.json -d /path/to/directory -v INFO + $ silentct-mon --bootstrap -f policy.json -d /path/to/directory -v INFO ... Leave the monitor running: - $ silent-ctmoon -f policy.json -d /path/to/directory + $ silentct-mon -f policy.json -d /path/to/directory Any noteworthy events (like a potentially mis-issued certificate that no node submitted) will be printed on stdout. If you prefer to get the monitor's output -- cgit v1.2.3