X-Git-Url: https://git.cweiske.de/phorkie.git/blobdiff_plain/f81da3d3904a5031521b2c080704a381f7dd0c56..04e78a7eb3d992ff8af4b472144c339dca956911:/README.rst diff --git a/README.rst b/README.rst index 422306c..1a96ad1 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 @@ -45,13 +49,25 @@ Features - 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. + + ============ Installation ============ .phar ===== -Download ``phorkie-0.7.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. @@ -74,7 +90,7 @@ Zip package =========== 1. Unzip the phorkie release file:: - $ tar xjvf phorkie-0.7.0.tar.bz2 + $ tar xjvf phorkie-0.8.1.tar.bz2 2. Create the git directories:: @@ -117,39 +133,14 @@ It requires the following programs to be installed 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 - -:: - - $ pear install versioncontrol_git-alpha - $ pear install services_libravatar-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.geshi.org - $ pear install geshi/geshi - - $ pear channel-discover zustellzentrum.cweiske.de - $ pear install zz/mime_type_plaindetect-alpha - - $ pear channel-discover pear.michelf.ca - $ pear install michelf/Markdown - - $ pear channel-discover pear2.php.net - $ pear install pear2/pear2_services_linkback-alpha +- PHP v8.0.0 or later + - with the ``mbstring`` extension +- A dozen of libraries -You can use composer to install all dependencies automatically:: +Use composer to install all dependencies:: - $ composer install + $ composer install --no-dev Note that the ``.phar`` package already contains all dependencies. @@ -385,7 +376,7 @@ If you use nginx, place the following lines into your ``server`` block: 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; @@ -423,7 +414,7 @@ Lighttpd rewrites "^/([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]+)/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", @@ -462,6 +453,7 @@ Releasing a new version $ phing phar #. Test. #. Tag the release in git -#. Upload release to sourceforge:: +#. Run the script to update the homepage - $ phing deploy-sf + $ cd /home/cweiske/Dev/html/cweiske.de + $ ./scripts/update-phorkie.sh