DESCRIPTION
goircd is very simple IRC server, written on Go.
-It is heavily inspired by miniircd daemon written on Python.
+It was heavily inspired by miniircd daemon written on Python.
+goircd 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
-* No ident lookups, reverse DNS queries
+* No ident lookups
But it has some convincing features:
* PASS/NICK/USER during registration workflow
* PING/PONGs
-* NOTICE/PRIVMSG
+* NOTICE/PRIVMSG, ISON
* AWAY, MOTD, LUSERS, WHO, WHOIS, VERSION, QUIT
* LIST, JOIN, TOPIC, +k/-k channel MODE
-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
+ -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
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
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-any later version.
+the Free Software Foundation, version 3 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of