PrivateBin/doc
2024-11-16 08:02:20 +01:00
..
Generating Source Code Documentation.md fix phpdoc parameters for newer releases 2023-12-03 13:54:35 +01:00
Installation.md incrementing version 2024-11-16 08:02:20 +01:00
README.md incrementing version 2023-12-04 21:07:17 +01:00
Release.md doc: Fix (direct) link to SLSA verifier 2024-02-16 17:19:17 +01:00
Running Unit Tests.md Adding hint that you will see unrelated files and to ignore these 2024-10-18 02:20:50 +02:00

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](https://github.com/PrivateBin/PrivateBin/blob/master/doc/Running Unit Tests.md#running-all-unit-tests)

How to run the PHP & JS unit tests, including a brief introduction to property based unit testing.