From 69ce45203a5cbe2f8ebdaf7cc4826c84ed2eae5c Mon Sep 17 00:00:00 2001
From: tv <tv@xso>
Date: Tue, 6 Sep 2011 15:12:19 +0200
Subject: //Reaktor/IRC: move doc to README.md

---
 IRC/README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 IRC/README.md

(limited to 'IRC/README.md')

diff --git a/IRC/README.md b/IRC/README.md
new file mode 100644
index 0000000..f831785
--- /dev/null
+++ b/IRC/README.md
@@ -0,0 +1,50 @@
+# `//Reaktor/IRC`
+
+This component implements a remote shell daemon that exposes the
+executable files (which may be symlinks) below
+`//Reaktor/public_commands/` through IRC.
+
+## Security
+
+Anyone who has access the the IRC server in question has full access to
+all the exposed executable files.  The daemon is executing the commands
+without dropping privileges.
+
+## Quickstart
+
+    #? /bin/sh
+    set -euf
+
+    export nick="$LOGNAME|$HOSTNAME"
+    export host=irc.freenode.org
+    export target='#tincspasm'
+
+    exec Reaktor/IRC/index
+
+## Environment variables
+
+The following environment variables are processed by `//Reaktor/IRC`:
+
+### `nick`
+
+Use a specific nickname.
+
+Optional if the node running `//Reaktor/IRC` is part of Retiolum, in
+which case it defaults to `Name` in `/etc/tinc/retiolum/tinc.conf`.
+
+### `host` and `port`
+
+Connect to a specific IRC server.
+
+Optional if the node running `//Reaktor/IRC` is part of Retiolum, in
+which case it defaults to `supernode` and `6667` (well, it always
+defaults to these two, but they only make science in Retiolum^_^).
+
+### `target`
+
+Join a specific channel.
+
+As always, this does the right thing for properly configured hosts: it
+uses the default `#retiolum`, which is the only really relevant
+channel.^_^
+
-- 
cgit v1.2.3