Mercurial > irccd
annotate doc/examples/irccd.conf @ 131:77c90336ba56
Irccd: initial Plugin split, #501
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Thu, 12 May 2016 15:06:11 +0200 |
| parents | f0e00b72fea9 |
| children | 6635b9187d71 |
| rev | line source |
|---|---|
| 0 | 1 # |
| 2 # irccd.conf -- config file for irccd | |
| 3 # | |
| 4 | |
| 5 # Section general: | |
| 6 # This section describe global options used by irccd. | |
| 7 # | |
| 8 # [general] | |
| 9 # uid = "nobody" # (string or number) the user id to use (Optional, default: none), | |
| 10 # gid = "nobody" # (string or number) the group id to use (Optional, default: none), | |
| 11 # foreground = false # (bool) set to true to not daemonize (Optional, default: false), | |
| 12 # pidfile = "/tmp/irccd.pid" # (string) path to a file where to store the irccd pid (Optional, default: none). | |
| 13 | |
| 14 [general] | |
| 15 foreground = true | |
| 16 | |
| 17 # Section plugins: | |
| 18 # Load plugins by name or by paths. | |
| 19 # | |
| 20 # [plugins] | |
| 21 # abc = # This will search for abc | |
|
36
f0e00b72fea9
Misc: remove old references to Lua
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
22 # ask = /tmp/ask.js # This use /tmp/ask.js to load the plugin |
| 0 | 23 |
| 24 [plugins] | |
| 25 history = "" | |
| 26 ask = "" | |
| 27 | |
| 28 # Section identities: | |
| 29 # This describe identities, you can add any number you want they are used with servers so you can reuse an | |
| 30 # identity for one or more servers if you want. | |
| 31 # | |
| 32 # [identity] | |
| 33 # name = "id" # (id) the identity unique id, | |
| 34 # nickname = "foo" # (string) the nickname (Optional, default: irccd), | |
| 35 # username = "bar" # (string) the realname (Optional, default: IRC Client daemon), | |
| 36 # realname = "Jean" # (string) the username name (Optional, default: irccd), | |
| 37 # ctcp-version = "irccd" # (string) what version to respond to CTCP VERSION (Optional, default: IRC Client Daemon), | |
| 38 # ctcp-autoreply = true # (bool) enable auto CTCP VERSION reply, (Optional, default: true). | |
| 39 | |
| 40 [identity] | |
| 41 name = "default" | |
| 42 nickname = "superbot" | |
| 43 username = "superbot" | |
| 44 realname = "Superbot Killer" | |
| 45 | |
| 46 # Section transport: | |
| 47 # You can use transport to wait for any input you want. Unix and internet sockets are supported. Unix are used | |
| 48 # for file based socket while internet bind to standard address plus a specific port. | |
| 49 # | |
| 50 # For internet sockets: | |
| 51 # | |
| 52 # [transport] | |
| 53 # type = "ip" | |
| 54 # port = "1234" # (int) port number, | |
| 55 # address = "*" # (string) address to bind or "*" for any (Optional, default: *), | |
| 56 # family = ( "ipv4", "ipv6" ) # (list) ipv6, ipv4. Both are accepted (Optional, default: ipv4). | |
| 57 # | |
| 58 # For unix sockets: | |
| 59 # | |
| 60 # [transport] | |
| 61 # type = "unix" | |
| 62 # path = "/tmp/irccd.sock" # (string) the file path to the socket. | |
| 63 | |
| 64 [transport] | |
| 65 type = "ip" | |
| 66 address = "*" | |
| 67 port = "5980" | |
| 68 family = "ipv4 ipv6" | |
| 69 | |
| 70 # Section server: | |
| 71 # List of server you want to connect to. A server may use an identity to | |
| 72 # set the username, nickname and so on. A server is registered with a | |
| 73 # unique id that is needed for irccdctl(1). | |
| 74 # | |
| 75 # [server] | |
| 76 # name = "id" # (id) the unique id, | |
| 77 # host = "chat.foo.com" # (string) the server address, | |
| 78 # port = "4321" # (int) the server port (Optional, default: 6667), | |
| 79 # identity = "default" # (string) an identity to use (Optional, default: irccd's default), | |
| 80 # password = "secret" # (string) an optional password (Optional, default: none), | |
| 81 # auto-rejoin = false # (bool) auto rejoin a channel after being kicked (Optional, default: false), | |
| 82 # join-invite = false # (bool) join channels upon invitation (Optional, default: false), | |
| 83 # channels = "" # (list) list of channels to auto join, (Optional, default: empty), | |
| 84 # command-char = "!" # (string) the prefix for invoking special commands (Optional, default: !), | |
| 85 # ssl = false # (bool) enable or disable SSL (Optional, default: false), | |
| 86 # ssl-verify = false # (bool) verify the SSL certificates (Optional, default: true), | |
| 87 # reconnect = true # (bool) enable reconnection after failure (Optional, default: true), | |
| 88 # reconnect-tries = 0 # (int) number of tries before giving up. A value of 0 means indefinitely (Optional, default: 0), | |
| 89 # reconnect-timeout = 5 # (int) number of seconds to wait before retrying (Optional, default: 30). | |
| 90 | |
| 91 [server] | |
| 92 identity = "default" | |
| 93 name = "localhost" | |
| 94 host = "localhost" | |
| 95 port = 6667 | |
| 96 reconnect-timeout = 60 | |
| 97 reconnect-tries = 20 | |
| 98 | |
| 99 # Section rule: | |
| 100 # Add one or more rules to filter IRC events. | |
| 101 # | |
| 102 # servers = "" # (list) a list of servers that will match the rule (Optional, default: empty), | |
| 103 # channels = "" # (list) a list of channel (Optional, default: empty), | |
| 104 # plugins = "" # (list) which plugins (Optional, default: empty), | |
| 105 # events = "" # (list) which events (e.g onCommand, onMessage, ...) (Optional, default: empty), | |
| 106 # action = "" # (string) set to **accept** or **drop**. | |
| 107 # | |
| 108 # Block plugin hangman everywhere. | |
| 109 # | |
| 110 # [rule] | |
| 111 # plugins = "hangman" | |
| 112 # action = drop | |
| 113 # | |
| 114 # Allow it again on #games@localhost | |
| 115 # | |
| 116 # [rule] | |
| 117 # servers = "localhost" | |
| 118 # channels = "#games" | |
| 119 # plugins = "hangman" | |
| 120 # action = accept |