| Index: trunk/extensions/OpenID/README.OpenID-mediawiki-extension |
| — | — | @@ -1,5 +1,6 @@ |
| 2 | 2 | MediaWiki OpenID extension |
| 3 | 3 | |
| | 4 | +homepage and manual http://www.mediawiki.org/wiki/Extension:OpenID |
| 4 | 5 | version 0.9.1 |
| 5 | 6 | 15 May 2011 |
| 6 | 7 | |
| — | — | @@ -37,7 +38,6 @@ |
| 38 | 39 | |
| 39 | 40 | Copyright 2006,2007 Internet Brands (http://www.internetbrands.com/) |
| 40 | 41 | Copyright 2008 Evan Prodromou (http://vinismo.com/en/User:Evan) |
| 41 | | -Copyright 2011 Thomas Gries |
| 42 | 42 | |
| 43 | 43 | This program is free software; you can redistribute it and/or modify |
| 44 | 44 | it under the terms of the GNU General Public License as published by |
| — | — | @@ -53,11 +53,12 @@ |
| 54 | 54 | along with this program; if not, write to the Free Software |
| 55 | 55 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 56 | 56 | |
| 57 | | -== Author == |
| | 57 | +== Authors == |
| 58 | 58 | |
| 59 | 59 | Evan Prodromou <evan@vinismo.com> |
| 60 | 60 | Patches for YADIS support and FileStore storage by Jonathan Daugherty |
| 61 | 61 | <cygnus@janrain.com>. |
| | 62 | +Thomas Gries |
| 62 | 63 | |
| 63 | 64 | == Pre-requisites == |
| 64 | 65 | |
| — | — | @@ -69,7 +70,9 @@ |
| 70 | 71 | |
| 71 | 72 | http://www.openidenabled.com/php-openid/ |
| 72 | 73 | |
| 73 | | -It requires patches when running with PHP 5.3.x and later. |
| | 74 | +Unfortunately, tt requires patches when running with PHP 5.3.x and later. |
| | 75 | +The download from the above Url and the patch will be automatically done |
| | 76 | +when you run "make" (see next section). |
| 74 | 77 | |
| 75 | 78 | The version tested with is 2.2.2; '''versions below 2.0 will not work'''. |
| 76 | 79 | |
| — | — | @@ -77,20 +80,55 @@ |
| 78 | 81 | for details. This software has been tested with the gmp and curl PHP extensions |
| 79 | 82 | installed, and it's recommended that you install them, too. |
| 80 | 83 | |
| | 84 | +/* FIXME: */ |
| 81 | 85 | Note that some versions of MediaWiki overwrite the PHP library path in |
| 82 | 86 | LocalSettings.php. You may need to add the path to your PHP library directory |
| 83 | 87 | to the $path variable, like "/usr/share/php" or "/usr/local/share/php". |
| 84 | 88 | |
| 85 | 89 | == Installation == |
| 86 | 90 | |
| 87 | | -To install, copy all the files in the archive you downloaded to the OpenID |
| 88 | | -subdirectory of the extensions subdirectory of your MediaWiki installation. Note |
| 89 | | -that the software depends on having its code all in the "OpenID" sub-directory; |
| 90 | | -naming it "OpenID-Test" or "newextension1" or whatever won't work. |
| | 91 | +The repository downloader can be accessed by: |
| 91 | 92 | |
| | 93 | + http://www.mediawiki.org/wiki/Special:ExtensionDistributor/OpenID |
| | 94 | + |
| | 95 | +To install the MediaWiki extension, download the MediaWiki extension tarball |
| | 96 | +to your extensions subdirectory $IP/extensions of your MediaWiki installation, |
| | 97 | +$IP being the directory of your LocalSettings.php, and untar the package to |
| | 98 | +the subdirectory $IP/extensions/OpenID. |
| | 99 | + |
| | 100 | +The following examples shows the step for extension revision r######: |
| | 101 | + |
| | 102 | + cd $IP/extensions |
| | 103 | + wget http://upload.wikimedia.org/ext-dist/OpenID-trunk-r#####.tar.gz |
| | 104 | + tar -xzf http://upload.wikimedia.org/ext-dist/OpenID-trunk-r#####.tar.gz |
| | 105 | + |
| | 106 | +Remark: |
| | 107 | + |
| | 108 | +Note that the software currently depends on having all its code in the "OpenID" |
| | 109 | +sub-directory; naming it "OpenID-Test" or "newextension1" or whatever |
| | 110 | +won't work. |
| | 111 | + |
| | 112 | +A makefile is included which now automates the second step, the installation of |
| | 113 | +the php-openid library (MediaWiki OpenID depends on the OpenIDEnabled.com PHP |
| | 114 | +library for OpenID, which in turn depends on the OpenIDEnabled.com PHP library |
| | 115 | +for YADIS). |
| | 116 | + |
| | 117 | +Download and patch of openid library: |
| | 118 | + |
| | 119 | + cd $IP/extensions/OpenID |
| | 120 | + make |
| | 121 | + |
| | 122 | +The makefile downloads the openid-php library from http://www.openidenabled.com/php-openid/ |
| | 123 | +and applies a patch to avoid PHP errors because Call-time pass-by-reference is deprecated |
| | 124 | +since PHP 5.3.x see https://github.com/openid/php-openid/issues#issue/8 and |
| | 125 | +the patch and fork of user kost https://github.com/openid/php-openid/pull/44/files |
| | 126 | + |
| 92 | 127 | Run update.php script in in your MediaWiki maintenance folder to create |
| 93 | | -necessary tables in MediaWiki database. |
| | 128 | +necessary tables in MediaWiki database: |
| 94 | 129 | |
| | 130 | + cd $IP/maintenance |
| | 131 | + php update.php |
| | 132 | + |
| 95 | 133 | Version 0.3 and below of this extension used a different database structure |
| 96 | 134 | that was pretty inefficient. If you installed this extension before, you should |
| 97 | 135 | copy the optionToTable.php script to your MediaWiki "maintenance" directory and |
| — | — | @@ -302,13 +340,21 @@ |
| 303 | 341 | is for them. |
| 304 | 342 | |
| 305 | 343 | * $wgOpenIDAllowServingOpenIDUserAccounts -- defaults to false. |
| 306 | | - Having this enabled, it allows User page URLs from this wiki |
| 307 | | - as OpenID identities on other arbitrary OpenID-aware sites - |
| 308 | | - even when using OpenID to login on this wiki. |
| 309 | | - Some users might want to do that for vanity purposes or whatever. |
| | 344 | +* |
| | 345 | + Having this enabled, it allows to use Urls of this wiki's users' pages |
| | 346 | + as OpenID identities on other OpenID-aware sites even when OpenID(s) are |
| | 347 | + associated with user accounts on this wiki. Some users might want to do that |
| | 348 | + for vanity purposes or whatever. |
| | 349 | + |
| 310 | 350 | False prevents the serving of User page URLs as OpenID accounts |
| 311 | | - on other sites (this was an TODO list item). |
| | 351 | + on other sites. |
| | 352 | + |
| | 353 | + Remark: |
| 312 | 354 | |
| | 355 | + User page urls can (currently) only act as OpenID if the User page is existing, |
| | 356 | + i.e. has content, the mere existence of a user account is (currently) not |
| | 357 | + sufficient. |
| | 358 | + |
| 313 | 359 | * $wgOpenIDShowProviderIcons -- defaults to false due to potential |
| 314 | 360 | brand issues. With this enabled, users will see button graphics |
| 315 | 361 | instead of just links in OpenID provider UI. |
| — | — | @@ -323,10 +369,9 @@ |
| 324 | 370 | |
| 325 | 371 | == Translation == |
| 326 | 372 | |
| 327 | | -The user interface strings for this extension are configurable through |
| 328 | | -the same Special:Allmessages page as MediaWiki itself. They all start |
| 329 | | -with "openid", and they're no more or less cryptic than MediaWiki's. |
| 330 | | -You can look at OpenID.i18n.php for some details. |
| | 373 | +The user interface strings for this extension are configurable and all start |
| | 374 | +with "openid". See OpenID.i18n.php for details. Translation is done via |
| | 375 | +translatenet wiki, as usual. |
| 331 | 376 | |
| 332 | 377 | == OpenID services == |
| 333 | 378 | |