X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=README;h=cc1a576edc67c1db9f8e0f3376c709ce0c093602;hb=563ff8742c38012f8ec85a809bef805dd5b97d3a;hp=9b4d8cf1d8d193e947824f68abf88d52e6be3b49;hpb=8702ace766119effc2c2ec4afa284bec6f24c4da;p=goircd.git diff --git a/README b/README index 9b4d8cf..cc1a576 100644 --- a/README +++ b/README @@ -1,10 +1,6 @@ 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. @@ -14,7 +10,6 @@ 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: @@ -28,7 +23,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: @@ -47,20 +42,20 @@ 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 -* -tlsbind/-pem: enable TLS, specify address to listen on and path - to PEM file with certificate and private key -* -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 @@ -75,7 +70,7 @@ 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.