You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Nic Biddell 74b13d12d5
Fix spelling (#439)
3 days ago
.github/ISSUE_TEMPLATE add issue templates 2 years ago
source Fix spelling (#439) 3 days ago
.gitignore add collect_changelogs.py script to collect and transform release logs. 3 years ago
CONTRIBUTING.md add CONTRIBUTING.md 2 years ago
LICENSE Many typo fixes and some rewording (#80) 4 years ago
Makefile Initial version of the freely available OPNsense documentation project, original commiters are listed in LICENSE file. 5 years ago
README.md README: we are on 3.9 in FreeBSD now 2 months ago
collect_api_endpoints.in collect_api_endpoints.py: extend script with support for abstract classes, add used model when using standard templates. 3 years ago
collect_api_endpoints.py collect_api_endpoints.py - minor bug fixes (incorrect method) 1 month ago
collect_changelogs.py changelogs - better handle BE 2 years ago
requirements.txt sphinx_rtd_theme==0.5.2 << version 1.0.0 doesn't render correctly 1 year ago

README.md

alt text

OPNsense documentation

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

Contribute

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!

License

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

http://opensource.org/licenses/BSD-2-Clause

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:

https://creativecommons.org/publicdomain/zero/1.0/

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)