mirror of
https://github.com/opnsense/docs.git
synced 2026-04-15 21:49:34 -04:00
da2bf2c8d5
* Update README.md * Update README.md Remove exact FreeBSD version --------- Co-authored-by: tinyboxvk <tinyboxvk@users.noreply.github.com>
103 lines
3 KiB
Markdown
103 lines
3 KiB
Markdown
|
|
|
|
# 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:
|
|
|
|
https://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 python py311-pip jpeg-turbo gmake
|
|
```
|
|
|
|
Install Sphinx, our default theme and contrib packages:
|
|
|
|
```
|
|
pip 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
|
|
|
|
```
|
|
gmake html
|
|
```
|
|
|
|
(```gmake 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 install sphinx-autobuild
|
|
```
|
|
|
|
```
|
|
sphinx-autobuild source build/html
|
|
```
|
|
|
|
#### Publish BIOS ROM Images
|
|
|
|
BIOS ROM images are written to Deciso appliances using a FAT32 formatted (thumb) drive containing in its root directory
|
|
the combined contents of the `source/hardware/files/BIOS_update_sources.zip` file and the latest platform-specific
|
|
compressed BIOS ROM image. The BIOS_update_sources directory contains the EFI boot structure to trigger the
|
|
`startup.nsh` file when booting from the drive and kickstart the update using the `LATEST.FD` file.
|
|
|
|
The SHA256 hash of the `BIOS_update.sources.zip` file:
|
|
|
|
```
|
|
0cf1b042223482ea073a7a3599d6170be7c849ff8399936cf5a9db1ec5406dcf BIOS_update_sources.zip
|
|
```
|
|
|
|
To create a publishable archive, use the provided `make_bios.py` script and give it the platform type, version number and
|
|
source `.fd` file:
|
|
|
|
```
|
|
./make_bios.py --platform <A10|A20|A30> --version <version> --source <.FD filename>
|
|
```
|
|
|
|
Example output:
|
|
|
|
```
|
|
2d5143f221fa120ef6d5c8799a90bd2c08e8238b3b9dd350327336d0605944a6 source/hardware/files/A10_v30_bios.tar.gz
|
|
```
|
|
|
|
A SHA256 hash of the resulting compressed archive is provided for integrity checking.
|