Merge lp:~hingo/drizzle/7.1-docs-reviewfixes into lp:~drizzle-trunk/drizzle/development
- 7.1-docs-reviewfixes
- Merge into development
Proposed by
Henrik Ingo
Status: | Merged |
---|---|
Approved by: | Mark Atwood |
Approved revision: | 2458 |
Merged at revision: | 2460 |
Proposed branch: | lp:~hingo/drizzle/7.1-docs-reviewfixes |
Merge into: | lp:~drizzle-trunk/drizzle/development |
Diff against target: |
524 lines (+221/-122) 11 files modified
docs/administration/authentication.rst (+25/-13) docs/administration/authorization.rst (+22/-4) docs/administration/drizzled.rst (+12/-4) docs/administration/logging.rst (+5/-5) docs/administration/plugins.rst (+66/-31) docs/configuration/options.rst (+15/-10) docs/contributing/more_ways.rst (+3/-1) docs/installing/from_source.rst (+67/-30) docs/installing/redhat.rst (+0/-20) plugin/auth_pam/docs/index.rst (+4/-4) plugin/js/docs/index.rst (+2/-0) |
To merge this branch: | bzr merge lp:~hingo/drizzle/7.1-docs-reviewfixes |
Related bugs: | |
Related blueprints: |
Documentation focus areas for 7.1 release
(Undefined)
|
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Drizzle Merge Team | Pending | ||
Review via email: mp+82231@code.launchpad.net |
Commit message
Description of the change
Fixes to Daniel's new documentation as discussed / reviewed on drizzle-discuss.
To post a comment you must log in.
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === modified file 'docs/administration/authentication.rst' | |||
2 | --- docs/administration/authentication.rst 2011-10-23 17:13:20 +0000 | |||
3 | +++ docs/administration/authentication.rst 2011-11-14 22:39:27 +0000 | |||
4 | @@ -2,26 +2,38 @@ | |||
5 | 2 | ============== | 2 | ============== |
6 | 3 | 3 | ||
7 | 4 | Authentication is any process by which you verify that someone is who they | 4 | Authentication is any process by which you verify that someone is who they |
12 | 5 | claim they are. [1]_ Drizzle authentication is handled by plugins; there | 5 | claim they are. [1]_ |
13 | 6 | are no grant or privilege tables. | 6 | |
14 | 7 | 7 | Drizzle authentication is handled by plugins; by default there is no single | |
15 | 8 | One or more authentication plugin must be loaded, else no connections can | 8 | source where users are defined, such as a system user table, but each |
16 | 9 | authentication plugin will use different sources to verify the usernames | ||
17 | 10 | and passwords. (The plugin auth_schema does however keep users in a table inside | ||
18 | 11 | Drizzle, much like the familiar MySQL way of authenticating users works.). | ||
19 | 12 | *Choosing an authentication plugin, configuring it, and disabling all other | ||
20 | 13 | authentication plugins should be one of your first administrative tasks.* | ||
21 | 14 | |||
22 | 15 | One or more authentication plugins must be loaded, else no connections can | ||
23 | 9 | be made to Drizzle. On most systems, the :doc:`/plugins/auth_all/index` | 16 | be made to Drizzle. On most systems, the :doc:`/plugins/auth_all/index` |
24 | 10 | plugin is loaded by default which, as its name suggests, allows all | 17 | plugin is loaded by default which, as its name suggests, allows all |
25 | 11 | connections regardless of username or password. (Some distributions enable | 18 | connections regardless of username or password. (Some distributions enable |
26 | 12 | the :doc:`/plugins/auth_file/index` plugin by default instead). | 19 | the :doc:`/plugins/auth_file/index` plugin by default instead). |
27 | 13 | 20 | ||
30 | 14 | `Choosing an authentication plugin, configuring it, and disabling all other | 21 | The :doc:`/plugins/auth_schema/index` plugin first shipped with ``Drizzle 7.1 |
31 | 15 | authentication plugins should be one of your first administrative tasks.` | 22 | Beta 2011.10.28``. This plugin provides an authentication method that is |
32 | 23 | both secure and easy to use, and it is similar to how MySQL authentication | ||
33 | 24 | works so will be familiar to many users. If you don't know which authentication | ||
34 | 25 | plugin to use, you should start with configuring | ||
35 | 26 | :doc:`/plugins/auth_schema/index`. Likewise we warmly recommend distributors to | ||
36 | 27 | consider enabling this plugin by default. | ||
37 | 16 | 28 | ||
38 | 17 | The following authentication plugins are included with Drizzle: | 29 | The following authentication plugins are included with Drizzle: |
39 | 18 | 30 | ||
46 | 19 | * :doc:`/plugins/auth_all/index` | 31 | * :doc:`/plugins/auth_all/index` - Allow all connections without checking username or password. |
47 | 20 | * :doc:`/plugins/auth_file/index` | 32 | * :doc:`/plugins/auth_file/index` - Define users and passwords in a text file that is read on startup. |
48 | 21 | * :doc:`/plugins/auth_http/index` | 33 | * :doc:`/plugins/auth_http/index` - Authenticate the username and password against a http server. |
49 | 22 | * :doc:`/plugins/auth_ldap/index` | 34 | * :doc:`/plugins/auth_ldap/index` - Define users and passwords in a LDAP directory. |
50 | 23 | * :doc:`/plugins/auth_pam/index` | 35 | * :doc:`/plugins/auth_pam/index` - Authenticate the username and password against system user accounts via PAM. |
51 | 24 | * :doc:`/plugins/auth_schema/index` | 36 | * :doc:`/plugins/auth_schema/index` - Define users and passwords in a system table. |
52 | 25 | 37 | ||
53 | 26 | Protocols | 38 | Protocols |
54 | 27 | --------- | 39 | --------- |
55 | @@ -48,7 +60,7 @@ | |||
56 | 48 | :ref:`auth_all_plugin` Any | 60 | :ref:`auth_all_plugin` Any |
57 | 49 | :ref:`auth_file_plugin` mysql | 61 | :ref:`auth_file_plugin` mysql |
58 | 50 | :ref:`auth_http_plugin` mysql-plugin-auth | 62 | :ref:`auth_http_plugin` mysql-plugin-auth |
60 | 51 | :ref:`auth_ldap_plugin` mysql-plugin-auth | 63 | :ref:`auth_ldap_plugin` Any |
61 | 52 | :ref:`auth_pam_plugin` mysql-plugin-auth | 64 | :ref:`auth_pam_plugin` mysql-plugin-auth |
62 | 53 | :ref:`auth_schema_plugin` mysql | 65 | :ref:`auth_schema_plugin` mysql |
63 | 54 | ========================= ================== | 66 | ========================= ================== |
64 | 55 | 67 | ||
65 | === modified file 'docs/administration/authorization.rst' | |||
66 | --- docs/administration/authorization.rst 2011-10-23 05:45:09 +0000 | |||
67 | +++ docs/administration/authorization.rst 2011-11-14 22:39:27 +0000 | |||
68 | @@ -2,13 +2,31 @@ | |||
69 | 2 | ============= | 2 | ============= |
70 | 3 | 3 | ||
71 | 4 | Authorization is finding out if the person, once identified, is permitted to | 4 | Authorization is finding out if the person, once identified, is permitted to |
74 | 5 | have the resource. [1]_ Drizzle authorization is handled by plugins; there | 5 | have the resource. [1]_ |
75 | 6 | are no grant or privilege tables. | 6 | |
76 | 7 | Drizzle authorization is handled by plugins. There is no single | ||
77 | 8 | source where users or access rights are defined, such as a system user table, | ||
78 | 9 | but each auhtorization plugin will use different sources to define or store | ||
79 | 10 | access rights. By default no authorization plugin is loaded, this means that | ||
80 | 11 | any logged in user is authorized to access all database objects and do anything | ||
81 | 12 | he wants (everyone is super user). | ||
82 | 7 | 13 | ||
83 | 8 | The following authorization plugins are included with Drizzle: | 14 | The following authorization plugins are included with Drizzle: |
84 | 9 | 15 | ||
87 | 10 | * :doc:`/plugins/regex_policy/index` | 16 | * :doc:`/plugins/regex_policy/index` - ALLOW or REJECT access by matching a regular expression against the table name. |
88 | 11 | * :doc:`/plugins/simple_user_policy/index` | 17 | * :doc:`/plugins/simple_user_policy/index` - Allow a user to only access a schema that matches their username. |
89 | 18 | |||
90 | 19 | Limitations | ||
91 | 20 | ----------- | ||
92 | 21 | |||
93 | 22 | At the moment there doesn't exist a plugin which would implement anything | ||
94 | 23 | resembling the traditional SQL standard GRANT and REVOKE type of authorization. | ||
95 | 24 | You are invited to share your opinion on whether that level of authorization | ||
96 | 25 | control is necessary in a modern database. | ||
97 | 26 | |||
98 | 27 | Note that at the moment there also is no plugin that would distinguish between | ||
99 | 28 | read and write operations, rather access is always granted to schemas and tables | ||
100 | 29 | in an all or nothing fashion. | ||
101 | 12 | 30 | ||
102 | 13 | ------------------------------------------------------------------------------- | 31 | ------------------------------------------------------------------------------- |
103 | 14 | 32 | ||
104 | 15 | 33 | ||
105 | === modified file 'docs/administration/drizzled.rst' | |||
106 | --- docs/administration/drizzled.rst 2011-10-23 05:45:09 +0000 | |||
107 | +++ docs/administration/drizzled.rst 2011-11-14 22:39:27 +0000 | |||
108 | @@ -77,13 +77,21 @@ | |||
109 | 77 | 77 | ||
110 | 78 | The ``shutdown`` command is case-sensitive. | 78 | The ``shutdown`` command is case-sensitive. |
111 | 79 | 79 | ||
114 | 80 | Output | 80 | Output and Logging |
115 | 81 | ------ | 81 | ------------------ |
116 | 82 | 82 | ||
117 | 83 | :program:`drizzled` does *not* close or redirect output to ``STDOUT`` or | 83 | :program:`drizzled` does *not* close or redirect output to ``STDOUT`` or |
118 | 84 | ``STDERR`` to a log file or logging facility like :program:`syslog`. | 84 | ``STDERR`` to a log file or logging facility like :program:`syslog`. |
121 | 85 | You should redirect ``STDOUT`` and ``STDERR`` to a log file as in the above | 85 | When starting Drizzle, you should redirect ``STDOUT`` and ``STDERR`` to a log |
122 | 86 | script example for starting Drizzle manually. | 86 | file or to /dev/null, as in the above script example when starting Drizzle. |
123 | 87 | |||
124 | 88 | When running :program:`drizzled` manually from a console, just allowing the | ||
125 | 89 | output to be printed for you can of course be useful. | ||
126 | 90 | |||
127 | 91 | Note that beginning with the first ``Drizzle 7.1 Beta 2011.10.28`` drizzled | ||
128 | 92 | will also log messages via syslog and this is *in addition* to using ``STDOUT`` | ||
129 | 93 | and ``STDERR``. | ||
130 | 94 | |||
131 | 87 | 95 | ||
132 | 88 | Signaling | 96 | Signaling |
133 | 89 | --------- | 97 | --------- |
134 | 90 | 98 | ||
135 | === modified file 'docs/administration/logging.rst' | |||
136 | --- docs/administration/logging.rst 2011-10-23 16:01:37 +0000 | |||
137 | +++ docs/administration/logging.rst 2011-11-14 22:39:27 +0000 | |||
138 | @@ -12,11 +12,11 @@ | |||
139 | 12 | redirected to a log file when | 12 | redirected to a log file when |
140 | 13 | :ref:`starting Drizzle <starting_and_stopping_drizzled>`. | 13 | :ref:`starting Drizzle <starting_and_stopping_drizzled>`. |
141 | 14 | 14 | ||
147 | 15 | Since :program:`syslog` is the standard UNIX logging facility, | 15 | Note that beginning with the first ``Drizzle 7.1 Beta 2011.10.28`` drizzled |
148 | 16 | the :ref:`syslog_plugin` plugin is also loaded by default which will log error | 16 | will **also** log messages via syslog and this is *in addition* to using |
149 | 17 | messages to the system log (:file:`/var/log/syslog` on Ubuntu for example). | 17 | ``STDOUT`` and ``STDERR``. This functionality is provided by the |
150 | 18 | However, you must start :program:`drizzled` with | 18 | :ref:`syslog_plugin` plugin. (For example on Ubuntu these messages are written |
151 | 19 | :option:`--syslog.errmsg-enable` to enable this feature. | 19 | to :file:`/var/log/syslog`). |
152 | 20 | 20 | ||
153 | 21 | Queries | 21 | Queries |
154 | 22 | ------- | 22 | ------- |
155 | 23 | 23 | ||
156 | === modified file 'docs/administration/plugins.rst' | |||
157 | --- docs/administration/plugins.rst 2011-10-23 05:45:09 +0000 | |||
158 | +++ docs/administration/plugins.rst 2011-11-14 22:39:27 +0000 | |||
159 | @@ -14,34 +14,69 @@ | |||
160 | 14 | 14 | ||
161 | 15 | Drizzle loads these plugins by default (see :option:`--plugin-load`): | 15 | Drizzle loads these plugins by default (see :option:`--plugin-load`): |
162 | 16 | 16 | ||
194 | 17 | * auth_all (:ref:`auth_all_plugin`) | 17 | * :ref:`ascii_plugin` - Return the ASCII value of a character (ascii) |
195 | 18 | * ascii (:ref:`ascii_plugin`) | 18 | * :ref:`auth_all_plugin` - Data Dictionary for utility tables (auth_all) |
196 | 19 | * benchmark (:ref:`benchmark_plugin`) | 19 | * :ref:`benchmark_plugin` - Measure time for repeated calls to a function. (benchmark) |
197 | 20 | * charlength (:ref:`charlength_plugin`) | 20 | * :ref:`catalog_plugin` - Basic Catalog functions, data dictionary, and system. (catalog) |
198 | 21 | * compression (:ref:`compression_plugin`) | 21 | * :ref:`charlength_plugin` - Return the number of characters in a string (charlength) |
199 | 22 | * connection_id (:ref:`connection_id_plugin`) | 22 | * :ref:`collation_dictionary_plugin` - Data Dictionary for schema, table, column, indexes, etc (collation_dictionary) |
200 | 23 | * crc32 (:ref:`crc32_plugin`) | 23 | * :ref:`compression_plugin` - UDFs for compression functions (compression) |
201 | 24 | * default_replicator (:ref:`default_replicator_plugin`) | 24 | * :ref:`connection_id_plugin` - Return the current connection_id (connection_id) |
202 | 25 | * drizzle_protocol (:ref:`drizzle_protocol_plugin`) | 25 | * :ref:`console_plugin` - Console Client (console) |
203 | 26 | * errmsg_stderr (:ref:`errmsg_stderr_plugin`) | 26 | * :ref:`crc32_plugin` - CRC32 Function (crc32) |
204 | 27 | * filtered_replicator (:ref:`filtered_replicator_plugin`) | 27 | * :ref:`default_replicator_plugin` - Default Replicator (default_replicator) |
205 | 28 | * hex_functions (:ref:`hex_functions_plugin`) | 28 | * :ref:`drizzle_protocol_plugin` - Drizzle Protocol (drizzle_protocol) |
206 | 29 | * innobase (:ref:`innobase_plugin`) | 29 | * :ref:`errmsg_stderr_plugin` - Error Messages to stderr (errmsg_stderr) |
207 | 30 | * length (:ref:`length_plugin`) | 30 | * :ref:`error_dictionary_plugin` - Data Dictionary for Errors. (error_dictionary) |
208 | 31 | * logging_stats (:ref:`logging_stats_plugin`) | 31 | * :ref:`function_engine_plugin` - Function Engine provides the infrastructure for Table Functions,etc. (function_engine) |
209 | 32 | * math_functions (:ref:`math_functions_plugin`) | 32 | * :ref:`hex_functions_plugin` - Convert a string to HEX() or from UNHEX() (hex_functions) |
210 | 33 | * md5 (:ref:`md5_plugin`) | 33 | * :ref:`information_schema_dictionary_plugin` - Data Dictionary for ANSI information schema, etc (information_schema_dictionary) |
211 | 34 | * memory (:ref:`memory_plugin`) | 34 | * :ref:`innobase_plugin` - Supports transactions, row-level locking, and foreign keys (innobase) |
212 | 35 | * multi_thread (:ref:`multi_thread_plugin`) | 35 | * :ref:`ipv6_function_plugin` - IPV6() function (ipv6_function) |
213 | 36 | * myisam (:ref:`myisam_plugin`) | 36 | * :ref:`js_plugin` - Execute JavaScript code with supplied arguments (js) |
214 | 37 | * mysql_protocol (:ref:`mysql_protocol_plugin`) | 37 | * :ref:`length_plugin` - Return the byte length of a string (length) |
215 | 38 | * mysql_unix_socket_protocol (:ref:`mysql_unix_socket_protocol_plugin`) | 38 | * :ref:`logging_stats_plugin` - User Statistics as DATA_DICTIONARY tables (logging_stats) |
216 | 39 | * rand_function (:ref:`rand_function_plugin`) | 39 | * :ref:`math_functions_plugin` - Math Functions. (math_functions) |
217 | 40 | * reverse_function (:ref:`reverse_function_plugin`) | 40 | * :ref:`md5_plugin` - UDF for computing md5sum (md5) |
218 | 41 | * sleep (:ref:`sleep_plugin`) | 41 | * :ref:`memory_plugin` - Hash based, stored in memory, useful for temporary tables (memory) |
219 | 42 | * show_schema_proto (:ref:`show_schema_proto_plugin`) | 42 | * :ref:`multi_thread_plugin` - One Thread Per Session Scheduler (multi_thread) |
220 | 43 | * substr_functions (:ref:`substr_functions_plugin`) | 43 | * :ref:`myisam_plugin` - Default engine as of MySQL 3.23 with great performance (myisam) |
221 | 44 | * syslog (:ref:`syslog_plugin`) | 44 | * :ref:`mysql_protocol_plugin` - MySQL Protocol Module (mysql_protocol) |
222 | 45 | * transaction_log (:ref:`transaction_log_plugin`) | 45 | * :ref:`mysql_unix_socket_protocol_plugin` - MySQL Unix Socket Protocol (mysql_unix_socket_protocol) |
223 | 46 | * uuid_function (:ref:`uuid_function_plugin`) | 46 | * :ref:`protocol_dictionary_plugin` - Provides dictionary for protocol counters. (protocol_dictionary) |
224 | 47 | * version (:ref:`version_plugin`) | 47 | * :ref:`rand_function_plugin` - RAND Function (rand_function) |
225 | 48 | * :ref:`registry_dictionary_plugin` - Provides dictionary for plugin registry system. (registry_dictionary) | ||
226 | 49 | * :ref:`replication_dictionary_plugin` - Replication Dictionary (replication_dictionary) | ||
227 | 50 | * :ref:`reverse_function_plugin` - reverses a string (reverse_function) | ||
228 | 51 | * :ref:`schema_dictionary_plugin` - Data Dictionary for schema, table, column, indexes, etc (schema_dictionary) | ||
229 | 52 | * :ref:`schema_engine_plugin` - This implements the default file based Schema engine. (schema_engine) | ||
230 | 53 | * :ref:`session_dictionary_plugin` - Dictionary for session information, aka proccesslist, user defined variables, etc. (session_dictionary) | ||
231 | 54 | * :ref:`show_dictionary_plugin` - Dictionary for show commands. (show_dictionary) | ||
232 | 55 | * :ref:`show_schema_proto_plugin` - Shows text representation of schema definition proto (show_schema_proto) | ||
233 | 56 | * :ref:`signal_handler_plugin` - Default Signal Handler (signal_handler) | ||
234 | 57 | * :ref:`sleep_plugin` - SLEEP Function (sleep) | ||
235 | 58 | * :ref:`status_dictionary_plugin` - Dictionary for status, statement, and variable information. (status_dictionary) | ||
236 | 59 | * :ref:`string_functions_plugin` - String Functions. (string_functions) | ||
237 | 60 | * :ref:`substr_functions_plugin` - SUBSTR and SUBSTR (substr_functions) | ||
238 | 61 | * :ref:`syslog_plugin` - Syslog (syslog) | ||
239 | 62 | * :ref:`table_cache_dictionary_plugin` - Data Dictionary for table and table definition cache. (table_cache_dictionary) | ||
240 | 63 | * :ref:`transaction_log_plugin` - Transaction Log (transaction_log) | ||
241 | 64 | * :ref:`user_locks_plugin` - User level locking and barrier functions (user_locks) | ||
242 | 65 | * :ref:`utility_functions_plugin` - Utility Functions. (utility_functions) | ||
243 | 66 | * :ref:`uuid_function_plugin` - UUID() function using libuuid (uuid_function) | ||
244 | 67 | * :ref:`version_plugin` - Print Drizzle version (version) | ||
245 | 68 | |||
246 | 69 | You can list information about the loaded plugins with: | ||
247 | 70 | |||
248 | 71 | .. code-block:: mysql | ||
249 | 72 | |||
250 | 73 | SELECT * FROM DATA_DICTIONARY.MODULES; | ||
251 | 74 | |||
252 | 75 | Note to editors: The above list of functions can be regenerated at any time with: | ||
253 | 76 | |||
254 | 77 | .. code-block:: mysql | ||
255 | 78 | |||
256 | 79 | drizzle --silent -e "SELECT CONCAT(' * ', ':ref:\`', MODULE_LIBRARY, '_plugin\` - ', MODULE_DESCRIPTION, ' (', MODULE_LIBRARY, ')') | ||
257 | 80 | FROM DATA_DICTIONARY.MODULES ORDER BY MODULE_LIBRARY;" | ||
258 | 81 | |||
259 | 82 | |||
260 | 48 | 83 | ||
261 | === modified file 'docs/configuration/options.rst' | |||
262 | --- docs/configuration/options.rst 2011-11-06 00:00:03 +0000 | |||
263 | +++ docs/configuration/options.rst 2011-11-14 22:39:27 +0000 | |||
264 | @@ -23,7 +23,7 @@ | |||
265 | 23 | ``drizzled --plugin-add PLUGIN --help`` where ``PLUGIN`` is the name of any | 23 | ``drizzled --plugin-add PLUGIN --help`` where ``PLUGIN`` is the name of any |
266 | 24 | plugin. For example: | 24 | plugin. For example: |
267 | 25 | 25 | ||
269 | 26 | .. code-block:: bash | 26 | .. code-block:: none |
270 | 27 | 27 | ||
271 | 28 | $ drizzled --plugin-add query_log --help | 28 | $ drizzled --plugin-add query_log --help |
272 | 29 | sbin/drizzled Ver 2011.08.25.2411 for pc-linux-gnu on i686 (Source distribution (trunk)) | 29 | sbin/drizzled Ver 2011.08.25.2411 for pc-linux-gnu on i686 (Source distribution (trunk)) |
273 | @@ -149,9 +149,9 @@ | |||
274 | 149 | in this directory.) | 149 | in this directory.) |
275 | 150 | 150 | ||
276 | 151 | A good strategy for configuring Drizzle with multiple config files is to | 151 | A good strategy for configuring Drizzle with multiple config files is to |
278 | 152 | put :ref:`drizzled_options` in :file:`/etc/drizzle/drizzled.cnf` | 152 | put general :ref:`drizzled_options` in :file:`/etc/drizzle/drizzled.cnf` |
279 | 153 | (:file:`/etc/drizzle` is the default :option:`--config-dir` value) | 153 | (:file:`/etc/drizzle` is the default :option:`--config-dir` value) |
281 | 154 | and plugin options in spearate config files in | 154 | and any options related to a plugin in a separate config file in |
282 | 155 | :file:`/etc/drizzle/conf.d/`. For example: | 155 | :file:`/etc/drizzle/conf.d/`. For example: |
283 | 156 | 156 | ||
284 | 157 | .. code-block:: bash | 157 | .. code-block:: bash |
285 | @@ -168,15 +168,20 @@ | |||
286 | 168 | 168 | ||
287 | 169 | .. code-block:: ini | 169 | .. code-block:: ini |
288 | 170 | 170 | ||
289 | 171 | server-id=42 | ||
290 | 172 | core-file | ||
291 | 173 | |||
292 | 174 | .. code-block:: bash | ||
293 | 175 | |||
294 | 176 | $ cat /etc/drizzle/conf.d/auth-file | ||
295 | 177 | |||
296 | 178 | .. code-block:: ini | ||
297 | 179 | |||
298 | 180 | # drizzled option to load the auth_file plugin | ||
299 | 171 | plugin-remove=auth_all | 181 | plugin-remove=auth_all |
300 | 172 | plugin-add=auth_file | 182 | plugin-add=auth_file |
308 | 173 | 183 | ||
309 | 174 | .. code-block:: bash | 184 | # Options for the plugin itself |
303 | 175 | |||
304 | 176 | $ cat /etc/drizzle/conf.d/auth-file | ||
305 | 177 | |||
306 | 178 | .. code-block:: ini | ||
307 | 179 | |||
310 | 180 | [auth-file] | 185 | [auth-file] |
311 | 181 | users=/etc/drizzle/users | 186 | users=/etc/drizzle/users |
312 | 182 | 187 | ||
313 | 183 | 188 | ||
314 | === modified file 'docs/contributing/more_ways.rst' | |||
315 | --- docs/contributing/more_ways.rst 2011-10-23 05:45:09 +0000 | |||
316 | +++ docs/contributing/more_ways.rst 2011-11-14 22:39:27 +0000 | |||
317 | @@ -18,4 +18,6 @@ | |||
318 | 18 | 18 | ||
319 | 19 | Drizzle is an Associated Project at the | 19 | Drizzle is an Associated Project at the |
320 | 20 | `Software in the Public Interest (SPI) <http://spi-inc.org/>`_. You | 20 | `Software in the Public Interest (SPI) <http://spi-inc.org/>`_. You |
322 | 21 | can make a financial donation to Drizzle through the SPI. | 21 | can `make a financial donation to Drizzle |
323 | 22 | <https://co.clickandpledge.com/advanced/default.aspx?wid=46722>`_ through the | ||
324 | 23 | SPI. | ||
325 | 22 | 24 | ||
326 | === modified file 'docs/installing/from_source.rst' | |||
327 | --- docs/installing/from_source.rst 2011-10-23 05:45:09 +0000 | |||
328 | +++ docs/installing/from_source.rst 2011-11-14 22:39:27 +0000 | |||
329 | @@ -1,11 +1,38 @@ | |||
330 | 1 | Installing Drizzle from Source | 1 | Installing Drizzle from Source |
331 | 2 | ============================== | 2 | ============================== |
332 | 3 | 3 | ||
333 | 4 | * :ref:`obtain-source` | ||
334 | 5 | * :ref:`compile-source` | ||
335 | 4 | * :ref:`dependencies` | 6 | * :ref:`dependencies` |
336 | 5 | * :ref:`ubuntu-install` | 7 | * :ref:`ubuntu-install` |
337 | 6 | * :ref:`debian-install` | 8 | * :ref:`debian-install` |
340 | 7 | * :ref:`obtain-source` | 9 | * :ref:`redhat-install` |
341 | 8 | * :ref:`compile-source` | 10 | |
342 | 11 | .. _obtain-source: | ||
343 | 12 | |||
344 | 13 | Obtaining the Source | ||
345 | 14 | -------------------- | ||
346 | 15 | The latest source release can always be found on our `LaunchPad site | ||
347 | 16 | <https://launchpad.net/drizzle>`_. Alternatively, the bzr source from our stable | ||
348 | 17 | trunk can be obtained by doing: | ||
349 | 18 | |||
350 | 19 | .. code-block:: bash | ||
351 | 20 | |||
352 | 21 | bzr branch lp:drizzle | ||
353 | 22 | |||
354 | 23 | .. _compile-source: | ||
355 | 24 | |||
356 | 25 | Compiling the Source | ||
357 | 26 | -------------------- | ||
358 | 27 | Compiling is done by performing the standard automake commands from the top level directory inside the source: | ||
359 | 28 | |||
360 | 29 | .. code-block:: bash | ||
361 | 30 | |||
362 | 31 | ./config/autorun.sh | ||
363 | 32 | ./configure | ||
364 | 33 | make | ||
365 | 34 | make install | ||
366 | 35 | |||
367 | 9 | 36 | ||
368 | 10 | .. _dependencies: | 37 | .. _dependencies: |
369 | 11 | 38 | ||
370 | @@ -53,6 +80,7 @@ | |||
371 | 53 | * libpam0g-dev | 80 | * libpam0g-dev |
372 | 54 | * libprotobuf-dev (>= 2.1.0) | 81 | * libprotobuf-dev (>= 2.1.0) |
373 | 55 | * libtokyocabinet-dev (>= 1.4.23) | 82 | * libtokyocabinet-dev (>= 1.4.23) |
374 | 83 | * libv8-dev | ||
375 | 56 | * systemtap-sdt-dev | 84 | * systemtap-sdt-dev |
376 | 57 | * libnotifymm-dev | 85 | * libnotifymm-dev |
377 | 58 | * doxygen | 86 | * doxygen |
378 | @@ -60,8 +88,8 @@ | |||
379 | 60 | 88 | ||
380 | 61 | .. _ubuntu-install: | 89 | .. _ubuntu-install: |
381 | 62 | 90 | ||
384 | 63 | Ubuntu Install Commands | 91 | Installing Build Dependencies on Ubuntu |
385 | 64 | ----------------------- | 92 | --------------------------------------- |
386 | 65 | 93 | ||
387 | 66 | The following commands work on Ubuntu to install the tools and libraries needed to build Drizzle: | 94 | The following commands work on Ubuntu to install the tools and libraries needed to build Drizzle: |
388 | 67 | 95 | ||
389 | @@ -74,8 +102,8 @@ | |||
390 | 74 | 102 | ||
391 | 75 | .. _debian-install: | 103 | .. _debian-install: |
392 | 76 | 104 | ||
395 | 77 | Debian Install Commands | 105 | Installing Build Dependencies on Debian |
396 | 78 | ----------------------- | 106 | --------------------------------------- |
397 | 79 | 107 | ||
398 | 80 | Since apt-repository isn't in Debian, you can instead add the Maverick PPA to /etc/apt/sources.list as follows: | 108 | Since apt-repository isn't in Debian, you can instead add the Maverick PPA to /etc/apt/sources.list as follows: |
399 | 81 | 109 | ||
400 | @@ -109,28 +137,37 @@ | |||
401 | 109 | 137 | ||
402 | 110 | apt-get install drizzle | 138 | apt-get install drizzle |
403 | 111 | 139 | ||
428 | 112 | .. _obtain-source: | 140 | .. _redhat-install: |
429 | 113 | 141 | ||
430 | 114 | Obtaining the Source | 142 | Installing Build Dependencies on Red Hat or Fedora |
431 | 115 | -------------------- | 143 | -------------------------------------------------- |
432 | 116 | The latest source release can always be found on our `LaunchPad site | 144 | |
433 | 117 | <https://launchpad.net/drizzle>`_. Alternatively, the bzr source from our stable | 145 | Depending on whether you use Red Hat (RHEL) or Fedora, you should add the |
434 | 118 | trunk can be obtained by doing: | 146 | repositories as explained in :doc:`redhat`. |
435 | 119 | 147 | ||
436 | 120 | .. code-block:: bash | 148 | After that, install the following packages: |
437 | 121 | 149 | ||
438 | 122 | bzr branch lp:drizzle | 150 | * bzr |
439 | 123 | 151 | * boost-devel | |
440 | 124 | .. _compile-source: | 152 | * autoconf |
441 | 125 | 153 | * automake | |
442 | 126 | Compiling the Source | 154 | * gcc |
443 | 127 | -------------------- | 155 | * gcc-c++ |
444 | 128 | Compiling is done by performing the standard automake commands from the top level directory inside the source: | 156 | * libtool |
445 | 129 | 157 | * gperf | |
446 | 130 | .. code-block:: bash | 158 | * libuuid-devel (part of e2fsprogs-devel on older RedHat based distributions) |
447 | 131 | 159 | * zlib-devel | |
448 | 132 | ./config/autorun.sh | 160 | * pcre-devel |
449 | 133 | ./configure | 161 | * readline-devel |
450 | 134 | make | 162 | * flex |
451 | 135 | make install | 163 | * bison |
452 | 164 | |||
453 | 165 | Note that you should be able to install all of the above simply with | ||
454 | 166 | |||
455 | 167 | .. code-block:: bash | ||
456 | 168 | |||
457 | 169 | yum-builddep drizzle | ||
458 | 170 | |||
459 | 171 | |||
460 | 172 | |||
461 | 136 | 173 | ||
462 | 137 | 174 | ||
463 | === modified file 'docs/installing/redhat.rst' | |||
464 | --- docs/installing/redhat.rst 2011-10-23 05:45:09 +0000 | |||
465 | +++ docs/installing/redhat.rst 2011-11-14 22:39:27 +0000 | |||
466 | @@ -73,23 +73,3 @@ | |||
467 | 73 | 73 | ||
468 | 74 | sudo yum install drizzle7-server drizzle7-client | 74 | sudo yum install drizzle7-server drizzle7-client |
469 | 75 | 75 | ||
470 | 76 | Compiling from Source | ||
471 | 77 | --------------------- | ||
472 | 78 | To compile from source you will need to add the repositories described above, and then install the following packages: | ||
473 | 79 | |||
474 | 80 | * bzr | ||
475 | 81 | * boost-devel | ||
476 | 82 | * autoconf | ||
477 | 83 | * automake | ||
478 | 84 | * gcc | ||
479 | 85 | * gcc-c++ | ||
480 | 86 | * libtool | ||
481 | 87 | * gperf | ||
482 | 88 | * libuuid-devel (part of e2fsprogs-devel on older RedHat based distributions) | ||
483 | 89 | * zlib-devel | ||
484 | 90 | * pcre-devel | ||
485 | 91 | * readline-devel | ||
486 | 92 | * flex | ||
487 | 93 | * bison | ||
488 | 94 | |||
489 | 95 | You will then be able to compile from source in the normal way. | ||
490 | 96 | 76 | ||
491 | === modified file 'plugin/auth_pam/docs/index.rst' | |||
492 | --- plugin/auth_pam/docs/index.rst 2011-11-06 00:00:03 +0000 | |||
493 | +++ plugin/auth_pam/docs/index.rst 2011-11-14 22:39:27 +0000 | |||
494 | @@ -81,7 +81,7 @@ | |||
495 | 81 | 81 | ||
496 | 82 | Then connect to Drizzle like: | 82 | Then connect to Drizzle like: |
497 | 83 | 83 | ||
499 | 84 | .. code-block:: bash | 84 | .. code-block:: none |
500 | 85 | 85 | ||
501 | 86 | $ bin/drizzle -P --protocol mysql-plugin-auth | 86 | $ bin/drizzle -P --protocol mysql-plugin-auth |
502 | 87 | Enter password: [Enter your system password here] | 87 | Enter password: [Enter your system password here] |
503 | @@ -99,9 +99,9 @@ | |||
504 | 99 | protocol sends the password in plaintext to Drizzle, which | 99 | protocol sends the password in plaintext to Drizzle, which |
505 | 100 | is required for PAM based authentication. | 100 | is required for PAM based authentication. |
506 | 101 | 101 | ||
510 | 102 | Note that you don't need to specify the ``-u`` or ``--user`` argument, since | 102 | Note that you typically don't need to specify the ``-u`` or ``--user`` argument, |
511 | 103 | Drizzle will default to using your system username, which is exactly what we | 103 | since Drizzle will default to using your system username, which is exactly what |
512 | 104 | want when using auth_pam. | 104 | we want when using auth_pam. |
513 | 105 | 105 | ||
514 | 106 | .. _auth_pam_security: | 106 | .. _auth_pam_security: |
515 | 107 | 107 | ||
516 | 108 | 108 | ||
517 | === modified file 'plugin/js/docs/index.rst' | |||
518 | --- plugin/js/docs/index.rst 2011-10-01 10:06:00 +0000 | |||
519 | +++ plugin/js/docs/index.rst 2011-11-14 22:39:27 +0000 | |||
520 | @@ -1,3 +1,5 @@ | |||
521 | 1 | .. _js_plugin: | ||
522 | 2 | |||
523 | 1 | JS | 3 | JS |
524 | 2 | =========== | 4 | =========== |
525 | 3 | 5 |