Mercurial > irccd
annotate plugins/auth/auth.md @ 598:a3eeb5e9c482
Common: get rid of sys::set_privileges
While here, fix invalid uid checkup in irccd::load, and throw errors from system
function instead of printing errors directly.
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 06 Dec 2017 14:12:57 +0100 |
parents | c143682678b9 |
children | ebe561276c33 |
rev | line source |
---|---|
0 | 1 --- |
2 title: "Auth plugin" | |
3 header: "Auth plugin" | |
275
c143682678b9
CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents:
29
diff
changeset
|
4 guide: yes |
0 | 5 --- |
6 | |
7 The plugin **auth** provides generic authentication to the most popular services. | |
8 | |
9 For the moment, **auth** supports the following backends: | |
10 | |
11 - **nickserv**: the NickServ service, `/msg NickServ identify user pass` | |
12 - **quakenet**: the quakenet.org service, `/msg Q@CServe.quakenet.org AUTH user pass` | |
13 | |
14 ## Installation | |
15 | |
16 The plugin **auth** is distributed with irccd. To enable it add the following to your `plugins` section: | |
17 | |
18 ````ini | |
19 [plugins] | |
20 auth = "" | |
21 ```` | |
22 | |
23 ## Usage | |
24 | |
25 You must configure the file to enable authentication. | |
26 | |
27 ## Configuration | |
28 | |
29 In your **irccd.conf** file, add the `[plugin.auth]` section and fill with the following parameters: | |
30 | |
31 - **server.type**: (string), must be **nickserv** or **quakenet**, | |
32 - **server.password**: (string), the password, | |
33 - **server.username**: (string), the username to use. Required for **quakenet**, optional for **nickserv**. | |
34 | |
35 You must replace **server** with one defined in a `[server]` section. | |
36 | |
37 Example: | |
38 | |
29
3bf70400aa0b
Plugin auth: improve readability
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
39 <div class="panel panel-info"> |
3bf70400aa0b
Plugin auth: improve readability
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
40 <div class="panel-heading">~/.config/irccd/irccd.conf</div> |
3bf70400aa0b
Plugin auth: improve readability
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
41 <div class="panel-body"> |
0 | 42 ````ini |
43 [plugin.auth] | |
44 freenode.type = "nickserv" | |
45 freenode.password = "mysecretpassword" | |
46 freenode.username = "jeanfrancois" | |
47 | |
48 wanadoo.type = "nickserv" | |
49 wanadoo.password = "wanadoo is dead" | |
50 ```` | |
29
3bf70400aa0b
Plugin auth: improve readability
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
51 </div> |
3bf70400aa0b
Plugin auth: improve readability
David Demelier <markand@malikania.fr>
parents:
0
diff
changeset
|
52 </div> |