StarMirror/PrivateBin
1
0
Fork 0
mirror of https://github.com/PrivateBin/PrivateBin.git synced 2024-03-22 13:10:41 +08:00
Code Issues Projects Releases Wiki Activity
f3df151a8c
PrivateBin/doc
History
El RIDO 6dddf808c6
composer fixes #1222 
- clarify installation
- ensure composer files get released in exported archive
- fix lock checksum
2024-02-12 21:18:58 +01:00
..
Generating Source Code Documentation.md fix phpdoc parameters for newer releases 2023-12-03 13:54:35 +01:00
Installation.md composer fixes #1222 2024-02-12 21:18:58 +01:00
README.md incrementing version 2023-12-04 21:07:17 +01:00
Release.md updated release document 2023-12-16 07:02:21 +01:00
Running Unit Tests.md update unit test doc & PHP 8 fixes 2023-12-03 13:40:04 +01:00

README.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](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.