X-Git-Url: http://www.git.cypherpunks.ru/?p=goircd.git;a=blobdiff_plain;f=README;h=f3a0ec039a017558de08430c0cd324f7e4d8eb30;hp=cc1a576edc67c1db9f8e0f3376c709ce0c093602;hb=7770e09e68f8dd0991ecd5a32383a89ac3e50857;hpb=563ff8742c38012f8ec85a809bef805dd5b97d3a diff --git a/README b/README index cc1a576..f3a0ec0 100644 --- a/README +++ b/README @@ -4,13 +4,14 @@ 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. +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 -* No ident lookups, reverse DNS queries +* No ident lookups But it has some convincing features: @@ -34,7 +35,7 @@ SUPPORTED IRC COMMANDS * 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 @@ -51,8 +52,8 @@ 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 - -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 @@ -72,8 +73,20 @@ file and using the -passwords argument. Format of passwords file is: 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