setup check
[phorkie.git] / README.rst
index 1a77182..9c5c97c 100644 (file)
@@ -1,6 +1,118 @@
 ************************************
-Phorkie - PHP and Git based pastebin
+phorkie - PHP and Git based pastebin
 ************************************
+Self-hosted pastebin software written in PHP.
+Pastes are editable, may have multiple files and are stored in git repositories.
+
+Homepage: http://sourceforge.net/p/phorkie/
+
+.. contents:: Table of Contents
+
+========
+Features
+========
+- every paste is a git repository
+
+  - repositories can be cloned
+  - clone url can be displayed
+- paste editing
+
+  - add new files
+  - delete existing files
+  - replace file with upload
+- multiple files in one paste
+- syntax highlighting with GeSHi
+- rST rendering
+- image upload + display
+- external tool support
+
+  - xmllint
+  - php syntax check
+- history in the sidebar
+
+  - old files can be downloaded easily
+
+============
+Dependencies
+============
+phorkie stands on the shoulders of giants.
+
+
+Install VersionControl_Git
+==========================
+::
+
+  $ pear install versioncontrol_git-alpha
+
+
+Install Date_HumanDiff
+======================
+::
+
+  $ pear install https://github.com/downloads/cweiske/Date_HumanDiff/Date_HumanDiff-0.1.0.tgz
+
+
+Install GeSHi
+=============
+::
+
+  $ pear channel-discover mediawiki.googlecode.com/svn
+  $ pear install mediawiki/geshi
+
+Note that this version of GeSHi is a bit outdated, but it's the fastest
+way to install it.
+
+
+Install Twig
+============
+::
+
+  $ pear channel-discover pear.twig-project.org
+  $ pear install twig/Twig
+
+
+=====
+HowTo
+=====
+
+Make git repositories clonable
+==============================
+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
+directory (``$GLOBALS['phorkie']['cfg']['repos']`` setting) into
+``/var/cache/git``, e.g.::
+
+  $ ln -s /home/user/www/paste/repos/git /var/cache/git/paste
+
+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.
+
+
+=================
+Technical details
+=================
+
+TODO
+====
+- filters (xmllint --format, rapper)
+- search
+- OpenID-Login to get username+email as authorship information
+- document how to keep disk usage low (block size)
+- comments
+- when 2 people edit, merge changes
+- diff changes
+- configurable highlights
+- tags
+- autotags for file types
+- Atom feed for new pastes
+- Atom feed for paste changes
+
 
 URLs
 ====
@@ -26,10 +138,13 @@ Internal directory layout
 ::
 
   repos/
-    1/ - git repository for paste #1
-      .git/
+    work/
+      1/ - work directory for paste #1
+      2/ - work directory for paste #2
+    git/
+      1.git/ - git repository for paste #1
         description - Description for the repository
-    2/ - git repository for paste #2
+      2.git/ - git repository for paste #2
 
 
 Search
@@ -37,20 +152,5 @@ Search
 Use ``ack-grep``
 
 
-Install geshi
-=============
-::
 
-  $ pear channel-discover mediawiki.googlecode.com/svn
-  $ pear install mediawiki/geshi
 
-
-TODO
-====
-- edit
-- search
-- OpenID-Login to get username+email as authorship information
-- sidebar: history
-- image upload
-- rst rendering
-- document how to keep disk usage low (block size)