- repositories can be cloned
- clone url can be displayed
+ - remote pastes can be forked (rel="vcs-git" and gist.github.com)
- paste editing
- add new files
- replace file with upload
- multiple files in one paste
- syntax highlighting with GeSHi
-- rST rendering
+- rST and Markdown rendering
- image upload + display
+- OpenID authentication
- external tool support
- xmllint
- 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
============
============
1. Unzip the phorkie release file::
- $ tar xjvf phorkie-0.2.0.tar.bz2
+ $ tar xjvf phorkie-0.3.0.tar.bz2
2. Create the git directories::
Look at ``config.default.php`` for values that you may adjust.
-5. Set your web server's document root to ``/path/to/phorkie-0.2.0/www/``
+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 phorkie in your web browser
+6. Open http://yourhost/setup in your web browser to see if everything
+ is working fine.
+
+7. Go to http://yourhost/
Dependencies
============
phorkie stands on the shoulders of giants.
+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
+
::
$ pear install versioncontrol_git-alpha
$ pear install services_libravatar-alpha
$ pear install http_request2
$ pear install pager
- $ pear install https://github.com/downloads/cweiske/Date_HumanDiff/Date_HumanDiff-0.1.0.tgz
+ $ 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
-Note that this version of GeSHi is a bit outdated, but it's the fastest
-way to install it.
+ $ pear channel-discover pear.michelf.ca
+ $ pear install michelf/Markdown
+
+ $ pear channel-discover pear2.php.net
+ $ pear install pear2/pear2_services_linkback-alpha
======
Search
======
-phorkie makes use of an Elasticsearch__ installation if you have one.
+phorkie makes use of an Elasticsearch__ installation, if you have one.
It is used to provide search capabilities and the list of recent pastes.
__ http://www.elasticsearch.org/
+
Setup
=====
Edit ``config.php``, setting the ``elasticsearch`` property to the HTTP URL
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
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
To make git repositories clonable, you need to install ``git-daemon``
(``git-daemon-run`` package on Debian/Ubuntu).
-Now make the repositories available by symlinking the paste repository
+Make the repositories available by symlinking the paste repository
directory (``$GLOBALS['phorkie']['cfg']['repos']`` setting) into
``/var/cache/git``, e.g.::
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``)
+- 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
====
-- OpenID-Login to get username+email as authorship information
- filters (``xmllint --format``, ``rapper``)
- document how to keep disk usage low (block size)
- comments
====
``/``
- Index page. Shows form for new paste
+ Index page.
``/[0-9]+``
Display page for paste
``/[0-9]/edit``
Show specific revision of the paste
``/[0-9]/delete``
Delete the paste
+``/[0-9]/doap``
+ Show DOAP document for paste
``/[0-9]/fork``
Create a fork of the paste
``/search?q=..(&page=[0-9]+)?``
Search for term, with optional page
``/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
Internal directory layout
1.git/ - git repository for paste #1
description - Description for the repository
2.git/ - git repository for paste #2
+
+nginx rewrites
+==============
+If you use nginx, place the following lines into your ``server`` block:
+
+::
+
+ if (!-e $request_uri) {
+ rewrite ^/([0-9]+)$ /display.php?id=$1;
+ rewrite ^/([0-9]+)/delete$ /delete.php?id=$1;
+ 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]+)/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]+)/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;
+
+ rewrite ^/search$ /search.php;
+ rewrite ^/search/([0-9]+)$ /search.php?page=$1;
+
+ rewrite ^/login$ /login.php;
+ rewrite ^/setup$ /setup.php;
+ rewrite ^/user$ /user.php;
+ }
git.cweiske.de / phorkie.git / blobdiff