Archives
/
opensense-docs
mirror of https://github.com/opnsense/docs
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
817 Commits
4 Branches
0 Tags
616 MiB
Python 69.1%
DTrace 15.7%
Makefile 14.4%
CSS 0.8%
 
 
 
 
master
dashboard
BGP_ASN_Alias_FR5913
rss
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '18b58b320a'
${ noResults }
Go to file
Ad Schellevis 18b58b320a Squashed commit of the following: 
commit 4fc58db7f361fca140119665107f562333ec416c
Author: Ad Schellevis <ad@opnsense.org>
Date:   Fri Apr 7 18:52:35 2023 +0200

    minor compile issue in https://github.com/opnsense/docs/pull/465

commit 5859bb84be40f20358549ec014f571e9c70858da
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Apr 4 17:08:55 2023 +0200

    troubleshooting : add webgui recovery help, ipsec: explain async crypto a bit better

commit b2189c500314e67607952fd8eae68ccea72a3e17
Author: Ad Schellevis <ad@opnsense.org>
Date:   Wed Mar 29 16:27:46 2023 +0200

    VPN/IPsec/Examples - add a note about connecting childre. closes https://github.com/opnsense/core/issues/6451

commit e0bb5a46fe8cd46334b3849503b29aa4c28a4ff2
Author: Ad Schellevis <ad@opnsense.org>
Date:   Wed Mar 29 14:26:56 2023 +0200

    changelogs

commit b002a92e8e2cbd202e23d823079a5c69aa8e4d5c
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Mar 28 17:03:30 2023 +0200

    System/Settings/Administration - minor fixes

commit e6c02aa1864c1f229e33f2046272351f4a25ef8a
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Mar 28 16:48:45 2023 +0200

    System/Settings/Administration - reorganise settings a bit and add missing options. Also explain the risks of using "listen interfaces" and how to properly use them. Loopbacks are intended to create the environment needed to reliably bind a service in a changing world.

commit 1fae5cc8a81fda2ba790c2e3cfc357f46f2c6d8b
Author: Stephan <stephan.de.wit@deciso.com>
Date:   Tue Mar 28 16:24:13 2023 +0200

    unbound: update reporting/advanced/blocklist documentation

commit 8ffa3e1565bff8b8ffb986d7dd447e7f5371805f
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Mar 28 08:58:44 2023 +0200

    update api endpoints

commit 07f9f614b6fa49847bd78b013d8c664c3ac50940
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Mar 28 08:56:00 2023 +0200

    changelogs

commit f234f235b404a25e7b9af8ca27796369b53a0277
Author: Ad Schellevis <ad@opnsense.org>
Date:   Mon Mar 27 17:38:49 2023 +0200

    Access / Servers / Radius - add mnissing options

commit f6fc23f09ea2ec3b626f07ab92bac7b2e04e0001
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Mar 21 16:57:03 2023 +0100

    changelogs

commit 831b0d54a209b13c54e9f4272a705d198cab86b2
Author: Ad Schellevis <ad@opnsense.org>
Date:   Tue Mar 21 16:36:02 2023 +0100

    IPS: change Emerging Threats documentation links

commit 1ed441a7fcce20a33d5c9eaccc0d63af663b9332
Author: Ad Schellevis <ad@opnsense.org>
Date:   Fri Mar 17 15:30:16 2023 +0100

    Interfaces: Diagnostics: Ping - update documentation, closes https://github.com/opnsense/core/issues/6378

commit f7e4ee76c158f2a0b73ae5a74c77ecb451b5dbd7
Author: Ad Schellevis <ad@opnsense.org>
Date:   Thu Mar 16 21:59:34 2023 +0100

    Interfaces: Diagnostics: Ping - documentation for https://github.com/opnsense/core/issues/6378

commit 82e2801b67
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Fri Apr 7 00:21:10 2023 +0300

    Update zenarmor_hardwarerequirements.rst

    Hardware Requirements content updated

commit 72e65f07e3
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Thu Apr 6 15:51:35 2023 +0300

    Update zenarmor_hardwarerequirements.rst

    HW req. Table Updated

commit 2d8e780e62
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 14:49:39 2023 +0300

    Update zenarmor.rst

commit 59cde54661
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 14:43:18 2023 +0300

    Update zenarmor_install.rst

commit 13a60a4564
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 14:38:36 2023 +0300

    Update zenarmor.rst

commit 9fd1a80b34
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 14:35:54 2023 +0300

    Update zenarmor.rst

commit 5f08f24b5f
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 14:28:47 2023 +0300

    Update zenarmor.rst

commit 29e34ff9c2
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:33:23 2023 +0300

    Update zenarmor_install.rst

commit b4e97197f1
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:28:16 2023 +0300

    Update zenarmor.rst

commit 4b36e1f03e
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:21:25 2023 +0300

    Update zenarmor.rst

commit a20fd312d0
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:16:38 2023 +0300

    Update zenarmor.rst

commit 647a134479
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:16:11 2023 +0300

    Update zenarmor.rst

    Feature list is updated

commit b573a10a2d
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:12:12 2023 +0300

    Update zenarmor.rst

    Youtube URL Updated

commit e9d2a63c00
Merge: e132115 f3c6e5b
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Tue Mar 14 02:10:46 2023 +0300

    Merge branch 'opnsense:master' into master

commit e132115879
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Mon Nov 7 15:32:39 2022 +0300

    Update zenarmor_install.rst

commit e348b92a5b
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Mon Nov 7 15:25:03 2022 +0300

    Update zenarmor_install.rst

commit 0709b7a09a
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Fri Nov 4 15:41:44 2022 +0300

    Update zenarmor_install.rst

commit b64a2e497b
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Fri Nov 4 15:38:05 2022 +0300

    Update zenarmor_install.rst

commit 3f660a01e8
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Fri Nov 4 15:16:46 2022 +0300

    Update zenarmor_hardwarerequirements.rst

commit 2d3883035d
Author: zenarmor <117448597+zenarmor@users.noreply.github.com>
Date:   Fri Nov 4 15:04:34 2022 +0300

    Update zenarmor_hardwarerequirements.rst
 		1 year ago
.github/ISSUE_TEMPLATE add issue templates 3 years ago
source Squashed commit of the following: 1 year ago
.gitignore add collect_changelogs.py script to collect and transform release logs. 4 years ago
CONTRIBUTING.md add CONTRIBUTING.md 3 years ago
LICENSE Many typo fixes and some rewording (#80) 6 years ago
Makefile Initial version of the freely available OPNsense documentation project, original commiters are listed in LICENSE file. 6 years ago
README.md README: we are on 3.9 in FreeBSD now 2 years ago
collect_api_endpoints.in collect_api_endpoints.py: extend script with support for abstract classes, add used model when using standard templates. 4 years ago
collect_api_endpoints.py support - add list of supported community plugins and their tier including a script to collect them 1 year ago
collect_changelogs.py changelogs - better handle BE 3 years ago
collect_plugin_tiers.py support - add list of supported community plugins and their tier including a script to collect them 1 year ago
requirements.txt sphinx_rtd_theme==0.5.2 << version 1.0.0 doesn't render correctly 3 years 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)