Fork 0
mirror of https://github.com/opnsense/docs.git synced 2024-06-19 01:04:47 +02:00
Go to file
Monviech d971b9d815
www/caddy: Add a few more details to docs (#569)
* www/caddy: Add section about interface binding, Add note about OPNsense WebGUI not always listening on when reverse proxying it.

* Explain new subdomain port behavior, explain handler behavior better - the logic was there since the beginning but got lost in the docs.

* Add note about cookie security.

* Add hint about syncookies, make Creating a Simple Reverse Proxy clearer, add hint for HTTP-01 challenge redirection not needing a handler.
2024-06-18 10:05:09 +02:00
.github/ISSUE_TEMPLATE add issue templates 2021-01-28 13:12:17 +01:00
source www/caddy: Add a few more details to docs (#569) 2024-06-18 10:05:09 +02:00
.gitignore add collect_changelogs.py script to collect and transform release logs. 2020-03-26 20:12:37 +01:00
collect_api_endpoints.in collect_api_endpoints.py: extend script with support for abstract classes, add used model when using standard templates. 2020-04-07 20:44:03 +02:00
collect_api_endpoints.py support - add list of supported community plugins and their tier including a script to collect them 2023-01-24 22:18:50 +01:00
collect_changelogs.py fix links (and code responsible for generating) 2023-12-12 13:55:55 +01:00
collect_plugin_tiers.py support - add list of supported community plugins and their tier including a script to collect them 2023-01-24 22:18:50 +01:00
CONTRIBUTING.md add CONTRIBUTING.md 2021-01-28 12:56:08 +01:00
LICENSE Many typo fixes and some rewording (#80) 2018-11-08 20:59:18 +01:00
Makefile Makefile: use all available cores by default 2023-07-13 13:34:20 +02:00
README.md Update README.md (#544) 2024-03-13 17:36:04 +01:00
requirements.txt sphinx_rtd_theme==0.5.2 << version 1.0.0 doesn't render correctly 2021-11-23 16:46:32 +01:00

alt text

OPNsense documentation

Welcome to the OPNsense documentation & wiki.
The purpose of this project is to provide OPNsense users with quality documentation.


You can contribute to the project in many ways, e.g. testing functionality, sending in bug reports or creating pull requests directly via GitHub. Any help is always very welcome!


OPNsense documentation is available under the 2-Clause BSD license:


Every contribution made to the project must be licensed under the same conditions in order to keep OPNsense truly free and accessible for everybody.

Some pictures are licensed under the Creative Commons Zero (CC0) license:


Logos may be subject to additional copyrights, property rights, trademarks etc. and may require the consent of a third party or the license of these rights. Deciso B.V. does not represent or make any warranties that it owns or licenses any of the mentioned, nor does it grant them.

Prepare build

On FreeBSD the following packages are required:

pkg install py39-pip jpeg-turbo gmake

Install Sphinx, our default theme and contrib packages:

pip[3] install -r requirements.txt --upgrade

Update API endpoints

A script is provided to update the api endpoint documentation, this can be executed using:

./collect_api_endpoints.py --repo core /path/to/core/repository
./collect_api_endpoints.py --repo plugins /path/to/plugins/repository

Generate HTML documents

make html

(make clean to flush)

Live preview of HTML documents

Use sphinx-autobuild to track source for changes and get a live preview served via http://localhost:8000.

pip[3] install sphinx-autobuild
sphinx-autobuild source html