changed git call from https to git readonly
[atutor.git] / mods / wordpress / wp_plugin / external-database-authentication / readme.txt
1 === Plugin Name ===\r
2 Contributors: charlener\r
3 Donate link: none\r
4 Tags: authentication, login, database, MSSQL, MySQL, PostgreSQL\r
5 Requires at least: 2.7\r
6 Tested up to: 2.9\r
7 Stable tag: 3.15\r
8 \r
9 A plugin that allows the use of an external database (MySQL, PostgreSQL, or MSSQL) for authentication into wordpress.  Supports various password hashing methods and user role checks from the external database.\r
10 \r
11 == Description ==\r
12 A plugin that allows the use of an external MySQL, PostgreSQL, or MSSQL database for authentication into wordpress.  It requires you know the encryption method for the passwords stored in the external database and allows you to use MD5, SHA1, plaintext, or enter the hash/salt method yourself.  It disables password reset/retrieval and account creation within the wordpress system on the user-end, and it doesn't allow updating from the wordpress end back into the external authentication source. \r
13 \r
14 In addition to authentication the plugin allows you to:\r
15 1. Choose additional fields, such as first name/last name and website, to be imported into the wordpress user system.\r
16 1. Enter a custom message for users concerning logins. \r
17 1. Do user role checks from the external database: you can set the plugin to check from a specific role field and compare to a value to allow login to wordpress.  \r
18 \r
19 PostgreSQL or MSSQL database authentication requires MDB2 PEAR database abstraction package and relevant database drivers. MySQL continues to use the built-in PHP functions.\r
20 \r
21 == Installation ==\r
22 \r
23 1. Prepare your WP admin account on your external database: make a login with username 'admin' and password hashed the way accounts are handled on that database.\r
24 1. If using PostgreSQL or MSSQL, install the MDB2 PEAR database abstraction package and relevant database drivers and confirm its include path.\r
25 1. Change "New User Default Role" in Settings->General, if desired, to whatever level of control you wish externally authenticated users to have.\r
26 1. Upload `ext_db_auth.php` to the `/wp-content/plugins/` directory\r
27 1. Activate the plugin through the 'Plugins' menu in WordPress\r
28 1. Enter your external database settings in Settings->External DB settings\r
29 \r
30 \r
31 == Frequently Asked Questions ==\r
32 \r
33 = My admin account for WP doesn't work anymore! =\r
34 \r
35 We're authenticating externally, right?  Take that admin account you initially created in your WP setup and make sure it's in your external database.  Once it's in there you'll be able to log in as admin with no problems.  If you can't do this, delete the plugin and it'll restore access using your WP admin account.\r
36 \r
37 = Can I still create accounts within WordPress? =\r
38 \r
39 You could, but they don't work properly as it's not checking against the WP database, just the external then making sure the WP user info is the same as what's currently on the external database.\r
40 \r
41 = Can I update user information within WordPress? =\r
42 \r
43 Nope.\r
44 \r
45 = My external database's passwords are hashed with a salt/datestamp/phases of the moon/etc =\r
46 \r
47 Choose "Other" as your encoding method, then enter the method you use in the "Other" textbox as PHP code. If it involves more than the username and password, though, you may need to modify the plugin source code.\r
48 \r
49 = I'm locked out! =\r
50 \r
51 Delete or rename the plugin; if it's a DB connection-related error most likely you have the wrong connection, etc. information for the external database.\r
52 \r
53 == Screenshots ==\r
54 \r
55 1. Plugin config screen\r
56 2. Example login warning message upon access to wp-login.php\r
57 3. Example "Lost my password" retrieval attempt\r
58 \r
59 == Changelog ==\r
60 \r
61 = 3.15 =\r
62 * Disables password reset on user profile screen and has warning concerning updating profile within Wordpress\r
63 * Changes to config screen form for improved usability.\r
64 * Made lost your password and register error messages less fugly.\r
65 * Updated readme.txt\r
66 \r
67 = 3.12 =\r
68 * Now correctly imports unicode text into user profile fields\r
69 * Checked with 2.8x WP, 2.8x WPMU, and 2.9 WP\r
70 * Added in line as noted in forum post http://wordpress.org/support/topic/277235?replies=4