paste.chapril.org-privatebin/doc/README.md

38 lines
1.6 KiB
Markdown
Raw Normal View History

# PrivateBin Documentation
## [Frequently Asked Questions](https://github.com/PrivateBin/PrivateBin/wiki/FAQ)
Please have a look at these questions *before* opening an issue in this repo.
## [Installation guide](https://github.com/PrivateBin/PrivateBin/blob/master/doc/Installation.md#installation)
Minimal requirements, hardening and securing your installation and initial
configuration.
## [Configuration guide](https://github.com/PrivateBin/PrivateBin/wiki/Configuration)
Detailed guide on each configuration option and their effects.
## [Templates](https://github.com/PrivateBin/PrivateBin/wiki/Templates)
How to change an existing template or create your own, as well as an overview of
the currently included templates.
## [Translation guide](https://github.com/PrivateBin/PrivateBin/wiki/Translation)
How to help translate PrivateBin and technical background on it's implementation.
## [Developer guide](https://github.com/PrivateBin/PrivateBin/wiki/Development)
Know how for participating in PrivateBins development.
### [Generating Source Code Documentation](https://github.com/PrivateBin/PrivateBin/blob/master/doc/Generating%20Source%20Code%20Documentation.md#generating-source-code-documentation)
How to generate the source code API documentation, as found on the project
website for [PHP](https://privatebin.info/codedoc/) and [JS](https://privatebin.info/jsdoc/)
2023-12-04 21:07:17 +01:00
### [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
2023-12-04 21:07:17 +01:00
based unit testing.