diff options
| -rw-r--r-- | examples/README | 48 |
1 files changed, 30 insertions, 18 deletions
diff --git a/examples/README b/examples/README index b6cbb67..fd01ccb 100644 --- a/examples/README +++ b/examples/README @@ -67,36 +67,48 @@ server/: OpenID Example Server To try the example server, follow these steps: -1. Customize server/config.php based on what your PHP installation - supports. The documentation in the file describes what each value - is for. - -2. Copy or symlink the server/ directory into a part of your +1. Copy or symlink the server/ directory into a part of your webserver's docroot. For example, if your DocumentRoot is /var/www/, do this: # cd /var/www # ln -s /path/to/PHP-OpenID-X.Y.Z/examples/server -3. For each of the identity URLs you added to the $openid_users array - in config.php, add the following to the <HEAD> tag of the pages at - those URLs: +2. Navigate to the server example. You'll be redirected to + server/setup.php where you can choose some configuration options to + generate a configuration. Once finished, you can download a file + "config.php." Save that file in the example server directory. + +The example server has the following features: + + - It serves its own identity pages, whose URLs are of the form + + http://.../server/server.php/idpage?user=USERNAME + + - It does not require passwords. + + - It does not support a "trusted sites" page, as you pointed out. - <link rel="openid.server" href="http://www.example.com/server/server.php" /> +In general, the example server is NOT supposed to be treated as a +fully-equiped OpenID server (i.e., with user accounts and other +state). It is supposed to demonstrate how to write PHP applications +that use the library. - Where "www.example.com/server" is the path to the server symlink - that you created in step (2). +Upgrading from the 1.X.X example server +======================================= -4. Navigate to http://www.example.com/server and click the "Log In" - link to test the OpenID(s) entered into the config file. +The 2.X.X library's example server is different from the 1.X.X example +server in the following ways: -5. Use the OpenID checkup tool to try authenticating with your OpenID: + - The new example server does not support authenticating arbitrary + URLs. It serves its own URLs. This makes it easier to set up and + test. - http://www.openidenabled.com/resources/openid-test/checkup + - The new example server does not support password authentication. + This makes it easier to set up and is not necessary for + illustrating the use of the library. - If your OpenID server isn't on the public internet, you can use the - example consumer packaged with this library. See the consumer - section above. + - The new example server does not have a "trusted sites" page. server/ Files ============= |