Skip to main content

Documentation Versions and Maintenance

What the current manual describes

The default manual on oxidns.org follows the OxiDNS repository main branch and is labeled current / Next inside Docusaurus. It therefore describes mainline capabilities and may include fields, plugins, or behavior not yet present in your installed release.

The site does not currently publish a frozen snapshot for every release. To reproduce a historical version, switch to the matching Git tag and read its README.md, docs/, config.yaml, and release notes.

Confirm deployment capabilities

Do not infer local capabilities from the website, archive name, or image tag alone. Check them in this order:

oxidns --version
oxidns build-info
oxidns check -c /path/to/config.yaml -d /working/directory
  • --version identifies the release.
  • build-info identifies the bundle, Cargo features, protocols, and compiled plugins.
  • check confirms that this binary can read the real configuration and working-directory resources.
  • Release Notes record behavior changes, migration requirements, and release scope.

Sources and maintenance ownership

ContentCanonical sourceSynchronization requirement
Runnable default configurationRepository-root config.yamlField, plugin, and default changes update the manual and WebUI definitions
Plugin types and compiled capabilitiesRust plugin registry and Cargo featuresContent checks jointly enforce the overview, category catalogs, and bilingual references
CLI / API behaviorCurrent binary implementationInterface changes update topic pages, examples, and migration notes together
Release historyGit tags and release notesCompleted work belongs in release notes instead of accumulating in the roadmap
Internal maintenance workflowsai/ and AGENTS.mdNot published as end-user manual content

Follow Contributing to report a documentation issue. Include the OxiDNS version, bundle, target platform, affected page, and a reproducible configuration excerpt, with credentials, private domains, and client data removed.