mirror of
https://github.com/PrivateBin/PrivateBin.git
synced 2024-10-01 01:26:10 -04:00
8c1310c334
having had to re-do all of these steps on a new environment, I noticed some inconsistencies and updated the doc: - moved unit testing doc into common doc folder, so it is easier to find - removed no longer supported Janitor reference - removed note regarding generated test duration, current version takes less than a minute - addressed each function removal & phpunit deprecations |
||
---|---|---|
.. | ||
Generating Source Code Documentation.md | ||
Installation.md | ||
README.md | ||
Running Unit Tests.md |
PrivateBin Documentation
Frequently Asked Questions
Please have a look at these questions before opening an issue in this repo.
Installation guide
Minimal requirements, hardening and securing your installation and initial configuration.
Configuration guide
Detailed guide on each configuration option and their effects.
Templates
How to change an existing template or create your own, as well as an overview of the currently included templates.
Translation guide
How to help translate PrivateBin and technical background on it's implementation.
Developer guide
Know how for participating in PrivateBins development.
Generating Source Code Documentation
How to generate the source code API documentation, as found on the project website for PHP and JS
Running Unit Tests
How to run the PHP & JS unit tests, including a brief introduction to property based unit testing.