> 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/sitemap.md). # NetMap Documentation Sitemap This is the complete human-readable tree used for published documentation navigation. It describes the production NetMap `v1.5.0` product as it existed at the time of writing. Internal authoring trackers are intentionally excluded. ## Orientation * [NetMap](/netmap.md) * [How to Use This Documentation](/orientation/how-to-use-this-documentation.md) * [Documentation Version and Product Compatibility](/orientation/documentation-version-compatibility.md) * [Quick Links by Goal](/orientation/quick-links.md) * [NetMap Documentation Sitemap](/orientation/sitemap.md) * [Documentation Changelog](/orientation/documentation-changelog.md) * [Reporting Documentation Problems](/orientation/reporting-documentation-problems.md) ## Product Introduction * [Product Overview and Architecture](/product-introduction/introduction.md) * [What Is NetMap?](/product-introduction/what-is-netmap.md) * [Features](/product-introduction/features.md) * [Architecture](/product-introduction/architecture.md) * [Supported Use Cases](/product-introduction/supported-use-cases.md) * [Terminology](/product-introduction/terminology.md) ## Installation * [Installation](/installation/installation.md) * [Quick Start](/installation/quick-start.md) * [Docker Compose](/installation/docker-compose.md) * [Docker](/installation/docker.md) * [Native Installation](/installation/native-installation.md) * [Reverse Proxy And HTTPS](/installation/reverse-proxy.md) * [Upgrading](/installation/upgrading.md) * [Backup And Restore](/installation/backup-and-restore.md) ## Configuration * [Configuration Reference](/configuration/configuration.md) * [Environment Variables](/configuration/environment-variables.md) * [Storage](/configuration/storage.md) * [Ports](/configuration/ports.md) * [OIDC SSO](/configuration/oidc-sso.md) * [Syslog](/configuration/syslog.md) ## Using NetMap * [Using The Application](/using-netmap/user-guide.md) * [Interface Overview](/using-netmap/interface-overview.md) * [Dashboard](/using-netmap/dashboard.md) * [Topology](/using-netmap/topology.md) * [Inventory](/using-netmap/inventory.md) * [VLANs And Groups](/using-netmap/vlans.md) * [Locations](/using-netmap/locations.md) * [Monitoring](/using-netmap/monitoring.md) * [IPAM](/using-netmap/ipam.md) * [Security Events](/using-netmap/security-events.md) * [Tools](/using-netmap/tools.md) * [Exports](/using-netmap/exports.md) * [Administration](/using-netmap/admin.md) * [Profile](/using-netmap/profile.md) ## Guides * [Add A Device](/guides/add-device.md) * [Import Devices](/guides/import-devices.md) * [Run Discovery](/guides/run-discovery.md) * [Review Discovery Observations](/guides/scheduled-discovery-observations.md) * [Share A Topology Layout](/guides/share-topology-layout.md) * [Configure Service Checks](/guides/configure-service-checks.md) * [Create An Alert Rule](/guides/create-alert-rule.md) * [Import DHCP Leases](/guides/import-dhcp-leases.md) * [Create An IP Reservation](/guides/create-ip-reservation.md) * [Search Syslog Events](/guides/search-syslog.md) * [Export Data](/guides/export-data.md) * [Automation With API Keys](/guides/automation-with-api-keys.md) ## API * [API Overview](/api/api-overview.md) * [API Keys](/api/api-keys.md) * [API Authentication](/api/authentication.md) * [Generating API Keys](/api/generating-api-keys.md) * [Using API Keys](/api/using-api-keys.md) * [API-Key Permissions](/api/api-key-permissions.md) * [Rotating API Keys](/api/rotating-api-keys.md) * [Revoking API Keys](/api/revoking-api-keys.md) * [API Errors](/api/errors.md) * [Rate Limits](/api/rate-limits.md) * [OpenAPI And Swagger](/api/openapi-swagger.md) * [Capability Matrix](/api/capability-matrix.md) * [Endpoint Inventory](/api/api-reference.md) * [Endpoint Reference](/api/endpoint-reference.md) ## Operations * [Operations](/operations/operations.md) * [Health Checks](/operations/health-checks.md) * [Logging](/operations/logging.md) * [Backups](/operations/backups.md) * [Restores](/operations/restores.md) * [Database Migrations](/operations/database-migrations.md) * [Monitoring NetMap](/operations/monitoring-netmap.md) * [Disaster Recovery](/operations/disaster-recovery.md) ## Troubleshooting * [Common Issues](/troubleshooting/common-issues.md) * [Installation Problems](/troubleshooting/installation-problems.md) * [Authentication Problems](/troubleshooting/authentication-problems.md) * [API-Key Problems](/troubleshooting/api-key-problems.md) * [Permission Errors](/troubleshooting/permission-errors.md) * [Database Problems](/troubleshooting/database-problems.md) * [Reverse Proxy Problems](/troubleshooting/reverse-proxy-problems.md) * [Container Problems](/troubleshooting/container-problems.md) * [Diagnostic Information](/troubleshooting/diagnostic-information.md) ## Security * [Security Overview](/security/security.md) * [Security Model](/security/security-model.md) * [API-Key Security](/security/api-key-security.md) * [Permissions](/security/permissions.md) * [Secrets Management](/security/secrets-management.md) * [Network Exposure](/security/network-exposure.md) * [Vulnerability Reporting](/security/vulnerability-reporting.md) ## Development * [Developer Guide](/development/development.md) * [Local Development](/development/local-development.md) * [Repository Structure](/development/repository-structure.md) * [Backend Development](/development/backend-development.md) * [Frontend Development](/development/frontend-development.md) * [Testing](/development/testing.md) * [Adding API Endpoints](/development/adding-api-endpoints.md) * [Database Changes](/development/database-changes.md) * [Contributing Workflow](/development/contributing-workflow.md) ## Reference * [Default Values](/reference/default-values.md) * [File And Directory Paths](/reference/file-paths.md) * [Ports](/reference/ports.md) * [Glossary](/reference/glossary.md) * [Changelog](/reference/changelog.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/sitemap.md?ask=&goal= ``` `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.