Mercurial > irccd

annotate plugins/auth/auth.md @ 785:7145a3df4cb7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
misc: rename host to hostname, closes #941 @2h
author David Demelier <markand@malikania.fr>
date Wed, 07 Nov 2018 12:55:00 +0100
parents c143682678b9
children ebe561276c33
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"
275
c143682678b9 CMake: improve documentation related to plugins
David Demelier <markand@malikania.fr>
parents: 29
diff changeset
4 guide: yes
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 The plugin **auth** provides generic authentication to the most popular services.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 For the moment, **auth** supports the following backends:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 - **nickserv**: the NickServ service, `/msg NickServ identify user pass`
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 - **quakenet**: the quakenet.org service, `/msg Q@CServe.quakenet.org AUTH user pass`
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 ## Installation
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 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
17
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 [plugins]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 auth = ""
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 ````
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 ## Usage
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 You must configure the file to enable authentication.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 ## Configuration
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 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
30
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 - **server.type**: (string), must be **nickserv** or **quakenet**,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 - **server.password**: (string), the password,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 - **server.username**: (string), the username to use. Required for **quakenet**, optional for **nickserv**.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 You must replace **server** with one defined in a `[server]` section.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 Example:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 ````ini
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 [plugin.auth]
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 freenode.type = "nickserv"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 freenode.password = "mysecretpassword"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 freenode.username = "jeanfrancois"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 wanadoo.type = "nickserv"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 wanadoo.password = "wanadoo is dead"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
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>