Archives/opensense-docs
2
0
Fork 0
mirror of https://github.com/opnsense/docs synced 2024-10-30 21:20:20 +00:00
Code Issues Projects Releases Wiki Activity
766 Commits 5 Branches 0 Tags 555 MiB
Python 62.9%
DTrace 12.8%
CSS 12.6%
Makefile 11.7%
106cf9fc0e
Go to file
Daniel Melzak 106cf9fc0e
Some warnings and an example for clarity (#444) 
* Some warnings and an example for clarity 

Added a warning about overlapping networks for the LAN and Wireguard interfaces, as doing so will cause the clients not to be able to communicate with each other properly. Added an example to request another PD from your ISP, as ATT only hands out /64s and one will not be enough to subnet the networks properly.

* Clarification and briefness

Tried to add just enough information to clarify that it is a completely separated network that requires routing to reach the LAN interface.
2022-12-31 09:40:29 +01:00
.github/ISSUE_TEMPLATE add issue templates 2021-01-28 13:12:17 +01:00
source Some warnings and an example for clarity (#444) 2022-12-31 09:40:29 +01: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 collect_api_endpoints.py - minor bug fixes (incorrect method) 2022-10-19 17:20:19 +02:00
collect_changelogs.py changelogs - better handle BE 2021-04-12 14:37:26 +02: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 Initial version of the freely available OPNsense documentation project, original commiters are listed in LICENSE file. 2018-01-30 11:40:13 +01:00
README.md README: we are on 3.9 in FreeBSD now 2022-09-30 14:44:35 +02: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

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)