From 894d5998a9be987db773aabae21b83014aedabe7 Mon Sep 17 00:00:00 2001 From: tv Date: Tue, 6 Sep 2011 15:12:19 +0200 Subject: //Reaktor/IRC: move doc to README.md --- Reaktor/IRC/README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 Reaktor/IRC/README.md (limited to 'Reaktor/IRC/README.md') diff --git a/Reaktor/IRC/README.md b/Reaktor/IRC/README.md new file mode 100644 index 00000000..f831785c --- /dev/null +++ b/Reaktor/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 From 86a44d6eb61a3a218c1f81bf3500c9c14e5521d9 Mon Sep 17 00:00:00 2001 From: tv Date: Tue, 6 Sep 2011 15:14:12 +0200 Subject: //Reaktor/IRC: detypo README --- Reaktor/IRC/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'Reaktor/IRC/README.md') diff --git a/Reaktor/IRC/README.md b/Reaktor/IRC/README.md index f831785c..b51d8743 100644 --- a/Reaktor/IRC/README.md +++ b/Reaktor/IRC/README.md @@ -1,4 +1,4 @@ -# `//Reaktor/IRC` +# *//Reaktor/IRC* This component implements a remote shell daemon that exposes the executable files (which may be symlinks) below @@ -25,14 +25,14 @@ without dropping privileges. The following environment variables are processed by `//Reaktor/IRC`: -### `nick` +### *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` +### *host* and *port* Connect to a specific IRC server. @@ -40,7 +40,7 @@ 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` +### *target* Join a specific channel. -- cgit v1.2.3 From 0fcc4bbc442335af17433c347841ce6cb6234bd1 Mon Sep 17 00:00:00 2001 From: tv Date: Tue, 6 Sep 2011 15:17:53 +0200 Subject: //Reaktor/IRC: detypo README, again --- Reaktor/IRC/README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) (limited to 'Reaktor/IRC/README.md') diff --git a/Reaktor/IRC/README.md b/Reaktor/IRC/README.md index b51d8743..63a0ebd2 100644 --- a/Reaktor/IRC/README.md +++ b/Reaktor/IRC/README.md @@ -1,4 +1,4 @@ -# *//Reaktor/IRC* +# //Reaktor/IRC This component implements a remote shell daemon that exposes the executable files (which may be symlinks) below @@ -6,9 +6,8 @@ executable files (which may be symlinks) below ## 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. +Access to the IRC server implies full access to all the exposed executable +files. The daemon is executing the commands without dropping privileges. ## Quickstart @@ -25,14 +24,14 @@ without dropping privileges. The following environment variables are processed by `//Reaktor/IRC`: -### *nick* +### 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* +### host and port Connect to a specific IRC server. @@ -40,7 +39,7 @@ 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* +### target Join a specific channel. -- cgit v1.2.3