Mercurial > irccd

annotate plugins/auth/auth.md @ 126:49572a69c41d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Irccd: implement TransportService, #496
author David Demelier <markand@malikania.fr>
date Wed, 11 May 2016 13:00:40 +0200
parents 3bf70400aa0b
children c143682678b9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 title: "Auth plugin"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 header: "Auth plugin"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 The plugin **auth** provides generic authentication to the most popular services.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 For the moment, **auth** supports the following backends:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 - **nickserv**: the NickServ service, `/msg NickServ identify user pass`
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 - **quakenet**: the quakenet.org service, `/msg Q@CServe.quakenet.org AUTH user pass`
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 ## Installation
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 The plugin **auth** is distributed with irccd. To enable it add the following to your `plugins` section:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 [plugins]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 auth = ""
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 ## Usage
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 You must configure the file to enable authentication.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 ## Configuration
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 In your **irccd.conf** file, add the `[plugin.auth]` section and fill with the following parameters:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 - **server.type**: (string), must be **nickserv** or **quakenet**,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 - **server.password**: (string), the password,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 - **server.username**: (string), the username to use. Required for **quakenet**, optional for **nickserv**.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 You must replace **server** with one defined in a `[server]` section.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 Example:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
29
3bf70400aa0b Plugin auth: improve readability
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
38 <div class="panel panel-info">
3bf70400aa0b Plugin auth: improve readability
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
39 <div class="panel-heading">~/.config/irccd/irccd.conf</div>
3bf70400aa0b Plugin auth: improve readability
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
40 <div class="panel-body">
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 [plugin.auth]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 freenode.type = "nickserv"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 freenode.password = "mysecretpassword"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 freenode.username = "jeanfrancois"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 wanadoo.type = "nickserv"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 wanadoo.password = "wanadoo is dead"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 ````
29
3bf70400aa0b Plugin auth: improve readability
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
50 </div>
3bf70400aa0b Plugin auth: improve readability
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
51 </div>