0
|
1 --- |
|
2 title: "Auth plugin" |
|
3 header: "Auth plugin" |
|
4 --- |
|
5 |
|
6 The plugin **auth** provides generic authentication to the most popular services. |
|
7 |
|
8 For the moment, **auth** supports the following backends: |
|
9 |
|
10 - **nickserv**: the NickServ service, `/msg NickServ identify user pass` |
|
11 - **quakenet**: the quakenet.org service, `/msg Q@CServe.quakenet.org AUTH user pass` |
|
12 |
|
13 ## Installation |
|
14 |
|
15 The plugin **auth** is distributed with irccd. To enable it add the following to your `plugins` section: |
|
16 |
|
17 ````ini |
|
18 [plugins] |
|
19 auth = "" |
|
20 ```` |
|
21 |
|
22 ## Usage |
|
23 |
|
24 You must configure the file to enable authentication. |
|
25 |
|
26 ## Configuration |
|
27 |
|
28 In your **irccd.conf** file, add the `[plugin.auth]` section and fill with the following parameters: |
|
29 |
|
30 - **server.type**: (string), must be **nickserv** or **quakenet**, |
|
31 - **server.password**: (string), the password, |
|
32 - **server.username**: (string), the username to use. Required for **quakenet**, optional for **nickserv**. |
|
33 |
|
34 You must replace **server** with one defined in a `[server]` section. |
|
35 |
|
36 Example: |
|
37 |
|
38 ````ini |
|
39 [plugin.auth] |
|
40 freenode.type = "nickserv" |
|
41 freenode.password = "mysecretpassword" |
|
42 freenode.username = "jeanfrancois" |
|
43 |
|
44 wanadoo.type = "nickserv" |
|
45 wanadoo.password = "wanadoo is dead" |
|
46 ```` |