some readme fixes
[indieauth-openid.git] / README.rst
1 *************************
2 IndieAuth to OpenID proxy
3 *************************
4
5 Proxies IndieAuth__ authorization requests to one's OpenID__ server.
6
7 __ http://indiewebcamp.com/IndieAuth
8 __ http://openid.net/
9
10 =====
11 Setup
12 =====
13
14 1. Setup your webserver: make ``www/`` the root (document) directory of the
15    new virtual host
16 2. Make ``data/`` world-writable (or at least writable by the web server)
17 3. Make sure your website can be used as OpenID identifier
18 4. Modify your website and add the following to its ``<head>``::
19
20      <link rel="authorization_endpoint" href="http://indieauth-openid.example.org/" />
21
22
23 ============
24 Dependencies
25 ============
26
27 * PHP 5.3+
28 * PDO with sqlite3 driver
29 * PEAR libraries:
30
31   * Net_URL2
32   * OpenID
33
34
35 =======
36 License
37 =======
38 ``indieauth-openid`` is licensed under the `AGPL v3`__ or later.
39
40 __ http://www.gnu.org/licenses/agpl.html
41
42
43 ======
44 Author
45 ======
46 Written by Christian Weiske, cweiske@cweiske.de