Make it possible to run indieauth-openid as .phar

[indieauth-openid.git] / README.rst

diff --git a/README.rst b/README.rst
index bd7637cd387350171edddffef169315bb41c4ceb..ba0a4ec1837cf93261bee7fe3319af5e82db0f5b 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -11,6 +11,7 @@ __ http://openid.net/
 Setup
 =====
 
 Setup
 =====
 

+0. Install dependencies

 1. Setup your webserver: make ``www/`` the root (document) directory of the
    new virtual host
 2. Make ``data/`` world-writable (or at least writable by the web server)
 1. Setup your webserver: make ``www/`` the root (document) directory of the
    new virtual host
 2. Make ``data/`` world-writable (or at least writable by the web server)


@@ -20,6 +21,16 @@ Setup
      <link rel="authorization_endpoint" href="http://indieauth-openid.example.org/" />
 
 
      <link rel="authorization_endpoint" href="http://indieauth-openid.example.org/" />
 
 

+Configuration
+=============
+A sqlite file ``data/tokens.sq3`` is created by indieauth-openid.
+To configure that path, copy ``config.php.dist`` to ``config.php`` and
+adjust it.
+
+If you're using the ``.phar`` file, append ``.config.php`` to the full
+file name - e.g. ``indieauth-openid-0.1.0.phar.config.php``.
+
+

 ============
 Dependencies
 ============
 ============
 Dependencies
 ============


@@ -32,6 +43,14 @@ Dependencies
   * OpenID
 
 
   * OpenID
 
 

+Installation
+============
+Install the dependencies::
+
+    $ pear install net_url2-2.2.1
+    $ pear install openid-alpha
+
+

 =======
 License
 =======
 =======
 License
 =======