Skip to content

NethServer/nethsecurity-docs

Repository files navigation

NethSecurity documentation

Docusaurus-based documentation for NethSecurity, the Unified Threat Management solution based on OpenWrt.

Development

Requires Node.js >= 18.

yarn install      # install dependencies
yarn start        # local dev server with hot reload
yarn build        # production build (validates MDX, links and anchors)
yarn serve        # serve the production build locally

yarn start and yarn build first run scripts/generate-version-data.mjs, which fetches the latest NethSecurity release and the download tables into src/data/versions.json.

Structure

  • docs/administrator-manual/ — install, configure and manage NethSecurity
  • docs/tutorial/ — step-by-step guides
  • src/ — theme, components and pages
  • static/ — images and other static assets
  • scripts/ — build-time data generation and the one-shot RST migration script

See AGENTS.md for contributor and conventions detail.

License

See LICENSE.

About

NethSecurity documentation

Resources

License

Security policy

Stars

7 stars

Watchers

7 watching

Forks

Contributors