summaryrefslogtreecommitdiffstats
path: root/Reaktor/IRC/README.md
blob: 63a0ebd277ce3f5d71006fa160d59bfcdcbd6d2f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# //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

Access to the IRC server implies 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.^_^