improve security; add README
[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 =====
8 Setup
9 =====
10
11 1. Setup your webserver: make ``www/`` the root (document) directory of the
12    new virtual host
13 2. Make ``data/`` world-writable (or at least writable by the web server)
14 3. Modify your website and add the following to its ``<head>``::
15
16      <link rel="authorization_endpoint" href="https://indieauth-openid.example.org/" />
17
18
19 ============
20 Dependencies
21 ============
22
23 * PDO::sqlite3
24 * PEAR Libraries:
25
26   * Net_URL2
27   * OpenID
28
29
30 =======
31 License
32 =======
33 ``indieauth-openid`` is licensed under the `AGPL v3`__ or later.
34
35 __ http://www.gnu.org/licenses/agpl.html
36
37
38 ======
39 Author
40 ======
41 Written by Christian Weiske, cweiske@cweiske.de