|Stephan de Wit 25995b591e||3 days ago|
|.github/ISSUE_TEMPLATE||1 month ago|
|source||3 days ago|
|.gitignore||12 months ago|
|CONTRIBUTING.md||1 month ago|
|LICENSE||2 years ago|
|Makefile||3 years ago|
|README.md||4 weeks ago|
|collect_api_endpoints.in||11 months ago|
|collect_api_endpoints.py||11 months ago|
|collect_changelogs.py||4 weeks ago|
|requirements.txt||1 year ago|
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
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.
On FreeBSD the following packages are required:
pkg install py37-pip jpeg-turbo gmake
Install Sphinx, our default theme and contrib packages:
pip install -r requirements.txt --upgrade
A script is provided to update the api endpoint documentation, this can be
./collect_api_endpoints.py --repo core /path/to/core/repository ./collect_api_endpoints.py --repo plugins /path/to/plugins/repository
make clean to flush)