Move off sourceforge

[phorkie.git] / README.rst

diff --git a/README.rst b/README.rst
index 255de2a7e3cbdd196fa4bc65f7f9d9693c39582e..391db6b5e6739422f6f8eee5a9df7fe510da5db7 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,10 +1,13 @@
-************************************
-phorkie - PHP and Git based pastebin
-************************************
+****************************
+phorkie - Git based pastebin
+****************************

 Self-hosted pastebin software written in PHP.
 Pastes are editable, may have multiple files and are stored in git repositories.
 
 Self-hosted pastebin software written in PHP.
 Pastes are editable, may have multiple files and are stored in git repositories.
 

-Project page: http://sourceforge.net/p/phorkie/
+`Homepage <https://cweiske.de/phorkie.htm>`__
+| `Bug tracker <https://github.com/cweiske/phorkie/issues>`__
+| `Git repository <https://git.cweiske.de/phorkie.git>`__
+· `GitHub mirror <https://github.com/cweiske/phorkie/>`__

 
 .. contents:: Table of Contents
 
 
 .. contents:: Table of Contents
 


@@ -16,12 +19,15 @@ Features
   - repositories can be cloned
   - clone url can be displayed
   - remote pastes can be forked (rel="vcs-git" and gist.github.com)
   - repositories can be cloned
   - clone url can be displayed
   - remote pastes can be forked (rel="vcs-git" and gist.github.com)

+  - single click forking of forks on different servers to your own

 - paste editing
 
   - add new files
   - delete existing files
   - replace file with upload
 - paste editing
 
   - add new files
   - delete existing files
   - replace file with upload

+- embedding of pastes in your blog (via JavaScript or oEmbed)

 - multiple files in one paste
 - multiple files in one paste

+  - option to edit single files in a multi-file paste

 - syntax highlighting with GeSHi
 - rST and Markdown rendering
 - image upload + display
 - syntax highlighting with GeSHi
 - rST and Markdown rendering
 - image upload + display


@@ -36,19 +42,59 @@ Features
 - search across pastes: description, file names and file content
 
   - options: quoting, logical and, or, not, partial words
 - search across pastes: description, file names and file content
 
   - options: quoting, logical and, or, not, partial words

+- webhook support - get notified when pastes are created, edited or deleted
+- atom feed for new and updated pastes
+- notifies remote instances via linkbacks when a paste has been forked
+- text file detection for unknown file types
+
+
+========
+Download
+========
+phorkie is released as self-contained ``.phar`` file that includes
+all dependencies, as well as a normal zip file.
+
+.. LATESTRELEASE
+
+See `phorkie downloads page <http://cweiske.de/phorkie-download.htm>`_
+for all released versions.

 
 
 ============
 Installation
 ============
 
 
 ============
 Installation
 ============

+
+.phar
+=====
+Download ``phorkie-0.7.0.phar`` and put it in your web server's document root
+directory.
+
+No further setup needed.
+
+.. note:: Only valid if your webserver is configured to let
+   PHP handle ``.phar`` files.
+
+   Unfortunately, no Linux distribution has this activated by default.
+   You can do it yourself, though - see
+   `Enable .phar handling in your web server`__.
+
+.. warning:: PHP has some bugs in its .phar handling code (e.g. with FPM).
+
+   So currently, the ``.phar`` option is considered experimental.
+
+__ http://cweiske.de/tagebuch/phar-webserver.htm
+
+
+Zip package
+===========

 1. Unzip the phorkie release file::
 
 1. Unzip the phorkie release file::
 

-   $ tar xjvf phorkie-0.3.0.tar.bz2
+   $ tar xjvf phorkie-0.7.0.tar.bz2

 
 2. Create the git directories::
 
 
 2. Create the git directories::
 

-   $ mkdir -p repos/git repos/work
-   $ chmod og+w repos/git repos/work
+   $ mkdir -p www/repos/git www/repos/work
+   $ chmod og+w www/repos/git www/repos/work

 
 3. Install dependencies_
 
 
 3. Install dependencies_
 


@@ -61,8 +107,21 @@ Installation
    Look at ``config.default.php`` for values that you may adjust.
 
 5. Set your web server's document root to ``/path/to/phorkie/www/``
    Look at ``config.default.php`` for values that you may adjust.
 
 5. Set your web server's document root to ``/path/to/phorkie/www/``

+   Alternatively, you can add a symlink to the ``www`` folder into your
+   web server's existing document root tree (being careful to keep
+   main phorkie folder outside the document root for security purposes)
+   and ensure you set the ``baseurl`` config option appropriately. You
+   must also set the ``RewriteBase`` in the ``.htaccess`` file or adjust
+   the nginx configuration accordingly.
+
+6. Open http://yourhost/setup in your web browser to see if everything
+   is working fine.

 
 

-6. Open phorkie in your web browser
+7. Go to http://yourhost/
+
+8. If you like phorkie, send a mail to `cweiske+phorkie@cweiske.de`__
+
+__ mailto:cweiske+phorkie@cweiske.de

 
 
 Dependencies
 
 
 Dependencies


@@ -74,6 +133,8 @@ on your machine:
 
 - Git v1.7.5 or later
 - PHP v5.3.0 or later
 
 - Git v1.7.5 or later
 - PHP v5.3.0 or later

+
+  - optionally the ``mbstring`` extension

 - PEAR v1.9.2 or later
 
 ::
 - PEAR v1.9.2 or later
 
 ::


@@ -83,12 +144,13 @@ on your machine:
   $ pear install http_request2
   $ pear install pager
   $ pear install date_humandiff-alpha
   $ pear install http_request2
   $ pear install pager
   $ pear install date_humandiff-alpha

+  $ pear install openid-alpha

 
   $ pear channel-discover pear.twig-project.org
   $ pear install twig/Twig
 
 
   $ 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 pear.geshi.org
+  $ pear install geshi/geshi

 
   $ pear channel-discover zustellzentrum.cweiske.de
   $ pear install zz/mime_type_plaindetect-alpha
 
   $ pear channel-discover zustellzentrum.cweiske.de
   $ pear install zz/mime_type_plaindetect-alpha


@@ -96,10 +158,15 @@ on your machine:
   $ pear channel-discover pear.michelf.ca
   $ pear install michelf/Markdown
 
   $ 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.
-If you install it manually be sure to update the
-path from ``data/config.default.php``.
+  $ pear channel-discover pear2.php.net
+  $ pear install pear2/pear2_services_linkback-alpha
+
+
+You can use composer to install all dependencies automatically::
+
+  $ composer install
+
+Note that the ``.phar`` package already contains all dependencies.

 
 
 ======
 
 
 ======


@@ -110,7 +177,15 @@ phorkie makes use of an Elasticsearch__ installation, if you have one.
 
 It is used to provide search capabilities and the list of recent pastes.
 
 
 It is used to provide search capabilities and the list of recent pastes.
 

+Elasticsearch version 2.0 is supported.
+
+You have to install the `delete-by-query`__ plugin::
+
+    $ cd /usr/share/elasticsearch
+    $ bin/plugin install delete-by-query
+

 __ http://www.elasticsearch.org/
 __ http://www.elasticsearch.org/

+__ https://www.elastic.co/guide/en/elasticsearch/plugins/2.0/plugins-delete-by-query.html

 
 
 Setup
 
 
 Setup


@@ -151,8 +226,19 @@ HowTo
 
 Make git repositories clonable
 ==============================
 
 Make git repositories clonable
 ==============================

-To make git repositories clonable, you need to install ``git-daemon``
-(``git-daemon-run`` package on Debian/Ubuntu).
+
+HTTP
+----
+By default, the pastes are clonable via ``http`` as long as the ``repos/git/``
+directory is within the ``www/`` directory.
+
+No further setup needed.
+
+
+git-daemon
+----------
+You may use ``git-daemon`` to provide public ``git://`` clone urls.
+Install the ``git-daemon-run`` package on Debian/Ubuntu.

 
 Make the repositories available by symlinking the paste repository
 directory (``$GLOBALS['phorkie']['cfg']['repos']`` setting) into
 
 Make the repositories available by symlinking the paste repository
 directory (``$GLOBALS['phorkie']['cfg']['repos']`` setting) into


@@ -202,21 +288,41 @@ It is possible to get this information for each single commit::
     http://cweiske.de/
 
 
     http://cweiske.de/
 
 

+Notifications via webhooks
+==========================
+Depending on how you use phorkie, it might be nice to notify some other service
+when pastes are added or updated.
+Phorkie contains a simply mechanism to post data to a given URL which
+you can then use as needed.
+
+The data are json-encoded POSTed to the URLs contained in the
+``$GLOBALS['phorkie']['cfg']['webhooks']`` setting array, with
+a MIME type of ``application/vnd.phorkie.webhook+json``::
+
+  {
+      'event': 'create',
+      'author': {
+          'name':'Anonymous',
+          'email': 'anonymous@phorkie',
+      },
+      'repository': {
+          'name': 'webhooktest',
+          'url': 'http://example.org/33',
+          'description': 'webhooktest',
+          'owner': {
+              'name': 'Anonymous',
+              'email': 'anonymous@phorkie',
+          }
+      }
+  }
+
+The event may be ``create``, ``edit`` or ``delete``.
+
+

 =================
 Technical details
 =================
 
 =================
 Technical details
 =================
 

-TODO
-====
-- 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
 ====
 
 URLs
 ====


@@ -225,28 +331,40 @@ URLs
   Index page.
 ``/[0-9]+``
   Display page for paste
   Index page.
 ``/[0-9]+``
   Display page for paste

-``/[0-9]/edit``
+``/[0-9]+/edit``

   Edit the paste
   Edit the paste

+``/[0-9]+/edit/(.+)``
+  Edit a single file of the paste
+``/[0-9]+/embed``
+  JavaScript code that embeds the whole paste in a HTML page
+``/[0-9]+/embed/(.+)``
+  JavaScript code that embeds a single file in a HTML page

 ``/[0-9]+/raw/(.+)``
   Display raw file contents
 ``/[0-9]+/raw/(.+)``
   Display raw file contents

-``/[0-9]/tool/[a-zA-Z]+/(.+)``
+``/[0-9]+/tool/[a-zA-Z]+/(.+)``

   Run a tool on the given file
   Run a tool on the given file

-``/[0-9]/rev/[a-z0-9]+``
+``/[0-9]+/rev/[a-z0-9]+``

   Show specific revision of the paste
   Show specific revision of the paste

-``/[0-9]/delete``
+``/[0-9]+/delete``

   Delete the paste
   Delete the paste

-``/[0-9]/doap``
+``/[0-9]+/doap``

   Show DOAP document for paste
   Show DOAP document for paste

-``/[0-9]/fork``
+``/[0-9]+/fork``

   Create a fork of the paste
 ``/search?q=..(&page=[0-9]+)?``
   Search for term, with optional page
   Create a fork of the paste
 ``/search?q=..(&page=[0-9]+)?``
   Search for term, with optional page

-``/list(/[0-9])?``
+``/list(/[0-9]+)?``

   List all pastes, with optional page
   List all pastes, with optional page

+``/fork-remote``
+  Fork a remote URL
+``/help``
+  Show help page

 ``/new``
   Shows form for new paste
 ``/login``
   Login page for protecting site
 ``/new``
   Shows form for new paste
 ``/login``
   Login page for protecting site

+``/setup``
+  Check if everything is setup correctly and all dependencies are installed

 ``/user``
   Edit logged-in user information
 
 ``/user``
   Edit logged-in user information
 


@@ -276,14 +394,22 @@ If you use nginx, place the following lines into your ``server`` block:
     rewrite ^/([0-9]+)/delete/confirm$ /delete.php?id=$1&confirm=1;
     rewrite ^/([0-9]+)/doap$ /doap.php?id=$1;
     rewrite ^/([0-9]+)/edit$ /edit.php?id=$1;
     rewrite ^/([0-9]+)/delete/confirm$ /delete.php?id=$1&confirm=1;
     rewrite ^/([0-9]+)/doap$ /doap.php?id=$1;
     rewrite ^/([0-9]+)/edit$ /edit.php?id=$1;

+    rewrite ^/([0-9]+)/edit/(.+)$ /edit.php?id=$1&file=$2;
+    rewrite ^/([0-9]+)/embed$ /embed.php?id=$1;
+    rewrite ^/([0-9]+)/embed/(.+)$ /embed.php?id=$1&file=$2;

     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]+)/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]+)/rev-raw/(.+)/(.+)$ /raw.php?id=$1&rev=$2&file=$3;

     rewrite ^/([0-9]+)/tool/([^/]+)/(.+)$ /tool.php?id=$1&tool=$2&file=$3;
 
     rewrite ^/([0-9]+)/tool/([^/]+)/(.+)$ /tool.php?id=$1&tool=$2&file=$3;
 

+    rewrite ^/fork-remote$ /fork-remote.php;
+    rewrite ^/help$ /help.php;

     rewrite ^/new$ /new.php;
     rewrite ^/new$ /new.php;

+

     rewrite ^/feed/new$ /feed-new.php;
     rewrite ^/feed/new$ /feed-new.php;

+    rewrite ^/feed/updated$ /feed-updated.php;
+

     rewrite ^/list$ /list.php;
     rewrite ^/list/([0-9]+)$ /list.php?page=$1;
 
     rewrite ^/list$ /list.php;
     rewrite ^/list/([0-9]+)$ /list.php?page=$1;
 


@@ -291,5 +417,67 @@ If you use nginx, place the following lines into your ``server`` block:
     rewrite ^/search/([0-9]+)$ /search.php?page=$1;
 
     rewrite ^/login$ /login.php;
     rewrite ^/search/([0-9]+)$ /search.php?page=$1;
 
     rewrite ^/login$ /login.php;

+    rewrite ^/setup$ /setup.php;

     rewrite ^/user$ /user.php;
   }
     rewrite ^/user$ /user.php;
   }

+
+Lighttpd rewrites
+=================
+
+::
+
+    url.rewrite-once += (
+        "^/([0-9]+)$" => "/display.php?id=$1",
+        "^/([0-9]+)/delete$" => "/delete.php?id=$1",
+        "^/([0-9]+)/delete/confirm" => "/delete.php?&id=$1&confirm=1",
+        "^/([0-9]+)/doap$" => "/doap.php?id=$1",
+        "^/([0-9]+)/edit$" => "/edit.php?id=$1",
+        "^/([0-9]+)/edit/(.+)" => "/edit.php?id=$1&file=$2",
+        "^/([0-9]+)/embed$" => "/embed.php?id=$1",
+        "^/([0-9]+)/embed/(.+)$" => "/embed.php?id=$1",
+        "^/([0-9]+)/fork$" => "/fork.php?id=$1",
+        "^/([0-9]+)/raw/(.+)$" => "/raw.php?id=$1&file=$2",
+        "^/([0-9]+)/rev/(.+)$" => "/revision.php?id=$1&rev=$2",
+        "^/([0-9]+)/rev-raw/(.+)/(.+)$" => "/raw.php?id=$1&rev=$2&file=$3",
+        "^/([0-9]+)/tool/([^/]+)/(.+)$" => "/tool.php?id=$1&tool=$2&file=$3",
+
+        "^/fork-remote$" => "/fork-remote.php",
+        "^/help$" => "/help.php",
+        "^/new$" => "/new.php",
+
+        "^/feed/new$" => "/feed-new.php",
+        "^/feed/updated$" => "/feed-updated.php",
+
+        "^/list$" => "/list.php",
+        "^/list/([0-9]+)$" => "/list.php?page=$1",
+
+        "^/search$" => "/search.php",
+        "^/search/([0-9]+)$" => "/search.php?page=$1",
+
+        "^/login$" => "/login.php",
+        "^/setup$" => "/setup.php",
+        "^/user$" => "/user.php"
+    )
+
+
+===========
+Development
+===========
+
+Releasing a new version
+=======================
+
+#. Update ``ChangeLog``, ``NEWS.rst``, ``build.xml`` and ``README.rst``.
+#. Update local dependencies::
+
+    $ phing collectdeps
+#. Build ``.tar.bz2`` and ``.phar`` release files with::
+
+    $ phing zip
+    $ phing phar
+#. Test.
+#. Tag the release in git
+#. Run the script to update the homepage
+
+    $ cd /home/cweiske/Dev/html/cweiske.de
+    $ ./scripts/update-phorkie.sh