{"id":13491671,"url":"https://github.com/opnsense/docs","last_synced_at":"2025-05-16T00:05:49.643Z","repository":{"id":38237871,"uuid":"119515584","full_name":"opnsense/docs","owner":"opnsense","description":"OPNsense documentation","archived":false,"fork":false,"pushed_at":"2025-05-12T12:42:26.000Z","size":242474,"stargazers_count":134,"open_issues_count":21,"forks_count":201,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-05-12T13:47:21.456Z","etag":null,"topics":["documentation","howto","manual","opnsense"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opnsense.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-01-30T09:45:25.000Z","updated_at":"2025-05-12T12:42:30.000Z","dependencies_parsed_at":"2025-05-12T13:44:18.300Z","dependency_job_id":null,"html_url":"https://github.com/opnsense/docs","commit_stats":{"total_commits":1175,"total_committers":158,"mean_commits":7.436708860759493,"dds":"0.47744680851063825","last_synced_commit":"9bd6feb2d7ee4fad738b95f07b0d4e7ad632ffae"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opnsense%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opnsense%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opnsense%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opnsense%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opnsense","download_url":"https://codeload.github.com/opnsense/docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442854,"owners_count":22071878,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","howto","manual","opnsense"],"created_at":"2024-07-31T19:00:59.242Z","updated_at":"2025-05-16T00:05:44.630Z","avatar_url":"https://github.com/opnsense.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"![alt text](https://opnsense.org/wp-content/themes/OPNsense/assets/img/opnsense.png \"Logo Title Text 1\")\n\n# OPNsense documentation\n\nWelcome to the OPNsense documentation \u0026 wiki.   \nThe purpose of this project is to provide OPNsense users with quality documentation.\n\n## Contribute\n\nYou can contribute to the project in many ways, e.g. testing\nfunctionality, sending in bug reports or creating pull requests\ndirectly via GitHub.  Any help is always very welcome!\n\n## License\n\nOPNsense documentation is available under the 2-Clause BSD license:\n\nhttps://opensource.org/licenses/BSD-2-Clause\n\nEvery contribution made to the project must be licensed under the\nsame conditions in order to keep OPNsense truly free and accessible\nfor everybody.\n\nSome pictures are licensed under the Creative Commons Zero (CC0) license:\n\nhttps://creativecommons.org/publicdomain/zero/1.0/\n\nLogos may be subject to additional copyrights, property\nrights, trademarks etc. and may require the consent of a third party or the\nlicense of these rights. Deciso B.V. does not represent or make any warranties\nthat it owns or licenses any of the mentioned, nor does it grant them.\n\n#### Prepare build\n\nOn FreeBSD the following packages are required:\n\n```\npkg install python py311-pip jpeg-turbo gmake\n```\n\nInstall Sphinx, our default theme and contrib packages:\n\n```\npip install -r requirements.txt --upgrade\n```\n\n### Update API endpoints\n\nA script is provided to update the api endpoint documentation, this can be\nexecuted using:\n\n```\n./collect_api_endpoints.py --repo core /path/to/core/repository\n./collect_api_endpoints.py --repo plugins /path/to/plugins/repository\n```\n\n#### Generate HTML documents\n\n```\ngmake html\n```\n\n(```gmake clean``` to flush)\n\n#### Live preview of HTML documents\n\nUse `sphinx-autobuild` to track `source` for changes and get a live preview served via ``http://localhost:8000``.\n\n```\npip install sphinx-autobuild\n```\n\n```\nsphinx-autobuild source build/html\n```\n\n#### Publish BIOS ROM Images\n\nBIOS ROM images are written to Deciso appliances using a FAT32 formatted (thumb) drive containing in its root directory\nthe combined contents of the `source/hardware/files/BIOS_update_sources.zip` file and the latest platform-specific\ncompressed BIOS ROM image. The BIOS_update_sources directory contains the EFI boot structure to trigger the\n`startup.nsh` file when booting from the drive and kickstart the update using the `LATEST.FD` file.\n\nThe SHA256 hash of the `BIOS_update.sources.zip` file:\n\n```\n0cf1b042223482ea073a7a3599d6170be7c849ff8399936cf5a9db1ec5406dcf  BIOS_update_sources.zip\n```\n\nTo create a publishable archive, use the provided `make_bios.py` script and give it the platform type, version number and\nsource `.fd` file:\n\n```\n./make_bios.py --platform \u003cA10|A20|A30\u003e --version \u003cversion\u003e --source \u003c.FD filename\u003e\n```\n\nExample output:\n\n```\n2d5143f221fa120ef6d5c8799a90bd2c08e8238b3b9dd350327336d0605944a6 source/hardware/files/A10_v30_bios.tar.gz\n```\n\nA SHA256 hash of the resulting compressed archive is provided for integrity checking.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopnsense%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopnsense%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopnsense%2Fdocs/lists"}