|
@@ -1,10 +1,11 @@
|
|
|
-Installation
|
|
|
|
|
-============
|
|
|
|
|
|
|
+# Installation
|
|
|
|
|
|
|
|
## Basic 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
|
|
### Requirements
|
|
|
|
|
|
|
@@ -16,18 +17,18 @@ and extract it in your web hosts folder were you want to install your ZeroBin in
|
|
|
|
|
|
|
|
### Configuration
|
|
### 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.
|
|
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
|
|
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
|
|
## 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)).
|
|
([open_basedir setting](http://php.net/manual/en/ini.core.php#ini.open-basedir)).
|
|
|
|
|
|
|
|
> #### PATH Example
|
|
> #### 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/
|
|
> 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
|
|
> /home/example.com/htdocs/paste
|
|
|
>
|
|
>
|
|
|
> When setting the path like this:
|
|
> 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
|
|
### Using a database instead of flat files
|
|
|
|
|
|
|
|
In the configuration file the `[model]` and `[model_options]` sections let you
|
|
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
|
|
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
|
|
[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`,
|
|
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,
|
|
`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
|
|
> #### 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:
|
|
For reference or if you want to create the table schema for yourself:
|
|
|
|
|
|