← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to plugin/auth_http/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_http/docs/index.rst
 
1
HTTP Authentication
 
2
===================
 
3
 
 
4
:program:`auth_http` is an authentication plugin that authenticates connections
 
5
using web-based HTTP authentication through a URL.  A web server is required
 
6
to provide authentication.  For example, see Apache's documentation
 
7
for `Authentication, Authorization and Access Control <http://httpd.apache.org/docs/2.0/howto/auth.html>`_.
 
8
Currently, SSL connections are not supported.
 
9
 
 
10
.. note:: Unload the :doc:`/plugins/auth_all/index` plugin before using this plugin.
 
11
.. seealso:: :doc:`/administration/authentication` 
 
12
 
 
13
.. _auth_http_loading:
 
14
 
 
15
Loading
 
16
-------
 
17
 
 
18
To load this plugin, start :program:`drizzled` with::
 
19
 
 
20
   --plugin-add=auth_http
 
21
 
 
22
Loading the plugin may not enable or configure it.  See the plugin's
 
23
:ref:`auth_http_configuration` and :ref:`auth_http_variables`.
 
24
 
 
25
.. seealso:: :doc:`/options` for more information about adding and removing plugins.
 
26
 
 
27
.. _auth_http_configuration:
 
28
 
 
29
Configuration
 
30
-------------
 
31
 
 
32
These command line options configure the plugin when :program:`drizzled`
 
33
is started.  See :doc:`/configuration` for more information about specifying
 
34
command line options.
 
35
 
 
36
.. program:: drizzled
 
37
 
 
38
.. option:: --auth-http.url ARG
 
39
 
 
40
   :Default: 
 
41
   :Variable: :ref:`auth_http_url <auth_http_url>`
 
42
   :Required: **This option must be specified**
 
43
 
 
44
   URL for http authentication (required).  If this plugin is loaded, then
 
45
   this option must be specified, else :program:`drizzled` will not start.
 
46
 
 
47
.. _auth_http_variables:
 
48
 
 
49
Variables
 
50
---------
 
51
 
 
52
These variables show the running configuration of the plugin.
 
53
See `variables` for more information about querying and setting variables.
 
54
 
 
55
.. _auth_http_url:
 
56
 
 
57
* ``auth_http_url``
 
58
 
 
59
   :Scope: Global
 
60
   :Dynamic: No
 
61
   :Option: :option:`--auth-http.url`
 
62
 
 
63
   URL for HTTP authentication.
 
64
 
 
65
.. _auth_http_examples:
 
66
 
 
67
Examples
 
68
--------
 
69
 
 
70
Sorry, there are no examples for this plugin.
 
71
 
 
72
.. _auth_http_authors:
 
73
 
 
74
Authors
 
75
-------
 
76
 
 
77
Mark Atwood
 
78
 
 
79
.. _auth_http_version:
 
80
 
 
81
Version
 
82
-------
 
83
 
 
84
This documentation applies to **auth_http 0.1**.
 
85
 
 
86
To see which version of the plugin a Drizzle server is running, execute:
 
87
 
 
88
.. code-block:: mysql
 
89
 
 
90
   SELECT MODULE_VERSION FROM DATA_DICTIONARY.MODULES WHERE MODULE_NAME='auth_http'
 
91
 
 
92
Chanagelog
 
93
----------
 
94
 
 
95
v0.1
 
96
^^^^
 
97
* First release.