X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=README;h=852e4557c7d88877b3ebf87ab2357d5a3b78f97d;hb=a939b027fdb6ce1d0822e76ec50814678ff0050a;hp=c69f8d23ac179934749d616e6264a89d779f41cf;hpb=6a0a2a0ce13e7fe6f3b9a7acb45c047199bab13e;p=goircd.git diff --git a/README b/README index c69f8d2..852e455 100644 --- a/README +++ b/README @@ -23,20 +23,21 @@ But it has some convincing features: * Single executable binary * No configuration file, just few command line arguments * IPv6 out-of-box support +* Ability to listen on TLS-capable ports * Optional channel logging to plain text files * Optional permanent channel's state saving in plain text files (so you can reload daemon and all channels topics and keys won't disappear) +* Optional ability to authenticate users by nickname↔password Some remarks and recommendations related to it's simplicity: * Use either nohup or similar tools to daemonize it -* Use either crywrap or similar tools for TLS-capable connections * Just plain logging on stderr, without syslog support SUPPORTED IRC COMMANDS -* NICK/USER during registration workflow +* PASS/NICK/USER during registration workflow * PING/PONGs * NOTICE/PRIVMSG * MOTD, LUSERS, WHO, WHOIS, QUIT @@ -55,6 +56,22 @@ Just execute goircd daemon. It has following optional arguments: * -statedir: directory where all channels states will be saved and loaded during startup. If omitted, then states will be lost after daemon termination +* -tls_key/-tls_cert: enable TLS and specify key and certificate file +* -passwords: enable client authentication and specify path to + passwords file +* -verbose: increase log messages verbosity + +AUTHENTICATION + +You can turn on optional client authentication by preparing passwords +file and using the -passwords argument. Format of passwords file is: + + login1:password1\n + login2:password2\n + … + +You can force rereading of passwords file without server interruption by +sending HUP signal to him. LICENCE