← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/auth_file/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_file/docs/index.rst
 
1
File-based Authentication
 
2
=========================
 
3
 
 
4
.. warning:: :program:`auth_file` is a security risk!  Do not use this plugin with production servers!
 
5
 
 
6
:program:`auth_file` is an authentication plugin that authenticates connections
 
7
using a list of ``username:password`` entries in a plain text file.
 
8
 
 
9
.. note:: Unload the :doc:`/plugins/auth_all/index` plugin before using this plugin.
 
10
.. seealso:: :doc:`/administration/authentication` 
 
11
 
 
12
.. _auth_file_loading:
 
13
 
 
14
Loading
 
15
-------
 
16
 
 
17
To load this plugin, start :program:`drizzled` with::
 
18
 
 
19
   --plugin-add=auth_file
 
20
 
 
21
Loading the plugin may not enable or configure it.  See the plugin's
 
22
:ref:`auth_file_configuration` and :ref:`auth_file_variables`.
 
23
 
 
24
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
25
 
 
26
.. _auth_file_configuration:
 
27
 
 
28
Configuration
 
29
-------------
 
30
 
 
31
These command line options configure the plugin when :program:`drizzled`
 
32
is started.  See :doc:`/configuration` for more information about specifying
 
33
command line options.
 
34
 
 
35
.. program:: drizzled
 
36
 
 
37
.. option:: --auth-file.users ARG
 
38
 
 
39
   :Default: :file:`BASEDIR/etc/drizzle.users`
 
40
   :Variable: :ref:`auth_file_users <auth_file_users>`
 
41
 
 
42
   File to load for usernames and passwords.
 
43
 
 
44
.. _auth_file_variables:
 
45
 
 
46
Variables
 
47
---------
 
48
 
 
49
These variables show the running configuration of the plugin.
 
50
See `variables` for more information about querying and setting variables.
 
51
 
 
52
.. _auth_file_users:
 
53
 
 
54
* ``auth_file_users``
 
55
 
 
56
   :Scope: Global
 
57
   :Dynamic: No
 
58
   :Option: :option:`--auth-file.users`
 
59
 
 
60
   File to load for usernames and passwords.
 
61
 
 
62
.. _auth_file_examples:
 
63
 
 
64
Examples
 
65
--------
 
66
 
 
67
First, create a :file:`users` file with one ``user:pass`` entry per line, like::
 
68
 
 
69
   user1:password1
 
70
   user2:password2
 
71
 
 
72
Then start :program:`drizzled` like::
 
73
 
 
74
   sbin/drizzled --plugin-remove=auth_all \  
 
75
                 --plugin-add=auth_file   \
 
76
                 --auth-file.users=/path/to/my/users
 
77
 
 
78
Test that it works::
 
79
 
 
80
   $ drizzle
 
81
   ERROR 1045 (28000): Access denied for user 'daniel' (using password: NO)
 
82
 
 
83
   $ drizzle --user=user1
 
84
   ERROR 1045 (28000): Access denied for user 'user1' (using password: NO)
 
85
 
 
86
   $ drizzle --user=user1 --password=password1
 
87
   Welcome to the Drizzle client..  Commands end with ; or \g.
 
88
   ...
 
89
 
 
90
.. _auth_file_authors:
 
91
 
 
92
Authors
 
93
-------
 
94
 
 
95
Eric Day
 
96
 
 
97
.. _auth_file_version:
 
98
 
 
99
Version
 
100
-------
 
101
 
 
102
This documentation applies to **auth_file 0.1**.
 
103
 
 
104
To see which version of the plugin a Drizzle server is running, execute:
 
105
 
 
106
.. code-block:: mysql
 
107
 
 
108
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='auth_file'
 
109
 
 
110
Changelog
 
111
---------
 
112
 
 
113
v0.1
 
114
^^^^
 
115
* First release.
 
116