X-Git-Url: https://git.cweiske.de/phorkie.git/blobdiff_plain/66170c339bbcd8b87e23c47daa11359a99e0d02d..a99373911922f7b1b5d42cf42d273bc7b0c61c61:/README.rst diff --git a/README.rst b/README.rst index 841b473..ca94cf2 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,14 @@ -************************************ -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. -Project page: http://sourceforge.net/p/phorkie/ +`Homepage `__ +| `Bug tracker `__ +| `Git repository `__ +· `GitHub mirror `__ +| `News `__ .. contents:: Table of Contents @@ -22,6 +26,7 @@ Features - 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 - option to edit single files in a multi-file paste - syntax highlighting with GeSHi @@ -41,6 +46,19 @@ Features - 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 `_ +for all released versions. ============ @@ -49,7 +67,7 @@ Installation .phar ===== -Download ``phorkie-0.4.0.phar`` and put it in your web server's document root +Download ``phorkie-0.8.1.phar`` and put it in your web server's document root directory. No further setup needed. @@ -58,17 +76,21 @@ No further setup needed. 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:: - $ tar xjvf phorkie-0.4.0.tar.bz2 + $ tar xjvf phorkie-0.8.1.tar.bz2 2. Create the git directories:: @@ -98,6 +120,10 @@ Zip package 7. Go to http://yourhost/ +8. If you like phorkie, send a mail to `cweiske+phorkie@cweiske.de`__ + +__ mailto:cweiske+phorkie@cweiske.de + Dependencies ============ @@ -108,6 +134,8 @@ on your machine: - Git v1.7.5 or later - PHP v5.3.0 or later + + - optionally the ``mbstring`` extension - PEAR v1.9.2 or later :: @@ -150,7 +178,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. +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/ +__ https://www.elastic.co/guide/en/elasticsearch/plugins/2.0/plugins-delete-by-query.html Setup @@ -296,25 +332,29 @@ URLs Index page. ``/[0-9]+`` Display page for paste -``/[0-9]/edit`` +``/[0-9]+/edit`` Edit the paste -``/[0-9]/edit/(.+)`` +``/[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]/tool/[a-zA-Z]+/(.+)`` +``/[0-9]+/tool/[a-zA-Z]+/(.+)`` 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 -``/[0-9]/delete`` +``/[0-9]+/delete`` Delete the paste -``/[0-9]/doap`` +``/[0-9]+/doap`` 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 -``/list(/[0-9])?`` +``/list(/[0-9]+)?`` List all pastes, with optional page ``/fork-remote`` Fork a remote URL @@ -355,11 +395,13 @@ 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]+)/edit/(.+)$ edit.php?id=$1&file=$2 + 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]+)/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 ^/fork-remote$ /fork-remote.php; @@ -379,3 +421,64 @@ If you use nginx, place the following lines into your ``server`` block: rewrite ^/setup$ /setup.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