71ece67d04
* Update caddy.rst - Some terminology changes for the new os-caddy version. * Update caddy.rst - Small Typo fixed. * Update caddy.rst - DNS01 is not needed for Dynamic DNS to work * Update caddy.rst - Another small typo. * Update caddy.rst Add HTTP-01 challenge redirection option * Update caddy.rst - Added Tutorial section for the HTTP-01 challenge redirection - A few more changes to get the docs in line with the new os-caddy-1.5.3 update * Update caddy.rst - Add HTTP Response Code and Message * Update caddy.rst - Add Header Manipulation * Update caddy.rst - Added short tutorial how to use the most common header manipulation. * Update caddy.rst - Improve header manipulation tutorial with the most common usecase, reverse proxying to an upstream webserver with vhosts. * Update caddy.rst - Format fix * Update caddy.rst - Add new fields for forward_auth support * Update caddy.rst - Add configuration example for Authelia * Update caddy.rst - Reformat doc * Update caddy.rst * Update caddy.rst - Again a few typos * Revert all changes regarding forward_auth in caddy.rst Since implementing this feature properly would take a redesign how the current handle/reverse_proxy structure works, it is unfeasible for now. I am unsure the usecase is really there either. With basic_auth implemented, it's far easier to restrict access in a less convoluted way. Combining basic_auth with http logs and crowdsec, makes bruteforcing also impossible, IP addresses are banned quite swiftly. * Update source/manual/how-tos/caddy.rst - Typo Co-authored-by: Dany Marcoux <github@dmarcoux.com> * Update source/manual/how-tos/caddy.rst - Typo Co-authored-by: Dany Marcoux <github@dmarcoux.com> --------- Co-authored-by: Dany Marcoux <github@dmarcoux.com> |
2 months ago | |
---|---|---|
.github/ISSUE_TEMPLATE | 3 years ago | |
source | 2 months ago | |
.gitignore | 4 years ago | |
CONTRIBUTING.md | 3 years ago | |
LICENSE | 6 years ago | |
Makefile | 11 months ago | |
README.md | 3 months ago | |
collect_api_endpoints.in | 4 years ago | |
collect_api_endpoints.py | 1 year ago | |
collect_changelogs.py | 6 months ago | |
collect_plugin_tiers.py | 1 year ago | |
requirements.txt | 3 years ago |
README.md
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)
Live preview of HTML documents
Use sphinx-autobuild
to track source
for changes and get a live preview served via http://localhost:8000
.
pip[3] install sphinx-autobuild
sphinx-autobuild source html