README

Contribute to DocPHT

Our project grows and thrives thanks to the help of volunteers like you! We are currently looking for contributors who can assist us in various areas, including development, documentation, and testing.

If you are interested in contributing, please read our call for contributors where we provide details on how you can help. Even the smallest contribution is valuable, and together we can continue to improve DocPHT for everyone.

How to Get Started

Feel free to join the discussion on the issue to propose your ideas or ask for clarifications.

We appreciate every contribution and are excited to see how our community can help DocPHT grow and improve. Thank you for your support!

DocPHT 📑

With DocPHT you can take notes and quickly document anything! You can also manage users, save versions of your pages and run and restore backups. Complete with interface that can be customized, all with maximum portability and without the use of any database. You won't believe it, until you try it! 💎

Getting Started

Download the latest version of the package and upload it to the server, unzip it to the location you prefer. Open the browser and enter the address to start the installation wizard, it will take less than a minute. 🚀

Prerequisites 🔌

Apache 2.2+ with mod_rewrite and "AllowOverride All" set.
Enable mod headers module
PHP ^7.4

Composer

This project can be installed as a Composer dependency.

composer create-project kenlog/docpht

Docker

Basic Usage:

docker pull docpht/docpht:v1.3.2
docker run -d --name docpht -p 80:80 -t docpht/docpht:v1.3.2

Advanced Usage (Persistence data):

docker pull docpht/docpht:v1.3.2
docker run -d --name docpht -p 80:80 -p 443:443 -t 
-v /var/www/app/src/config:/var/www/app/src/config
-v /var/www/app/data:/var/www/app/data
-v /var/www/app/pages:/var/www/app/pages
-v /etc/nginx/ssl:/etc/nginx/ssl
docpht/docpht:v1.3.2

Wrapping Up

That is all you need to get started. Boom!

Welcome to the new collaborators 👦 💁 👴 👼 💃 👽

Clone the repository:

git clone https://github.com/kenlog/docpht.git

We look forward to seeing your pull requests!

Contributor Covenant Code of Conduct 📜

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. 🌍 Always strive to collaborate with mutual respect.

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

❕ Reporting Issues or feature requests ❔

Please create an issue

🐛 Where should I report security issues?

In order to give the community time to respond and upgrade we strongly urge you report all security issues privately. Email us directly at securitybugreport@docpht.org with details and repro steps. Security issues always take precedence over bug fixes and feature work. We can and do mark releases as "urgent" if they contain serious security fixes.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Valentino Pesce - Kenlog 🇮🇹
Craig Crosby - Creecros 🇺🇸

kenlog / docpht

Maintainers

Details