arno/privatebin
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

adjusting lines to 80ish characters so the page can be directly copy/pasted into INSTALL.md

El RIDO 2015-09-19 15:38:09 +02:00
parent 4f6f3bbbd3
commit 099364d85b
1 changed files with 32 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
Installation.md

@ -1,6 +1,7 @@
## 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/elrido/ZeroBin/releases/latest)
and extract it in your web hosts folder were you want to install your ZeroBin instance.
### Requirements
@ -12,20 +13,30 @@
### Configuration
In the file `cfg/conf.ini` you can configure ZeroBin. The config file is divided into multiple sections, which are enclosed in square brackets.
In the file `cfg/conf.ini` you can configure ZeroBin. 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 ZeroBin installation.
More details can be found in the [configuration documentation](https://github.com/elrido/ZeroBin/wiki/Configuration).
More details can be found in the
[configuration documentation](https://github.com/elrido/ZeroBin/wiki/Configuration).
## Advanced installation
### Changing the path
In the index.php you can define a different `PATH`. This is useful to secure your installation. You can move the configuration, data files, templates and PHP libraries (directories cfg, data, lib, tpl, tmp and tst) outside of your document 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)).
In the index.php you can define a different `PATH`. This is useful to secure your
installation. You can move the configuration, data files, templates and PHP
libraries (directories cfg, data, lib, tpl, tmp and tst) outside of your document
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 zerobin 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:
> /home/example.com/htdocs/paste
@ -37,14 +48,25 @@ In the index.php you can define a different `PATH`. This is useful to secure you
### 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.
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.
`zerobin_data` is the default model, which stores everything in files in the data folder. This is the recommended setup for most sites.
`zerobin_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 [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`.
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
[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`.
> #### 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 "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.
For reference or if you want to create the table schema for yourself: