All Projects → cweiske → Phorkie

cweiske / Phorkie

Licence: agpl-3.0
Self-hosted pastebin software written in PHP. Pastes are editable, forkable, may have multiple files and are stored in git repositories.

Projects that are alternatives of or similar to Phorkie

Pastebin
Just another Pastebin.com CLI script, but you can even login with your user account.
Stars: ✭ 5 (-97.54%)
Mutual labels:  pastebin
Nginx Pastebin
NGINX+Lua based pastebin for text
Stars: ✭ 70 (-65.52%)
Mutual labels:  pastebin
Filite
A simple, light and standalone pastebin, URL shortener and file-sharing service
Stars: ✭ 125 (-38.42%)
Mutual labels:  pastebin
Vinergy
CLI Pastebin within Vim energy (https://git.io/vn)
Stars: ✭ 49 (-75.86%)
Mutual labels:  pastebin
Webpaste.el
webpaste.el can paste whole buffers or parts of buffers to several pastebin-like services and supports failover if one service fails.
Stars: ✭ 67 (-67%)
Mutual labels:  pastebin
Mathbin
Math pastebin with LaTeX and Markdown support
Stars: ✭ 83 (-59.11%)
Mutual labels:  pastebin
Cowyo
A feature-rich wiki webserver for minimalists 🐮 💬
Stars: ✭ 711 (+250.25%)
Mutual labels:  pastebin
Purritobin
ultra fast, minimalistic, encrypted command line paste-bin
Stars: ✭ 171 (-15.76%)
Mutual labels:  pastebin
Pastebin Scraper
Live-scraping pastebin to fight boredom.
Stars: ✭ 66 (-67.49%)
Mutual labels:  pastebin
Bepasty Server
binary pastebin server
Stars: ✭ 111 (-45.32%)
Mutual labels:  pastebin
0bin
Client side encrypted pastebin
Stars: ✭ 1,051 (+417.73%)
Mutual labels:  pastebin
Nekobin
Elegant and open-source pastebin service
Stars: ✭ 61 (-69.95%)
Mutual labels:  pastebin
Pastepwn
Python framework to scrape Pastebin pastes and analyze them
Stars: ✭ 87 (-57.14%)
Mutual labels:  pastebin
Linx Server
Self-hosted file/code/media sharing website. ~~~~~~~~~~~~~~~~~~~ Demo: https://demo.linx-server.net/
Stars: ✭ 1,044 (+414.29%)
Mutual labels:  pastebin
Paste.laravel.io
The Laravel.io Pastebin.
Stars: ✭ 135 (-33.5%)
Mutual labels:  pastebin
Psitransfer
Simple open source self-hosted file sharing solution.
Stars: ✭ 712 (+250.74%)
Mutual labels:  pastebin
Nopaste
📋 Client-side paste service
Stars: ✭ 79 (-61.08%)
Mutual labels:  pastebin
Cardpwn
OSINT Tool to find Breached Credit Cards Information
Stars: ✭ 187 (-7.88%)
Mutual labels:  pastebin
Elimage
An image paste web service. (https://git.io/img)
Stars: ✭ 168 (-17.24%)
Mutual labels:  pastebin
Thunar Custom Actions
Custom actions for Thunar (or Nautilus) File manager
Stars: ✭ 109 (-46.31%)
Mutual labels:  pastebin

phorkie - Git based pastebin


Self-hosted pastebin software written in PHP. Pastes are editable, may have multiple files and are stored in git repositories.

Homepage <https://cweiske.de/phorkie.htm>__ | Bug tracker <https://github.com/cweiske/phorkie/issues>__ | Git repository <https://git.cweiske.de/phorkie.git>__ · GitHub mirror <https://github.com/cweiske/phorkie/>__ | News <https://cweiske.de/phorkie-news.htm>__

.. contents:: Table of Contents

======== Features

  • every paste is a git repository

    • 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
  • 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
    • 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
  • 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

  • text file detection for unknown file types

======== Download

phorkie is released as self-contained .phar file that includes all dependencies, as well as a normal zip file.

.. LATESTRELEASE

See phorkie downloads page <http://cweiske.de/phorkie-download.htm>_ for all released versions.

============ Installation

.phar

Download phorkie-0.8.1.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. You can do it yourself, though - see Enable .phar handling in your web server__.

.. warning:: PHP has some bugs in its .phar handling code (e.g. with FPM).

So currently, the .phar option is considered experimental.

__ http://cweiske.de/tagebuch/phar-webserver.htm

Zip package

  1. Unzip the phorkie release file::

    $ tar xjvf phorkie-0.8.1.tar.bz2

  2. Create the git directories::

    $ mkdir -p www/repos/git www/repos/work $ chmod og+w www/repos/git www/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/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.

  7. Go to http://yourhost/

  8. If you like phorkie, send a mail to [email protected]__

__ mailto:[email protected]

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

    • optionally the mbstring extension
  • 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 date_humandiff-alpha $ pear install openid-alpha

$ pear channel-discover pear.twig-project.org $ pear install twig/Twig

$ 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

$ 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

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 2.0 is supported.

You have to install the delete-by-query__ plugin::

$ cd /usr/share/elasticsearch
$ bin/plugin install delete-by-query

__ http://www.elasticsearch.org/ __ https://www.elastic.co/guide/en/elasticsearch/plugins/2.0/plugins-delete-by-query.html

Setup

Edit config.php, setting the elasticsearch property to the HTTP URL 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

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.

You may also manually run the reindexing script with::

$ php scripts/index.php

===== HowTo

Make git repositories clonable

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 /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.

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': '[email protected]', }, 'repository': { 'name': 'webhooktest', 'url': 'http://example.org/33', 'description': 'webhooktest', 'owner': { 'name': 'Anonymous', 'email': '[email protected]', } } }

The event may be create, edit or delete.

================= Technical details

URLs

/ Index page. /[0-9]+ Display page for paste /[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]+/(.+) 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]+/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

::

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

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]+)/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]+)/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;

}

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"
)

=========== Development

Releasing a new version

#. Update ChangeLog, NEWS.rst, build.xml and README.rst. #. Update local dependencies::

$ phing collectdeps

#. Build .tar.bz2 and .phar release files with::

$ phing zip
$ phing phar

#. Test. #. Tag the release in git #. Run the script to update the homepage

$ cd /home/cweiske/Dev/html/cweiske.de
$ ./scripts/update-phorkie.sh
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].