← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

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

  • Committer: Daniel Nichter
  • Date: 2011-08-13 20:41:38 UTC
  • mto: This revision was merged to the branch mainline in revision 2413.
  • Revision ID: daniel@percona.com-20110813204138-stxa89ca1t7cg1uy
https://launchpad.net/bugs/793182
Skeleton documentation for all plugins, more complete docu for first half of plugins.
Clean up plugin.ini titles and descriptions.
Reformat and reorganize root index.
Change Administrative to Administration and remove empty files (logging, etc.)
Add, fix, and tag documentation for functions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin/auth_all/docs/index.rst
 
1
Allow All Authentication
 
2
========================
 
3
 
 
4
.. warning:: :program:`auth_all` is a security risk!  Do not use this plugin with production servers!
 
5
 
 
6
:program:`auth_all` is an authentication plugin that allows *all* connections
 
7
regardless of username or password, so it does not actually authenticate and
 
8
it does not provide any security.  This plugin is mostly used for testing.
 
9
 
 
10
.. seealso:: :doc:`/administration/authentication`
 
11
 
 
12
.. _auth_all_loading:
 
13
 
 
14
Loading
 
15
-------
 
16
 
 
17
This plugin is loaded by default, but it may need to be configured.  See
 
18
the plugin's :ref:`auth_all_configuration` and
 
19
:ref:`auth_all_variables`.
 
20
 
 
21
To stop the plugin from loading by default, start :program:`drizzled`
 
22
with::
 
23
 
 
24
   --plugin-remove=auth_all
 
25
 
 
26
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
27
 
 
28
.. _auth_all_configuration:
 
29
 
 
30
Configuration
 
31
-------------
 
32
 
 
33
These command line options configure the plugin when :program:`drizzled`
 
34
is started.  See :doc:`/configuration` for more information about specifying
 
35
command line options.
 
36
 
 
37
.. program:: drizzled
 
38
 
 
39
.. option:: --auth-all.allow_anonymous 
 
40
 
 
41
   :Default: false
 
42
   :Variable:
 
43
 
 
44
   Allow anonymous access.
 
45
 
 
46
.. _auth_all_variables:
 
47
 
 
48
Variables
 
49
---------
 
50
 
 
51
This plugin does not register any variables.
 
52
 
 
53
Authors
 
54
-------
 
55
 
 
56
Brian Aker
 
57
 
 
58
.. _auth_all_version:
 
59
 
 
60
Version
 
61
-------
 
62
 
 
63
This documentation applies to **auth_all 1.0**.
 
64
 
 
65
To see which version of the plugin a Drizzle server is running, execute:
 
66
 
 
67
.. code-block:: mysql
 
68
 
 
69
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='auth_all'
 
70
 
 
71
Changelog
 
72
---------
 
73
 
 
74
v1.0
 
75
^^^^
 
76
* First release.