Mercurial > irccd
annotate doc/examples/irccd.conf.sample @ 911:32b0397f0992
misc: merge from stable-3
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 06 Oct 2019 09:21:06 +0200 |
parents | f0d6bc79aa32 cbb6d7804c02 |
children |
rev | line source |
---|---|
0 | 1 # |
2 # irccd.conf -- config file for irccd | |
3 # | |
4 | |
5 # Section plugins: | |
207
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
6 # Load plugins by name or by paths. |
0 | 7 # |
8 # [plugins] | |
465
b5478ee3d37a
Irccd: fix identity.ctcp-version option, closes #690
David Demelier <markand@malikania.fr>
parents:
269
diff
changeset
|
9 # abc = "" # This will search for abc |
207
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
10 # ask = /tmp/ask.js # This use /tmp/ask.js to load the plugin |
884
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
11 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
12 # Specific options for plugins are stored in a dedicated section: |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
13 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
14 # [plugin.hangman] |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
15 # collaborative = false |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
16 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
17 # See corresponding manual pages for plugins. |
0 | 18 |
19 # Section transport: | |
884
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
20 # You can use transport to wait for any input you want. UNIX and internet |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
21 # sockets are supported. UNIX are used for file based sockets while internet |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
22 # bind to standard address plus a specific port. |
0 | 23 # |
905
cbb6d7804c02
doc: add password examples, closes #2407
David Demelier <markand@malikania.fr>
parents:
885
diff
changeset
|
24 # Common options: |
cbb6d7804c02
doc: add password examples, closes #2407
David Demelier <markand@malikania.fr>
parents:
885
diff
changeset
|
25 # |
cbb6d7804c02
doc: add password examples, closes #2407
David Demelier <markand@malikania.fr>
parents:
885
diff
changeset
|
26 # [transport] |
cbb6d7804c02
doc: add password examples, closes #2407
David Demelier <markand@malikania.fr>
parents:
885
diff
changeset
|
27 # password = "SuperPassword" # (string) a password (Optional, default: empty), |
cbb6d7804c02
doc: add password examples, closes #2407
David Demelier <markand@malikania.fr>
parents:
885
diff
changeset
|
28 # |
0 | 29 # For internet sockets: |
30 # | |
31 # [transport] | |
32 # type = "ip" | |
207
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
33 # port = "1234" # (int) port number, |
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
34 # address = "*" # (string) address to bind or "*" for any (Optional, default: *), |
884
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
35 # ipv6 = true # (bool) enable IPv6 (Optional, default: true), |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
36 # ipv4 = true # (bool )enable IPv4 (Optional, default: true). |
0 | 37 # |
884
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
38 # For UNIX sockets: |
0 | 39 # |
40 # [transport] | |
41 # type = "unix" | |
207
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
42 # path = "/tmp/irccd.sock" # (string) the file path to the socket. |
0 | 43 |
44 [transport] | |
45 type = "ip" | |
46 address = "*" | |
47 port = "5980" | |
48 | |
49 # Section server: | |
884
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
50 # List of server you want to connect to. A server is registered with a |
207
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
51 # unique id that is needed for irccdctl(1). |
0 | 52 # |
53 # [server] | |
207
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
54 # name = "id" # (id) the unique id, |
884
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
55 # hostname = "chat.foo.com" # (string) the server address, |
207
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
56 # port = "4321" # (int) the server port (Optional, default: 6667), |
779
317c66a131be
Irccd: merge [identity] with [server], closes #905 @2h
David Demelier <markand@malikania.fr>
parents:
733
diff
changeset
|
57 # nickname = "foo" # (string) the nickname (Optional, default: irccd), |
317c66a131be
Irccd: merge [identity] with [server], closes #905 @2h
David Demelier <markand@malikania.fr>
parents:
733
diff
changeset
|
58 # username = "bar" # (string) the realname (Optional, default: IRC Client daemon), |
317c66a131be
Irccd: merge [identity] with [server], closes #905 @2h
David Demelier <markand@malikania.fr>
parents:
733
diff
changeset
|
59 # realname = "Jean" # (string) the username name (Optional, default: irccd), |
317c66a131be
Irccd: merge [identity] with [server], closes #905 @2h
David Demelier <markand@malikania.fr>
parents:
733
diff
changeset
|
60 # ctcp-version = "irccd" # (string) what version to respond to CTCP VERSION (Optional, default: IRC Client Daemon), |
207
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
61 # password = "secret" # (string) an optional password (Optional, default: none), |
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
62 # auto-rejoin = false # (bool) auto rejoin a channel after being kicked (Optional, default: false), |
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
63 # join-invite = false # (bool) join channels upon invitation (Optional, default: false), |
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
64 # channels = "" # (list) list of channels to auto join, (Optional, default: empty), |
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
65 # command-char = "!" # (string) the prefix for invoking special commands (Optional, default: !), |
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
66 # ssl = false # (bool) enable or disable SSL (Optional, default: false), |
733
bd12709b1975
Irccd: rework server to be simpler
David Demelier <markand@malikania.fr>
parents:
708
diff
changeset
|
67 # auto-reconnect = true # (bool) enable reconnection after failure (Optional, default: true), |
885
cb7532847b08
irccd: fix invalid template, closes #2250
David Demelier <markand@malikania.fr>
parents:
884
diff
changeset
|
68 # auto-reconnect-delay = 5 # (int) number of seconds to wait before retrying (Optional, default: 30). |
0 | 69 |
70 [server] | |
71 name = "localhost" | |
884
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
72 hostname = "localhost" |
0 | 73 port = 6667 |
74 | |
75 # Section rule: | |
207
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
76 # Add one or more rules to filter IRC events. |
0 | 77 # |
207
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
78 # servers = "" # (list) a list of servers that will match the rule (Optional, default: empty), |
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
79 # channels = "" # (list) a list of channel (Optional, default: empty), |
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
80 # plugins = "" # (list) which plugins (Optional, default: empty), |
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
81 # events = "" # (list) which events (e.g onCommand, onMessage, ...) (Optional, default: empty), |
884
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
82 # origins = "" # (list) nicknames to match (Optional, default: empty) |
207
6635b9187d71
Irccd: switch to 4 spaces indent, #518
David Demelier <markand@malikania.fr>
parents:
36
diff
changeset
|
83 # action = "" # (string) set to **accept** or **drop**. |
0 | 84 # |
85 # Block plugin hangman everywhere. | |
86 # | |
87 # [rule] | |
88 # plugins = "hangman" | |
89 # action = drop | |
90 # | |
91 # Allow it again on #games@localhost | |
92 # | |
93 # [rule] | |
94 # servers = "localhost" | |
95 # channels = "#games" | |
96 # plugins = "hangman" | |
97 # action = accept | |
884
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
98 |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
99 # Section paths: |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
100 # This section stores default paths mostly for plugins. For each plugin the |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
101 # string "plugin/NAME" is appended. |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
102 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
103 # This section is optional and default values are used instead. |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
104 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
105 # [paths] |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
106 # cache = "/var/cache" # (string) data files written by the plugin. |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
107 # data = "/share/ # (string) data files provided by the user. |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
108 # config = "/etc/" # (string) additional configuration from the user. |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
109 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
110 # To override paths per plugins: |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
111 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
112 # [paths.hangman] |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
113 # cache = "/var" |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
114 |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
115 # Section logs: |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
116 # Define where to store logs. Syslog, file and console are supported. |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
117 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
118 # This section is optional, by default console is used. |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
119 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
120 # Common options: |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
121 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
122 # [logs] |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
123 # verbose = false # (bool) be verbose. |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
124 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
125 # For syslog: |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
126 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
127 # [logs] |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
128 # type = "syslog" |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
129 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
130 # For files: |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
131 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
132 # [logs] |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
133 # path-logs # (string) Path to the normal messages, |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
134 # path-errors # (string) Path to the error messages. |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
135 |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
136 # Section templates: |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
137 # This section defines how irccd should format messages for logs and plugins. |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
138 # The syntax is described in details in the irccd-templates(7) manual page. |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
139 # Also, check corresponding information in plugin manual pages for more |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
140 # details. |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
141 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
142 # This section is optional, default values are used instead. |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
143 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
144 # To format general messages: |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
145 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
146 # [templates] |
885
cb7532847b08
irccd: fix invalid template, closes #2250
David Demelier <markand@malikania.fr>
parents:
884
diff
changeset
|
147 # debug = "DD #{message} # (string) debug messages. |
cb7532847b08
irccd: fix invalid template, closes #2250
David Demelier <markand@malikania.fr>
parents:
884
diff
changeset
|
148 # info = "II #{message} # (string) information messages. |
cb7532847b08
irccd: fix invalid template, closes #2250
David Demelier <markand@malikania.fr>
parents:
884
diff
changeset
|
149 # warning = "WW #{message} # (string) warning messages. |
884
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
150 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
151 # To format specific plugins: |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
152 # |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
153 # [templates.hangman] |
54496ac51649
doc: fix default configuration files, closes #2249
David Demelier <markand@malikania.fr>
parents:
779
diff
changeset
|
154 # win = "you win!" |
895
f0d6bc79aa32
irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents:
885
diff
changeset
|
155 |
f0d6bc79aa32
irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents:
885
diff
changeset
|
156 # Section hooks: |
f0d6bc79aa32
irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents:
885
diff
changeset
|
157 # This sections lets you define hooks that are executed each time an IRC |
f0d6bc79aa32
irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents:
885
diff
changeset
|
158 # event arrives. |
f0d6bc79aa32
irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents:
885
diff
changeset
|
159 # |
f0d6bc79aa32
irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents:
885
diff
changeset
|
160 # [hooks] |
f0d6bc79aa32
irccd: implement hooks, closes #2342 @2h
David Demelier <markand@malikania.fr>
parents:
885
diff
changeset
|
161 # mail = "/path/to/mail.py" |