paste.chapril.org-privatebin/doc
rugk 43d162f452
Created doc for “how to verify and how to do release” (release doc) (WIP)
This documents/should document:
* what the signatures are and what they proof
* how to verify them
* how to build releases (I know more of a maintainer doc, but yeah, I found it a good place here, if you want a separate one feel free)

This should also make it easier for other maintainers to create releases or so.

@elrido feel free to adjust/push to the branch if you want to have some details fixed. I have left some TODOs of stuff where I am unsure.
2023-12-15 14:17:51 +01:00
..
Generating Source Code Documentation.md fix phpdoc parameters for newer releases 2023-12-03 13:54:35 +01:00
Installation.md 1.6.2 release 2023-12-15 07:20:20 +01:00
README.md incrementing version 2023-12-04 21:07:17 +01:00
Release.md Created doc for “how to verify and how to do release” (release doc) (WIP) 2023-12-15 14:17:51 +01:00
Running Unit Tests.md update unit test doc & PHP 8 fixes 2023-12-03 13:40:04 +01: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.