X-Git-Url: https://git.cweiske.de/phorkie.git/blobdiff_plain/78215a8279ecc048bd6bbb6a4977ee58766928b6..452e1b3912216facc7aa5f21627affac66cd35fb:/README.rst diff --git a/README.rst b/README.rst index fc97dd7..6916a35 100644 --- a/README.rst +++ b/README.rst @@ -22,7 +22,7 @@ Features - add new files - delete existing files - replace file with upload -- embedding of pastes in your blog via oEmbed +- 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 @@ -50,7 +50,7 @@ Installation .phar ===== -Download ``phorkie-0.5.0.phar`` and put it in your web server's document root +Download ``phorkie-0.6.1.phar`` and put it in your web server's document root directory. No further setup needed. @@ -69,7 +69,7 @@ Zip package =========== 1. Unzip the phorkie release file:: - $ tar xjvf phorkie-0.5.0.tar.bz2 + $ tar xjvf phorkie-0.6.1.tar.bz2 2. Create the git directories:: @@ -99,6 +99,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 ============ @@ -362,13 +366,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]+)/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; @@ -388,3 +392,63 @@ 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 +#. Upload release to sourceforge:: + + $ phing deploy-sf