X-Git-Url: https://git.cweiske.de/phorkie.git/blobdiff_plain/49a42cb5ac2e29668d2ac584e1a84d9818b047ea..a99373911922f7b1b5d42cf42d273bc7b0c61c61:/README.rst diff --git a/README.rst b/README.rst index 53293cb..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 @@ -42,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. ============ @@ -50,7 +67,7 @@ Installation .phar ===== -Download ``phorkie-0.6.1.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. @@ -59,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.6.1.tar.bz2 + $ tar xjvf phorkie-0.8.1.tar.bz2 2. Create the git directories:: @@ -113,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 :: @@ -455,6 +478,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