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
============
+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.
$ pear install services_libravatar-alpha
$ pear install http_request2
$ pear install pager
- $ pear install https://github.com/downloads/cweiske/Date_HumanDiff/Date_HumanDiff-0.1.0.tgz
+ $ pear install date_humandiff-alpha
$ 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.
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.
+
+
=====
HowTo
=====
====
``/``
- Index page. Shows form for new paste
+ Index page.
``/[0-9]+``
Display page for paste
``/[0-9]/edit``
Search for term, with optional page
``/list(/[0-9])?``
List all pastes, with optional page
+``/new``
+ Shows form for new paste
+``/login``
+ Login page for protecting site
+``/user``
+ Edit logged-in user information
Internal directory layout
description - Description for the repository
2.git/ - git repository for paste #2
+nginx rewrites
+==============
+If you use nginx, place the following lines into your ``server`` block:
-Search
-======
-Use ``ack-grep``
-
-
-
+::
+ 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 ^/new$ /new.php;
+ rewrite ^/list$ /list.php;
+ rewrite ^/list/([0-9]+)$ /list.php?page=$1;
+
+ rewrite ^/search$ /search.php;
+ rewrite ^/search/([0-9]+)$ /search.php?page=$1;
+
+ rewrite ^/login$ /login.php;
+ rewrite ^/user$ /user.php;
+ }