X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=README;h=65cfb613aece19dbfd93b376c626d7d21408cd11;hb=964a1bf9dbe211e21cc093001caa8962d513d513;hp=852e4557c7d88877b3ebf87ab2357d5a3b78f97d;hpb=a939b027fdb6ce1d0822e76ec50814678ff0050a;p=goircd.git diff --git a/README b/README index 852e455..65cfb61 100644 --- a/README +++ b/README @@ -1,21 +1,17 @@ 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. +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 - and so on -* No ident lookups, reverse DNS queries +* No ident lookups But it has some convincing features: @@ -28,7 +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 ability to authenticate users by nickname↔password +* Optional ability to authenticate users by nickname and password Some remarks and recommendations related to it's simplicity: @@ -39,27 +35,34 @@ SUPPORTED IRC COMMANDS * PASS/NICK/USER during registration workflow * PING/PONGs -* NOTICE/PRIVMSG -* MOTD, LUSERS, WHO, WHOIS, QUIT +* NOTICE/PRIVMSG, ISON +* AWAY, MOTD, LUSERS, WHO, WHOIS, VERSION, QUIT * 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 -* -passwords: enable client authentication and specify path to + -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 -* -verbose: increase log messages verbosity + -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 @@ -68,17 +71,28 @@ file and using the -passwords argument. Format of passwords file is: login1:password1\n login2:password2\n - … + ... + +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: -You can force rereading of passwords file without server interruption by -sending HUP signal to him. + % 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