diff options
| author | Igor Soarez <igor@soarez.org> | 2026-10-24 16:24:03 +0100 |
|---|---|---|
| committer | Igor Soarez <igor@soarez.org> | 2026-10-24 16:24:03 +0100 |
| commit | 1d0698071d51257e5d795671af6eed5b7af1c651 (patch) | |
| tree | ccb76220c2595d0453e123c7c00473b93c8f076c /README.md | |
| parent | d9df76f4fcf6c866e7907878dafb9f7cd969ad4f (diff) | |
pirc-extension 0.1.3v0.1.3
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 11 insertions, 3 deletions
@@ -26,19 +26,27 @@ relay. ## Enrol -On the relay, issue a host token (`pirc-relay add-host --label <name>`). In pi: ``` -/pirc enrol wss://<relay-address>:<port> <token> +/pirc enrol wss://<relay-address>:<port> ``` +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 <key>` 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 <name>`) and give it to the command: +`/pirc enrol wss://<relay-address>:<port> <token>`. + `/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. |
