From: Egor <egor@patchysicp.xyz>
Date: Thu, 27 Mar 2025 05:39:37 +0000 (+0200)
Subject: README: update with latest improvements
X-Git-Url: https://git.patchysicp.xyz/?a=commitdiff_plain;h=6512339fe3519e31db118fac24eaadc15de10e4f;p=patchyircd.git

README: update with latest improvements
---

diff --git a/README.md b/README.md
index 8b13c38..a72e2c0 100644
--- a/README.md
+++ b/README.md
@@ -18,12 +18,23 @@ These have to go in IRCDDATADIR (`data` by default).
 For TLS you gonna need to place your certificate and private key in
 `cert.pem` and `key.pem` respectively.
 
-`ops.txt`, `users.txt` and `newusers.txt` contain hashed passwords. `ops.txt` is
-used for OPER command, `users.txt` is used for PASS command (which we use for
-our bespoke user account system). NEWACC command adds lines to `newusers.txt`.
-To verify a registration, simply copy lines from `newusers.txt` to `users.txt`.
-You can set password from command line like so `./setpass username file.txt`
-(the file must already exist).
+`ops.txt`, `users.txt`, `newusers.txt` and `webirc.txt` contain hashed passwords
+(`account:hash`). `ops.txt` is used for OPER command, `users.txt` is used for
+PASS command (which we use for our bespoke user account system). NEWACC command
+adds lines to `newusers.txt`.  To verify a registration, simply copy lines from
+`newusers.txt` to `users.txt`.  You can set password from command line like so
+`./setpass username file.txt` (the file must already exist).
+
+`webirc.txt` is used for authenticating WebSocket proxies and similar with the
+WEBIRC command.
+
+SASL authentication is also supported, including PLAIN (using same credentials
+as PASS), and EXTERNAL which uses `certfp.txt` (`account:fingerprint`). There's
+also irccloud lua module which authenticates using irccloud user ids in
+`irccloud.txt` (`account:userid`).
+
+By default accounts have ownership of the nick equal to the account name.
+Additional nicks can be added via `nicks.txt` (`account:nick`).
 
 `help.txt` file contains the text for the HELP command. You can use the provided
 `help.example.txt` file. Similarly, `motd.txt` contains the MOTD text.
@@ -35,6 +46,10 @@ the oper's nick will change accordingly. You can also fake the current unix time
 by prefixing the line with `$123` (`$0` sets the time back to real time). Faking
 nick and time is useful for JOIN and TOPIC commands. `chanlog.txt` records all
 channels changes in this format.
+(NOTE: this feature is deprecated. We only use it for bootstrapping lua:
+`LUA eval :dofile"lua/init.lua"`. Then in `lua/local.lua` we set up the
+channels. Also, be sure to PART any `--autojoin` channels if you want to give
+those a specific creation timestamp.)
 
 ## Command-line options
 Add TCP listeners with `--listenPlain ip port` and `--listenTls ip port`. If