Some client may send message parts with PART command

[goircd.git] / README

diff --git a/README b/README
index 03f31d88485e3ad1b1af0c04d05951c3c0731459..144d9382e230c7fe06025f86cf007de28b51c2fb 100644 (file)
--- a/README
+++ b/README
@@ -1,20 +1,16 @@
      goircd -- minimalistic simple Internet Relay Chat (IRC) server
      ==============================================================
 
      goircd -- minimalistic simple Internet Relay Chat (IRC) server
      ==============================================================
 

-SYNOPSIS
-
-goircd is very simple IRC server, written on Go.
-

 DESCRIPTION
 
 goircd is very simple IRC server, written on Go.
 It is heavily inspired by miniircd daemon written on Python.
 DESCRIPTION
 
 goircd is very simple IRC server, written on Go.
 It is heavily inspired by miniircd daemon written on Python.

+GoVPN is free software: see the file COPYING for copying conditions.

 It does not aim to replace full featured mass scalable IRC networks:
 
 * It can not connect to other servers. Just standalone installation
 * It has few basic IRC commands
 * There is no support for channel operators, modes, votes, invites
 It does not aim to replace full featured mass scalable IRC networks:
 
 * It can not connect to other servers. Just standalone installation
 * It has few basic IRC commands
 * There is no support for channel operators, modes, votes, invites

-  and so on

 * No ident lookups, reverse DNS queries
 
 But it has some convincing features:
 * No ident lookups, reverse DNS queries
 
 But it has some convincing features:


@@ -28,6 +24,7 @@ But it has some convincing features:
 * 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 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 and password

 
 Some remarks and recommendations related to it's simplicity:
 
 
 Some remarks and recommendations related to it's simplicity:
 


@@ -36,27 +33,63 @@ Some remarks and recommendations related to it's simplicity:
 
 SUPPORTED IRC COMMANDS
 
 
 SUPPORTED IRC COMMANDS
 

-* NICK/USER during registration workflow
+* PASS/NICK/USER during registration workflow

 * PING/PONGs
 * NOTICE/PRIVMSG
 * PING/PONGs
 * NOTICE/PRIVMSG

-* MOTD, LUSERS, WHO, WHOIS, QUIT
+* AWAY, MOTD, LUSERS, WHO, WHOIS, VERSION, QUIT

 * LIST, JOIN, TOPIC, +k/-k channel MODE
 
 USAGE
 
 Just execute goircd daemon. It has following optional arguments:
 
 * LIST, JOIN, TOPIC, +k/-k channel MODE
 
 USAGE
 
 Just execute goircd daemon. It has following optional arguments:
 

-* -hostname: hostname to show for client's connections
-* -bind: address to bind to (:6667 be default)
-* -motd: absolute path to MOTD file. It is reread every time MOTD is
-         requested
-* -logdir: directory where all channels messages will be saved. If
-           omitted, then no logs will be kept
-* -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
-* -verbose: increase log messages verbosity
+   -hostname: hostname to show for client's connections
+       -bind: address to bind to (:6667 by default)
+       -motd: absolute path to MOTD file. It is reread every time
+              MOTD is requested
+     -logdir: directory where all channels messages will be saved. If
+              omitted, then no logs will be kept
+   -statedir: directory where all channels states will be saved and
+              loaded during startup. If omitted, then states will be
+              lost after daemon termination
+   -tlsbind : enable TLS, specify address to listen on and path
+    -tlspem   to PEM file with certificate and private key
+  -passwords: enable client authentication and specify path to
+              passwords file
+          -v: increase verbosity
+
+TLS
+
+If you specify -bind and -tlsbind simultaneously, then you will have
+both raw and encrypted listening sockets. You can use -bind "" to
+disable raw socket.
+
+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.
+
+LOG FILES
+
+Log files are not opened all the time, but only during each message
+saving. That is why you can safely rename them for rotation purposes.
+
+STATE FILES
+
+Each state file has the name equals to room's one. It contains two plain
+text lines: room's topic and room's authentication key (empty if none
+specified). For example:
+
+    % cat states/meinroom
+    This is meinroom's topic
+    secretkey

 
 LICENCE
 
 
 LICENCE