X-Git-Url: https://git.cweiske.de/phorkie.git/blobdiff_plain/803bce967844c4ca5f53fd135e8415fec9cb5a1a..c1ab5bf5ad85fee72dca6c6cea3bffef3003a1cb:/README.rst

diff --git a/README.rst b/README.rst
index 18c0f88..1047243 100644
--- a/README.rst
+++ b/README.rst
@@ -4,7 +4,7 @@ phorkie - PHP and Git based pastebin
 Self-hosted pastebin software written in PHP.
 Pastes are editable, may have multiple files and are stored in git repositories.
 
-Homepage: http://sourceforge.net/p/phorkie/
+Project page: http://sourceforge.net/p/phorkie/
 
 .. contents:: Table of Contents
 
@@ -12,45 +12,117 @@ Homepage: http://sourceforge.net/p/phorkie/
 Features
 ========
 - every paste is a git repository
+
+  - repositories can be cloned
+  - clone url can be displayed
 - paste editing
 
   - add new files
   - delete existing files
+  - replace file with upload
 - multiple files in one paste
 - syntax highlighting with GeSHi
 - rST rendering
+- image upload + display
+- external tool support
+
+  - xmllint
+  - php syntax check
+- history in the sidebar
+
+  - old files can be downloaded easily
+- search across pastes: description, file names and file content
 
+  - options: quoting, logical and, or, not, partial words
 
+
+============
+Installation
 ============
+1. Unzip the phorkie release file::
+
+   $ tar xjvf phorkie-0.2.0.tar.bz2
+
+2. Create the git directories::
+
+   $ mkdir -p repos/git repos/work
+   $ chmod og+w repos/git repos/work
+
+3. Install dependencies_
+
+4. Copy ``data/config.php.dist`` to ``data/config.php`` and adjust it
+   to your needs::
+
+   $ cp data/config.php.dist data/config.php
+   $ $EDITOR data/config.php
+
+   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/``
+
+6. Open phorkie in your web browser
+
+
 Dependencies
 ============
 phorkie stands on the shoulders of giants.
 
-
-Install VersionControl_Git
-==========================
 ::
 
   $ pear install versioncontrol_git-alpha
+  $ pear install services_libravatar-alpha
+  $ pear install http_request2
+  $ pear install pager
+  $ pear install date_humandiff-alpha
 
-
-Install GeSHi
-=============
-::
+  $ pear channel-discover pear.twig-project.org
+  $ pear install twig/Twig
 
   $ pear channel-discover mediawiki.googlecode.com/svn
   $ pear install mediawiki/geshi
 
+  $ pear channel-discover zustellzentrum.cweiske.de
+  $ pear install zz/mime_type_plaindetect-alpha
+
 Note that this version of GeSHi is a bit outdated, but it's the fastest
 way to install it.
 
 
-Install Twig
-============
-::
+======
+Search
+======
 
-  $ pear channel-discover pear.twig-project.org
-  $ pear install twig/Twig
+phorkie makes use of an Elasticsearch__ installation if you have one.
+
+It is used to provide search capabilities and the list of recent pastes.
+
+__ http://www.elasticsearch.org/
+
+Setup
+=====
+Edit ``config.php``, setting the ``elasticsearch`` property to the HTTP URL
+of the index, e.g. ::
+
+  http://localhost:9200/phorkie/
+
+Run the index script to import all existing pastes into the index::
+
+  php scripts/index.php
+
+That's all. Open phorkie in your browser, and you'll notice the search box
+in the top menu.
+
+
+Reset
+=====
+In case something really went wrong and you need to reset the search
+index, run the following command::
+
+  $ curl -XDELETE http://localhost:9200/phorkie/
+  {"ok":true,"acknowledged"}
+
+Phorkie will automatically re-index everything when ``setupcheck`` is enabled
+in the configuration file.
 
 
 =====
@@ -82,15 +154,15 @@ Technical details
 
 TODO
 ====
-- search
 - OpenID-Login to get username+email as authorship information
-- sidebar: history
-- image upload
+- filters (``xmllint --format``, ``rapper``)
 - document how to keep disk usage low (block size)
 - comments
 - when 2 people edit, merge changes
 - diff changes
 - configurable highlights
+- Atom feed for new pastes
+- Atom feed for paste changes
 
 
 URLs
@@ -104,12 +176,18 @@ URLs
   Edit the paste
 ``/[0-9]+/raw/(.+)``
   Display raw file contents
+``/[0-9]/tool/[a-zA-Z]+/(.+)``
+  Run a tool on the given file
+``/[0-9]/rev/[a-z0-9]+``
+  Show specific revision of the paste
 ``/[0-9]/delete``
   Delete the paste
-``/search(/.+)?``
-  Search for term
+``/[0-9]/fork``
+  Create a fork of the paste
+``/search?q=..(&page=[0-9]+)?``
+  Search for term, with optional page
 ``/list(/[0-9])?``
-  List all pastes
+  List all pastes, with optional page
 
 
 Internal directory layout
@@ -117,16 +195,34 @@ Internal directory layout
 ::
 
   repos/
-    1/ - git repository for paste #1
-      .git/
+    work/
+      1/ - work directory for paste #1
+      2/ - work directory for paste #2
+    git/
+      1.git/ - git repository for paste #1
         description - Description for the repository
-    2/ - git repository for paste #2
-
-
-Search
-======
-Use ``ack-grep``
-
+      2.git/ - git repository for paste #2
 
+nginx rewrites
+==============
+If you use nginx, place the following lines into your ``server`` block:
 
+::
 
+  if (!-e $request_uri) {
+    rewrite ^/([0-9]+)$ /display.php?id=$1;
+    rewrite ^/([0-9]+)/delete$ /delete.php?id=$1;
+    rewrite ^/([0-9]+)/delete/confirm$ /delete.php?id=$1&confirm=1;
+    rewrite ^/([0-9]+)/edit$ /edit.php?id=$1;
+    rewrite ^/([0-9]+)/fork$ /fork.php?id=$1;
+    rewrite ^/([0-9]+)/raw/(.+)$ /raw.php?id=$1&file=$2;
+    rewrite ^/([0-9]+)/rev/(.+)$ /revision.php?id=$1&rev=$2;
+    rewrite ^/([0-9]+)/rev-raw/(.+)$ /raw.php?id=$1&rev=$2&file=$3;
+    rewrite ^/([0-9]+)/tool/([^/]+)/(.+)$ /tool.php?id=$1&tool=$2&file=$3;
+
+    rewrite ^/list$ /list.php;
+    rewrite ^/list/([0-9]+)$ /list.php?page=$1;
+
+    rewrite ^/search$ /search.php;
+    rewrite ^/search/([0-9]+)$ /search.php?page=$1;
+  }