X-Git-Url: https://git.cweiske.de/phorkie.git/blobdiff_plain/6c0d5be1b6ec69257b09b97ddfe0405eabe92459..a1e6e4c154727f30aaa2e406eb5afb3810d4b398:/README.rst diff --git a/README.rst b/README.rst index e7e1625..eb86a1a 100644 --- a/README.rst +++ b/README.rst @@ -15,16 +15,20 @@ Features - repositories can be cloned - clone url can be displayed + - remote pastes can be forked (rel="vcs-git" and gist.github.com) + - single click forking of forks on different servers to your own - paste editing - add new files - delete existing files - replace file with upload -- OpenID authentication +- 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 - rST and Markdown rendering - image upload + display +- OpenID authentication - external tool support - xmllint @@ -35,19 +39,42 @@ Features - search across pastes: description, file names and file content - options: quoting, logical and, or, not, partial words +- 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 ============ Installation ============ + +.phar +===== +Download ``phorkie-0.5.0.phar`` and put it in your web server's document root +directory. + +No further setup needed. + +.. note:: Only valid if your webserver is configured to let + PHP handle ``.phar`` files. + + Unfortunately, no Linux distribution has this activated by default. + +.. warning:: PHP has some bugs in its .phar handling code (e.g. with FPM). + + So currently, the ``.phar`` option is considered experimental. + + +Zip package +=========== 1. Unzip the phorkie release file:: - $ tar xjvf phorkie-0.3.0.tar.bz2 + $ tar xjvf phorkie-0.5.0.tar.bz2 2. Create the git directories:: - $ mkdir -p repos/git repos/work - $ chmod og+w repos/git repos/work + $ mkdir -p www/repos/git www/repos/work + $ chmod og+w www/repos/git www/repos/work 3. Install dependencies_ @@ -60,17 +87,33 @@ Installation Look at ``config.default.php`` for values that you may adjust. 5. Set your web server's document root to ``/path/to/phorkie/www/`` + Alternatively, you can add a symlink to the ``www`` folder into your + web server's existing document root tree (being careful to keep + main phorkie folder outside the document root for security purposes) + and ensure you set the ``baseurl`` config option appropriately. You + must also set the ``RewriteBase`` in the ``.htaccess`` file or adjust + the nginx configuration accordingly. + +6. Open http://yourhost/setup in your web browser to see if everything + is working fine. -6. Open phorkie in your web browser +7. Go to http://yourhost/ + +8. If you like phorkie, send a mail to `cweiske+phorkie@cweiske.de`__ + +__ mailto:cweiske+phorkie@cweiske.de Dependencies ============ phorkie stands on the shoulders of giants. -- git v1.7.5 -- php v5.3.0 -- pear v1.9.2 +It requires the following programs to be installed +on your machine: + +- Git v1.7.5 or later +- PHP v5.3.0 or later +- PEAR v1.9.2 or later :: @@ -79,22 +122,30 @@ phorkie stands on the shoulders of giants. $ 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 mediawiki.googlecode.com/svn - $ pear install mediawiki/geshi + $ 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 - -Note that this version of GeSHi is a bit outdated, but it's the fastest -way to install it. If you install it manually be sure to update the -path in ``data/config.default.php``. + + $ pear channel-discover pear2.php.net + $ pear install pear2/pear2_services_linkback-alpha + + +You can use composer to install all dependencies automatically:: + + $ composer install + +Note that the ``.phar`` package already contains all dependencies. + ====== Search @@ -104,8 +155,11 @@ 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 1.3 is supported. + __ http://www.elasticsearch.org/ + Setup ===== Edit ``config.php``, setting the ``elasticsearch`` property to the HTTP URL @@ -113,6 +167,7 @@ of the index, e.g. :: http://localhost:9200/phorkie/ +You must use a search namespace with Elasticsearch such as ``phorkie/``. Run the index script to import all existing pastes into the index:: php scripts/index.php @@ -132,6 +187,10 @@ index, run the following command:: Phorkie will automatically re-index everything when ``setupcheck`` is enabled in the configuration file. +You may also manually run the reindexing script with:: + + $ php scripts/index.php + ===== HowTo @@ -139,8 +198,19 @@ HowTo Make git repositories clonable ============================== -To make git repositories clonable, you need to install ``git-daemon`` -(``git-daemon-run`` package on Debian/Ubuntu). + +HTTP +---- +By default, the pastes are clonable via ``http`` as long as the ``repos/git/`` +directory is within the ``www/`` directory. + +No further setup needed. + + +git-daemon +---------- +You may use ``git-daemon`` to provide public ``git://`` clone urls. +Install the ``git-daemon-run`` package on Debian/Ubuntu. Make the repositories available by symlinking the paste repository directory (``$GLOBALS['phorkie']['cfg']['repos']`` setting) into @@ -152,37 +222,79 @@ Edit your ``config.php`` and set the ``$GLOBALS['phorkie']['cfg']['git']['public setting to ``git://$yourhostname/git/paste/``. The rest will be appended automatically. + You're on your own to setup writable repositories. + Protect your site with OpenID ============================= You have the option of enabling OpenID authentication to help secure your -pastes on phorkie. Set the ``$GLOBALS['phorkie']['auth']`` values in the -``data/config.php`` file as desired. - -There are two different types of security you can apply. First, you can -restrict to one of three ``securityLevels``; completely open (``0``), protection -of write-enabled functions such as add, edit, etc. (``1``), and full site -protection (``2``). Additionally, you can restrict your site to ``listedUsersOnly``. -You will need to add the individual OpenIDs identity urls to the +pastes on phorkie. +Set the ``$GLOBALS['phorkie']['auth']`` values in the +``data/config.php`` file as desired. + +There are two different types of security you can apply. +First, you can restrict to one of three ``securityLevels``: + +- completely open (``0``) +- protection of write-enabled functions such as add, edit, etc. (``1``) +- full site protection (``2``) + +Additionally, you can restrict your site to ``listedUsersOnly``. +You will need to add the individual OpenID urls to the ``$GLOBALS['phorkie']['auth']['users']`` variable. +Get information about paste editors +=================================== +Phorkie stores the user's OpenID or IP address (when not logged in) when +a paste is edited. +It is possible to get this information for each single commit:: + + // IP / OpenID for the latest commit + $ git notes --ref=identity show + 127.0.0.1 + + // show IP / OpenID for a given commit + $ git notes --ref=identity show 29f82a + http://cweiske.de/ + + +Notifications via webhooks +========================== +Depending on how you use phorkie, it might be nice to notify some other service +when pastes are added or updated. +Phorkie contains a simply mechanism to post data to a given URL which +you can then use as needed. + +The data are json-encoded POSTed to the URLs contained in the +``$GLOBALS['phorkie']['cfg']['webhooks']`` setting array, with +a MIME type of ``application/vnd.phorkie.webhook+json``:: + + { + 'event': 'create', + 'author': { + 'name':'Anonymous', + 'email': 'anonymous@phorkie', + }, + 'repository': { + 'name': 'webhooktest', + 'url': 'http://example.org/33', + 'description': 'webhooktest', + 'owner': { + 'name': 'Anonymous', + 'email': 'anonymous@phorkie', + } + } + } + +The event may be ``create``, ``edit`` or ``delete``. + + ================= Technical details ================= -TODO -==== -- filters (``xmllint --format``, ``rapper``) -- document how to keep disk usage low (block size) -- comments -- when 2 people edit, merge changes -- diff changes -- configurable highlights -- Atom feed for new pastes -- Atom feed for paste changes - URLs ==== @@ -191,28 +303,40 @@ URLs Index page. ``/[0-9]+`` Display page for paste -``/[0-9]/edit`` +``/[0-9]+/edit`` Edit the paste +``/[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 +``/help`` + Show help page ``/new`` Shows form for new paste ``/login`` Login page for protecting site +``/setup`` + Check if everything is setup correctly and all dependencies are installed ``/user`` Edit logged-in user information @@ -242,13 +366,22 @@ 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]+)/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; + rewrite ^/help$ /help.php; rewrite ^/new$ /new.php; + + rewrite ^/feed/new$ /feed-new.php; + rewrite ^/feed/updated$ /feed-updated.php; + rewrite ^/list$ /list.php; rewrite ^/list/([0-9]+)$ /list.php?page=$1; @@ -256,5 +389,44 @@ If you use nginx, place the following lines into your ``server`` block: rewrite ^/search/([0-9]+)$ /search.php?page=$1; rewrite ^/login$ /login.php; + 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" + )