Add notes about new config values

rugk 2016-07-31 12:54:37 +02:00
parent fe046164f8
commit 7cc938fac5

@ -97,6 +97,17 @@ true | set, i.e. to "fr" | set | uses browser language or the
Optionally PrivateBin can offer a link to a URL shortener service after a new paste is created. It is strongly suggested to only use this with self-hosted shortener services as this will leak the pastes encryption key to the service entered here.
### vizhash
PrivateBin creates avatars (with "visual hashes" = vizhashes) for users commenting on PrivateBins. These avatars are generated from the IP of the user commenting, which is a potential vulnerability, which may allow an attacker to guess the IP of the user, who published the comment. This issue has been found in a [security audit](https://defuse.ca/audits/zerobin.htm) (2.4.).
For privacy reason you can therefore disable this feature.
#### zerobincompatibility
This option as introduced with the name switch of ZeroBin to PrivateBin. By default it is disabled and therefore prevents the use of some depreciated, outdated features of PrivateBin, which were used in ZeroBin.
For full compatibility with ZeroBin, you can enable this option. However this is not recommend as it weakens the security of your PrivateBin instance.
<!-- NOTE: Please add what happens when this option is disabled. (Cannot access old ZeroBins?) -->
### model
The sections `[model]` and `[model_options]` control how your pastes are stored. Currently PrivateBin stores its pastes as flat files by default (`[model]` section, `class = privatebin_data`) and the option `dir` in the section `[model_options]` tells it in what folder to store them. Note that this directory needs to be writable for the process running PHP (i.e. your webserver, FPM or CGI process).