Infra-Mirrors/PrivateBin
1
0
Fork 0
mirror of https://github.com/PrivateBin/PrivateBin.git synced 2024-12-24 23:09:28 -05:00
Code Issues Packages Projects Releases Wiki Activity
8c1310c334
PrivateBin/doc
History
El RIDO 8c1310c334
update unit test doc & PHP 8 fixes 
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
2023-12-03 13:40:04 +01:00
..
Generating Source Code Documentation.md rename documentation files 2023-02-19 08:30:44 +01:00
Installation.md Update Ansible Galaxy links in Installation.md 2023-10-01 20:43:11 +02:00
README.md update links, unify formats, add documentation index 2023-02-19 08:32:10 +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

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