From b00b0264f87fe6a6367b6acd8bbf2d75d3e02e68 Mon Sep 17 00:00:00 2001 From: El RIDO Date: Sat, 9 Jul 2016 14:43:50 +0200 Subject: [PATCH] fixing formatting issues --- CHANGELOG.md | 2 +- CREDITS.md | 6 ++--- INSTALL.md | 75 ++++++++++++++++++++++++++++++++-------------------- LICENSE.md | 7 +++-- README.md | 15 ++++++----- 5 files changed, 62 insertions(+), 43 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9265daf8..cdfc92da 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# ZeroBin version history # +# PrivateBin version history * **0.22 (2015-11-09)**: * ADDED: Tab character input support diff --git a/CREDITS.md b/CREDITS.md index 940ee022..943131d0 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -1,7 +1,7 @@ -Credits -======= +# Credits + Sébastien Sauvage - original idea and main developer -El Rido - current developer and maintainer +Simon Rupf - current developer and maintainer * Alexey Gladkov - syntax highlighting * Greg Knaddison - robots.txt diff --git a/INSTALL.md b/INSTALL.md index afcd2c4b..a4c214d6 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,10 +1,11 @@ -Installation -============ +# Installation ## Basic installation -**TL;DR:** Download the [latest release archive](https://github.com/elrido/ZeroBin/releases/latest) -and extract it in your web hosts folder were you want to install your ZeroBin instance. +**TL;DR:** Download the +[latest release archive](https://github.com/PrivateBin/PrivateBin/releases/latest) +and extract it in your web hosts folder were you want to install your PrivateBin +instance. ### Requirements @@ -16,18 +17,18 @@ and extract it in your web hosts folder were you want to install your ZeroBin in ### Configuration -In the file `cfg/conf.ini` you can configure ZeroBin. A `cfg/conf.ini.sample` -is provided containing all options on default values. You can copy it to -`cfg/conf.ini` and adapt it as needed. The config file is divided into multiple +In the file `cfg/conf.ini` you can configure PrivateBin. A `cfg/conf.ini.sample` +is provided containing all options on default values. You can copy it to +`cfg/conf.ini` and adapt it as needed. The config file is divided into multiple sections, which are enclosed in square brackets. -In the `[main]` section you can enable or disable the discussion feature, set the -limit of stored pastes and comments in bytes. The `[traffic]` section lets you -set a time limit in seconds. Users may not post more often then this limit to -your ZeroBin installation. +In the `[main]` section you can enable or disable the discussion feature, set +the limit of stored pastes and comments in bytes. The `[traffic]` section lets +you set a time limit in seconds. Users may not post more often then this limit +to your PrivateBin installation. More details can be found in the -[configuration documentation](https://github.com/elrido/ZeroBin/wiki/Configuration). +[configuration documentation](https://github.com/PrivateBin/PrivateBin/wiki/Configuration). ## Advanced installation @@ -40,38 +41,56 @@ root. This new location must still be accessible to your webserver / PHP process ([open_basedir setting](http://php.net/manual/en/ini.core.php#ini.open-basedir)). > #### PATH Example -> Your zerobin installation lives in a subfolder called "paste" inside of your -> document root. The URL looks like this: +> Your PrivateBin installation lives in a subfolder called "paste" inside of +> your document root. The URL looks like this: > http://example.com/paste/ -> The full path of ZeroBin on your webserver is: +> +> The full path of PrivateBin on your webserver is: > /home/example.com/htdocs/paste > > When setting the path like this: -> define('PATH', '../../secret/zerobin/'); -> ZeroBin will look for your includes here: -> /home/example.com/secret/zerobin +> define('PATH', '../../secret/privatebin/'); +> +> PrivateBin will look for your includes here: +> /home/example.com/secret/privatebin + +### Web server configuration + +A `robots.txt` file is provided in the root dir of PrivateBin. It disallows all +robots from accessing your pastes. It is recommend to place it into the root of +your web directory if you have installed PrivateBin in a subdirectory. Make sure +to adjust it, so that the file paths match your installation. Of course also +adjust the file if you already use a `robots.txt`. + +A `.htaccess.disabled` file is provided in the root dir of PrivateBin. It blocks +some known robots and link-scanning bots. If you use Apache, you can rename the +file to `.htaccess` to enable this feature. If you use another webserver, you +have to configure it manually to do the same. ### Using a database instead of flat files In the configuration file the `[model]` and `[model_options]` sections let you -configure your favourite way of storing the pastes and discussions on your server. +configure your favourite way of storing the pastes and discussions on your +server. -`zerobin_data` is the default model, which stores everything in files in the data -folder. This is the recommended setup for most sites. +`privatebin_data` is the default model, which stores everything in files in the +data folder. This is the recommended setup for most sites. Under high load, in distributed setups or if you are not allowed to store files -locally, you might want to switch to the `zerobin_db` model. This lets you store -your data in a database. Basically all databases that are supported by +locally, you might want to switch to the `privatebin_db` model. This lets you +store your data in a database. Basically all databases that are supported by [PDO](http://php.net/manual/en/book.pdo.php) may be used. Automatic table creation is provided for `pdo_ibm`, `pdo_informix`, `pdo_mssql`, `pdo_mysql`, `pdo_oci`, `pdo_pgsql` and `pdo_sqlite`. You may want to provide a table prefix, -if you have to share the zerobin database with another application. The table -prefix option is called `tbl`. +if you have to share the PrivateBin database with another application or you want +to use a prefix for +[security reasons](https://security.stackexchange.com/questions/119510/is-using-a-db-prefix-for-tables-more-secure). +The table prefix option is called `tbl`. > #### Note -> The "zerobin_db" model has only been tested with SQLite and MySQL, although it -would not be recommended to use SQLite in a production environment. If you gain -any experience running ZeroBin on other RDBMS, please let us know. +> The "privatebin_db" model has only been tested with SQLite and MySQL, although +it would not be recommended to use SQLite in a production environment. If you +gain any experience running PrivateBin on other RDBMS, please let us know. For reference or if you want to create the table schema for yourself: diff --git a/LICENSE.md b/LICENSE.md index d1400b68..ae047641 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,14 +1,13 @@ -License -======= +# License -ZeroBin consists of PHP and JS code which was originally written by Sébastien +PrivateBin consists of PHP and JS code which was originally written by Sébastien Sauvage in 2012 and falls unter the Zlib/libpng license. Also included are libraries that fall under the LGPLv3 (RainTPL), GPLv2 (SJCL, rawinflate, rawdeflate), BSD 2-clause (SJCL), BSD 3-clause (base64.js version 2.1.9, Showdown), MIT (base64.js version 1.7, Bootstrap) and Apache (prettify.js) licenses. All of these license terms can be found here below: -## Zlib/libpng license for ZeroBin +## Zlib/libpng license for PrivateBin Copyright © 2012 Sébastien Sauvage diff --git a/README.md b/README.md index d64e85f9..70e6bcc3 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # PrivateBin 0.22 -[![Build Status](https://travis-ci.org/PrivateBin/PrivateBin.svg?branch=master)](https://travis-ci.org/PrivateBin/PrivateBin) [![Build Status](https://scrutinizer-ci.com/g/PrivateBin/PrivateBin/badges/build.png?b=master)](https://scrutinizer-ci.com/g/PrivateBin/PrivateBin/build-status/master) +[![Build Status](https://travis-ci.org/PrivateBin/PrivateBin.svg?branch=master)](https://travis-ci.org/PrivateBin/PrivateBin) [![Build Status](https://scrutinizer-ci.com/g/PrivateBin/PrivateBin/badges/build.png?b=master)](https://scrutinizer-ci.com/g/PrivateBin/PrivateBin/build-status/master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/094500f62abf4c9aa0c8a8a4520e4789)](https://www.codacy.com/app/PrivateBin/PrivateBin) [![Code Climate](https://codeclimate.com/github/PrivateBin/PrivateBin/badges/gpa.svg)](https://codeclimate.com/github/PrivateBin/PrivateBin) -[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/PrivateBin/PrivateBin/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/PrivateBin/PrivateBin/?branch=master) +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/PrivateBin/PrivateBin/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/PrivateBin/PrivateBin/?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/094500f62abf4c9aa0c8a8a4520e4789)](https://www.codacy.com/app/PrivateBin/PrivateBin) [![Test Coverage](https://codeclimate.com/github/PrivateBin/PrivateBin/badges/coverage.svg)](https://codeclimate.com/github/PrivateBin/PrivateBin/coverage) [![Code Coverage](https://scrutinizer-ci.com/g/PrivateBin/PrivateBin/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/PrivateBin/PrivateBin/?branch=master) @@ -18,6 +18,8 @@ original. It is however still fully compatible to the original ZeroBin 0.19 data storage scheme. Therefore such installations can be upgraded to this fork without loosing any data. +![PrivateBin Logo](https://raw.githubusercontent.com/PrivateBin/PrivateBin/master/img/favicons/android-chrome-192x192.png) + ## What PrivateBin provides + As a server administrator you don't have to worry if your users post content @@ -61,9 +63,10 @@ without loosing any data. on the server. However the server could be misused or the server admin could be legally forced into sending malicious JavaScript to all web users, which grabs the decryption key and send it to the server when a user accesses a - PrivateBin. Therefore do not access any PrivateBin instance if you think it - has been compromised. As long as no user accesses this instance with a - previously generated URL, the content can''t be decrypted. + PrivateBin. + Therefore do not access any PrivateBin instance if you think it has been + compromised. As long as no user accesses this instance with a previously + generated URL, the content can''t be decrypted. ## Options @@ -108,5 +111,3 @@ file](https://github.com/PrivateBin/PrivateBin/wiki/Configuration): Run into any issues? Have ideas for further developments? Please [report](https://github.com/PrivateBin/PrivateBin/issues) them! - -![PrivateBin Logo](https://raw.githubusercontent.com/PrivateBin/PrivateBin/master/img/favicons/android-chrome-192x192.png)