Cleaned up files for 0.3 milestone.

[phorkie.git] / README.rst

diff --git a/README.rst b/README.rst
index d41d89bf61f9f5e9e7878d50802b1405473adf3f..e7e1625b6a3685421e3143078606c939999ed554 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -20,9 +20,10 @@ Features
   - add new files
   - delete existing files
   - replace file with upload
+- OpenID authentication
 - multiple files in one paste
 - syntax highlighting with GeSHi
-- rST rendering
+- rST and Markdown rendering
 - image upload + display
 - external tool support
 
@@ -41,7 +42,7 @@ Installation
 ============
 1. Unzip the phorkie release file::
 
-   $ tar xjvf phorkie-0.2.0.tar.bz2
+   $ tar xjvf phorkie-0.3.0.tar.bz2
 
 2. Create the git directories::
 
@@ -58,7 +59,7 @@ Installation
 
    Look at ``config.default.php`` for values that you may adjust.
 
-5. Set your web server's document root to ``/path/to/phorkie-0.2.0/www/``
+5. Set your web server's document root to ``/path/to/phorkie/www/``
 
 6. Open phorkie in your web browser
 
@@ -67,6 +68,10 @@ Dependencies
 ============
 phorkie stands on the shoulders of giants.
 
+- git v1.7.5
+- php v5.3.0
+- pear v1.9.2
+
 ::
 
   $ pear install versioncontrol_git-alpha
@@ -86,16 +91,16 @@ phorkie stands on the shoulders of giants.
 
   $ pear channel-discover pear.michelf.ca
   $ pear install michelf/Markdown
-
+  
 Note that this version of GeSHi is a bit outdated, but it's the fastest
-way to install it.
-
+way to install it.  If you install it manually be sure to update the
+path in ``data/config.default.php``.
 
 ======
 Search
 ======
 
-phorkie makes use of an Elasticsearch__ installation if you have one.
+phorkie makes use of an Elasticsearch__ installation, if you have one.
 
 It is used to provide search capabilities and the list of recent pastes.
 
@@ -137,7 +142,7 @@ Make git repositories clonable
 To make git repositories clonable, you need to install ``git-daemon``
 (``git-daemon-run`` package on Debian/Ubuntu).
 
-Now make the repositories available by symlinking the paste repository
+Make the repositories available by symlinking the paste repository
 directory (``$GLOBALS['phorkie']['cfg']['repos']`` setting) into
 ``/var/cache/git``, e.g.::
 
@@ -147,9 +152,21 @@ Edit your ``config.php`` and set the ``$GLOBALS['phorkie']['cfg']['git']['public
 setting to ``git://$yourhostname/git/paste/``.
 The rest will be appended automatically.
 
-
 You're on your own to setup writable repositories.
 
+Protect your site with OpenID
+=============================
+You have the option of enabling OpenID authentication to help secure your
+pastes on phorkie.  Set the ``$GLOBALS['phorkie']['auth']`` values in the
+``data/config.php`` file as desired.  
+
+There are two different types of security you can apply.  First, you can
+restrict to one of three ``securityLevels``; completely open (``0``), protection
+of write-enabled functions such as add, edit, etc. (``1``), and full site
+protection (``2``).  Additionally, you can restrict your site to ``listedUsersOnly``.
+You will need to add the individual OpenIDs identity urls to the
+``$GLOBALS['phorkie']['auth']['users']`` variable.
+
 
 =================
 Technical details
@@ -157,7 +174,6 @@ Technical details
 
 TODO
 ====
-- OpenID-Login to get username+email as authorship information
 - filters (``xmllint --format``, ``rapper``)
 - document how to keep disk usage low (block size)
 - comments