From 1d0698071d51257e5d795671af6eed5b7af1c651 Mon Sep 17 00:00:00 2001 From: Igor Soarez Date: Sat, 24 Oct 2026 16:24:03 +0100 Subject: pirc-extension 0.1.3 --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 907da97..adf34e6 100644 --- a/README.md +++ b/README.md @@ -26,19 +26,27 @@ relay. ## Enrol -On the relay, issue a host token (`pirc-relay add-host --label `). In pi: ``` -/pirc enrol wss://: +/pirc enrol wss://: ``` +The footer reads "pirc: awaiting approval" until the relay's operator +approves the host: on the relay, `pirc-relay pending` lists the hosts +waiting, and `pirc-relay approve ` admits one. Compare the key with the +one `/pirc status` shows here: the label is whatever the host claims. + +Or, to skip the approval, issue a host token on the relay first +(`pirc-relay add-host --label `) and give it to the command: +`/pirc enrol wss://: `. + `/pirc status` shows the connection, and `/pirc reconnect` reconnects. The enrolment is saved in `~/.config/pirc/host.json` (or the file `PIRC_CONFIG` names), with the host's key beside it in `host.key`; every pi process on the host uses the same key. `PIRC_RELAY` overrides the relay URL, and `PIRC_TOKEN` supplies a registration token, so a host can be -enrolled without the command. +enrolled without the command; a relay URL without a token asks for approval. If the relay's certificate is self-signed or from a private CA, set `NODE_EXTRA_CA_CERTS` to the CA's PEM file in the environment pi starts in. -- cgit v1.2.3