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 0. Install dependencies
  15 1. Setup your webserver: make ``www/`` the root (document) directory of the
  16    new virtual host
  17 2. Make ``data/`` world-writable (or at least writable by the web server)
  18 3. Make sure your website can be used as OpenID identifier
  19 4. Modify your website and add the following to its ``<head>``::
  20
  21      <link rel="authorization_endpoint" href="http://indieauth-openid.example.org/" />
  22
  23
  24 Configuration
  25 =============
  26 A sqlite file ``data/tokens.sq3`` is created by indieauth-openid.
  27 To configure that path, copy ``config.php.dist`` to ``config.php`` and
  28 adjust it.
  29
  30 If you're using the ``.phar`` file, append ``.config.php`` to the full
  31 file name - e.g. ``indieauth-openid-0.1.0.phar.config.php``.
  32
  33
  34 ============
  35 Dependencies
  36 ============
  37
  38 * PHP 5.3+
  39 * PDO with sqlite3 driver
  40 * PEAR libraries:
  41
  42   * Net_URL2
  43   * OpenID
  44
  45
  46 Installation
  47 ============
  48 Install the dependencies::
  49
  50     $ pear install net_url2-2.2.1
  51     $ pear install openid-alpha
  52
  53
  54 =======
  55 License
  56 =======
  57 ``indieauth-openid`` is licensed under the `AGPL v3`__ or later.
  58
  59 __ http://www.gnu.org/licenses/agpl.html
  60
  61
  62 ======
  63 Author
  64 ======
  65 Written by Christian Weiske, cweiske@cweiske.de