← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/auth_pam/docs/index.rst

  • Committer: Mark Atwood
  • Date: 2011-09-13 19:54:55 UTC
  • mfrom: (2397.1.3 plugin-docs)
  • Revision ID: me@mark.atwood.name-20110913195455-3bk3locm85m4jimp
merge lp:~daniel-nichter/drizzle/plugin-docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/auth_pam/docs/index.rst
 
1
PAM Authenication
 
2
=================
 
3
 
 
4
:program:`auth_pam` is an authentication plugin that authentication connections
 
5
using :abbr:`PAM (Pluggable Authentication Module)`.
 
6
PAM is effectively your current Linux based user security. [1]_ 
 
7
 
 
8
.. note:: Unload the :doc:`/plugins/auth_all/index` plugin before using this plugin.
 
9
.. seealso:: :doc:`/administration/authentication` 
 
10
 
 
11
.. _auth_pam_loading:
 
12
 
 
13
Loading
 
14
-------
 
15
 
 
16
To load this plugin, start :program:`drizzled` with::
 
17
 
 
18
   --plugin-add=auth_pam
 
19
 
 
20
Loading the plugin may not enable or configure it.  See the plugin's
 
21
:ref:`auth_pam_configuration` and :ref:`auth_pam_variables`.
 
22
 
 
23
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
24
 
 
25
.. _auth_pam_configuration:
 
26
 
 
27
Configuration
 
28
-------------
 
29
 
 
30
This plugin does not have any command line options.
 
31
 
 
32
.. _auth_pam_variables:
 
33
 
 
34
Variables
 
35
---------
 
36
 
 
37
This plugin does not register any variables.
 
38
 
 
39
.. _auth_pam_examples:
 
40
 
 
41
Examples
 
42
--------
 
43
 
 
44
Sorry, there are no examples for this plugin.
 
45
 
 
46
.. _auth_pam_authors:
 
47
 
 
48
Authors
 
49
-------
 
50
 
 
51
Brian Aker
 
52
 
 
53
.. _auth_pam_version:
 
54
 
 
55
Version
 
56
-------
 
57
 
 
58
This documentation applies to **auth_pam 0.1**.
 
59
 
 
60
To see which version of the plugin a Drizzle server is running, execute:
 
61
 
 
62
.. code-block:: mysql
 
63
 
 
64
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='auth_pam'
 
65
 
 
66
Changelog
 
67
---------
 
68
 
 
69
v0.1
 
70
^^^^
 
71
* First release.
 
72
 
 
73
-------------------------------------------------------------------------------
 
74
 
 
75
.. rubric:: Footnotes
 
76
 
 
77
.. [1] `Understanding Drizzle user authentication options – Part 1 <http://ronaldbradford.com/blog/understanding-drizzle-authentication-options-part-1-2010-03-12/>`_
 
78