README.rst

   1 ************************************
   2 phorkie - PHP and Git based pastebin
   3 ************************************
   4 Self-hosted pastebin software written in PHP.
   5 Pastes are editable, may have multiple files and are stored in git repositories.
   6
   7 Homepage: http://sourceforge.net/p/phorkie/
   8
   9
  10 ========
  11 Features
  12 ========
  13 - every paste is a git repository
  14 - paste editing
  15 - multiple files in one paste
  16 - syntax highlighting with GeSHi
  17 - rST rendering
  18
  19
  20 ============
  21 Dependencies
  22 ============
  23 phorkie stands on the shoulders of giants.
  24
  25
  26 Install GeSHi
  27 =============
  28 ::
  29
  30   $ pear channel-discover mediawiki.googlecode.com/svn
  31   $ pear install mediawiki/geshi
  32
  33 Note that this version of GeSHi is a bit outdated, but it's the fastest
  34 way to install it.
  35
  36
  37 Install Twig
  38 ============
  39 ::
  40
  41   $ pear channel-discover pear.twig-project.org
  42   $ pear install twig/Twig
  43
  44
  45 =================
  46 Technical details
  47 =================
  48
  49 TODO
  50 ====
  51 - search
  52 - OpenID-Login to get username+email as authorship information
  53 - sidebar: history
  54 - image upload
  55 - document how to keep disk usage low (block size)
  56 - comments
  57 - when 2 people edit, merge changes
  58 - diff changes
  59 - configurable highlights
  60
  61
  62 URLs
  63 ====
  64
  65 ``/``
  66   Index page. Shows form for new paste
  67 ``/[0-9]+``
  68   Display page for paste
  69 ``/[0-9]/edit``
  70   Edit the paste
  71 ``/[0-9]+/raw/(.+)``
  72   Display raw file contents
  73 ``/[0-9]/delete``
  74   Delete the paste
  75 ``/search(/.+)?``
  76   Search for term
  77 ``/list(/[0-9])?``
  78   List all pastes
  79
  80
  81 Internal directory layout
  82 =========================
  83 ::
  84
  85   repos/
  86     1/ - git repository for paste #1
  87       .git/
  88         description - Description for the repository
  89     2/ - git repository for paste #2
  90
  91
  92 Search
  93 ======
  94 Use ``ack-grep``
  95
  96
  97
  98