> For the complete documentation index, see [llms.txt](https://docs.netmap.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.netmap.dev/orientation/documentation-version-compatibility.md).

# Documentation Version and Product Compatibility

Use the version installed in your NetMap instance—not the newest version advertised online—to decide whether a procedure applies. No NetMap permission is required to read this page.

> **Version basis:** This documentation was based on the production release of NetMap `v1.5.0` at the time of writing. A page-level `verified_version` records the production version used for that page. It does not guarantee compatibility with another release.

## Find your installed version

After signing in, look at the version near the bottom of the NetMap sidebar. A SuperAdmin can also open **Admin → System** and read **Version → Installed**.

For the production release covered here, the interface displays `v1.5.0`. The installed version is read from the version file baked into the application image.

The `GET /api/v1/system/version` endpoint supplies the installed version to the interface. It also checks GitHub tags for a newer semantic version. That online check can fail without changing the installed version; the Admin page then shows the latest version as unavailable.

## Interpret page labels

Reviewed pages use frontmatter such as:

```yaml
verified_version: "1.5.0"
```

The value `1.5.0` means the page was checked against production NetMap v1.5.0. An absent `verified_version` means the page has not yet completed the current page-level source review.

This site documents the production product. Contributor builds and changes awaiting review may behave differently; use the [Contributing Workflow](/development/contributing-workflow.md) when testing a source change.

## Choose the correct instructions

1. Record the version shown by your instance.
2. Check the page's `verified_version` or version note.
3. Prefer an exact version match.
4. If the page is newer, review the product [Changelog](/reference/changelog.md) and compare the described controls with your interface before acting.
5. For upgrades and restores, follow instructions that cover both the version you are moving **from** and the version you are moving **to**; database and secret-handling changes can make assumptions unsafe.

## When the interface and documentation disagree

* Confirm that your browser is connected to the intended NetMap instance.
* Use the installed label, not a cached Docker tag or the newest GitHub tag.
* Refresh the page after an image upgrade and confirm that the container was recreated from the pulled image.
* Check whether you are running `latest`, a fixed production version tag, or a locally built image.
* Search the [Documentation Changelog](/orientation/documentation-changelog.md) for a correction or coverage change.
* If the discrepancy remains, [report a documentation problem](/orientation/reporting-documentation-problems.md) with the page URL and your installed version.

Do not include API keys, secrets, database files, private addresses, raw syslog, or unsanitized screenshots in a public report.

## Related pages

* [How to Use This Documentation](/orientation/how-to-use-this-documentation.md)
* [Documentation Changelog](/orientation/documentation-changelog.md)
* [Reporting Documentation Problems](/orientation/reporting-documentation-problems.md)
* [Product Changelog](/reference/changelog.md)
* [Upgrading](/installation/upgrading.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.netmap.dev/orientation/documentation-version-compatibility.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.