1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
************************************
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.
Project page: 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
- search across pastes: description, file names and file content
- options: quoting, logical and, or, not, partial words
============
Installation
============
1. Unzip the phorkie release file::
$ tar xjvf phorkie-0.2.0.tar.bz2
2. Create the git directories::
$ mkdir -p repos/git repos/work
$ chmod og+w repos/git repos/work
3. Install dependencies_
4. Copy ``data/config.php.dist`` to ``data/config.php`` and adjust it
to your needs::
$ cp data/config.php.dist data/config.php
$ $EDITOR data/config.php
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/``
6. Open phorkie in your web browser
Dependencies
============
phorkie stands on the shoulders of giants.
::
$ 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 channel-discover pear.twig-project.org
$ pear install twig/Twig
$ 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.
======
Search
======
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
of the index, e.g. ::
http://localhost:9200/phorkie/
Run the index script to import all existing pastes into the index::
php scripts/index.php
That's all. Open phorkie in your browser, and you'll notice the search box
in the top menu.
Reset
=====
In case something really went wrong and you need to reset the search
index, run the following command::
$ curl -XDELETE http://localhost:9200/phorkie/
{"ok":true,"acknowledged"}
Phorkie will automatically re-index everything when ``setupcheck`` is enabled
in the configuration file.
=====
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
====
- OpenID-Login to get username+email as authorship information
- 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
====
``/``
Index page. Shows form for new paste
``/[0-9]+``
Display page for paste
``/[0-9]/edit``
Edit the paste
``/[0-9]+/raw/(.+)``
Display raw file contents
``/[0-9]/tool/[a-zA-Z]+/(.+)``
Run a tool on the given file
``/[0-9]/rev/[a-z0-9]+``
Show specific revision of the paste
``/[0-9]/delete``
Delete the 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
Internal directory layout
=========================
::
repos/
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/ - git repository for paste #2
|
