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.
Ad Schellevis af37b6cf37 add loopback to other-interfaces 5 days ago
source add loopback to other-interfaces 5 days ago
themes/opnsense/sass Fix #83: Very long words can run out of container 11 months ago
.gitignore Add Third-party section + Sunnyvalley / Sensei (#190) 4 months ago
LICENSE Many typo fixes and some rewording (#80) 1 year ago
Makefile Initial version of the freely available OPNsense documentation project, original commiters are listed in LICENSE file. 1 year ago Another round of corrections (#84) 1 year ago
requirements.txt add sitemap 6 months ago

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

Install Sphinx, our default theme and contrib packages

pip install -r requirements.txt

Generate HTML documents

make html

(make clean to flush)

Changing theme

Install required stylesheets using bower

bower install wyrm
bower install robotoslab-googlefont
bower install inconsolata-googlefont
bower install font-awesome#4.7.0

(for font-awesome, choose newest)

Build your theme:

``` sass -I bower_components/wyrm/sass/ -I bower_components/bourbon/dist/ -I bower_components/neat/app/assets/stylesheets/ -I bower_components/font-awesome/scss/ themes/opnsense/sass/theme.sass > source/_static/css/opnsense.css