summaryrefslogtreecommitdiff
path: root/network/elemental-ircd/README
diff options
context:
space:
mode:
authorAndreas Guldstrand <andreas.guldstrand@gmail.com>2015-11-23 07:44:32 +0700
committerWilly Sudiarto Raharjo <willysr@slackbuilds.org>2015-11-28 07:25:59 +0700
commit9f17ff1d7ee3d9ab7e43caad551905b06a0d005c (patch)
tree9924bfd4d96a1d091eb8e7a955db8fb774d99ab1 /network/elemental-ircd/README
parenta9af23fa2eb1830507f1a615a7ee0c42a3ee5c3c (diff)
downloadslackbuilds-9f17ff1d7ee3d9ab7e43caad551905b06a0d005c.tar.gz
network/elemental-ircd: Added (high performance irc daemon).
Signed-off-by: Willy Sudiarto Raharjo <willysr@slackbuilds.org>
Diffstat (limited to 'network/elemental-ircd/README')
-rw-r--r--network/elemental-ircd/README36
1 files changed, 36 insertions, 0 deletions
diff --git a/network/elemental-ircd/README b/network/elemental-ircd/README
new file mode 100644
index 0000000000..2603265d13
--- /dev/null
+++ b/network/elemental-ircd/README
@@ -0,0 +1,36 @@
+Elemental-IRCd is a high performance, lightweight, and scalable IRC daemon. It
+is a fork of the now-defunct ShadowIRCD and seeks to continue in the direction
+ShadowIRCD was headed.
+
+An `/etc/rc.d/rc.elemental-ircd` script is supplied which supports
+start/stop/restart/reload, which you can call from your rc.local:
+
+ # /etc/rc.d/rc.local
+ # ==================
+ if [ -x /etc/rc.d/rc.elemental-ircd ]; then
+ /etc/rc.d/rc.elemental-ircd start
+ fi
+
+The `reload` parameter will make an already running ircd reload its
+configuration file.
+
+The elemental-ircd will refuse to run as root, so you need to create a user
+for it:
+ groupadd -g 315 elemental-ircd
+ useradd -u 315 -g 315 -d /var/lib/elemental-ircd elemental-ircd
+By default we name the user `elemental-ircd` with UID 315, and put it in the
+`elemental-ircd` group (GID 315). If you want to give it a different name, uid
+or gid, you can give
+ IRCD_UNAME=elemental-ircd
+ IRCD_UID=315
+ IRCD_GID=315
+different values when running the slackbuild script.
+
+Before starting the ircd, you'll need to create a configuration file for it.
+It should be named `/etc/elemental-ircd/ircd.conf`. In that directory there
+is already an `example.conf` and a `reference.conf`.
+
+Note: elemental-ircd comes with a binary called `/usr/bin/mkpasswd`, which is
+used to create passwords for o-lines, but it creates a conflict with
+`/usr/bin/mkpasswd` from expect, so the `mkpasswd` supplied by elemental-ircd
+is renamed to `ircd-mkpasswd` by the SlackBuild script.