# NETMapper documentation (netmapper.nx1xlab.dev/docs)

NETMapper reaches your switches over SSH or SNMP, reads their MAC and ARP tables
and their LLDP/CDP neighbors, and builds a live inventory of every connected
device along with the topology that links them. It watches for changes and
raises alerts over email, Slack, Teams, webhooks, Telegram, Discord,
Mattermost, PagerDuty and OpsGenie, and a read-only AI assistant answers
questions about the same inventory the dashboard shows. It is self-hosted and
free software under AGPL-3.0: no cloud, no per-seat licensing, and nothing
about your network leaves your deployment.

These guides cover running it yourself. They follow the product repository,
which stays the ground truth: if a guide and the code disagree, the code
wins, and a bug report is welcome.

## Project links

- [Repository on GitHub](https://github.com/NX1X/NETMapper): source, releases
  and the full documentation tree.
- [Issues](https://github.com/NX1X/NETMapper/issues/new/choose): bugs,
  questions and feature requests. Security reports go through a private
  advisory instead, see the security guide.
- [CHANGELOG](https://github.com/NX1X/NETMapper/blob/main/CHANGELOG.md): what
  changed in each release, and the breaking changes to read before an
  upgrade.
- [Releases](https://github.com/NX1X/NETMapper/releases): version tags, image
  digests and the quickstart zip.

## Documentation contents

### Getting started

- [Install](https://netmapper.nx1xlab.dev/docs/install): Pick the deployment shape you want. Every path below is self-contained, with copy-paste commands.

### Configuration

- [Configuration](https://netmapper.nx1xlab.dev/docs/configuration): Every environment variable in .env.example, what it does, and what it defaults to.

### Running it

- [Operations](https://netmapper.nx1xlab.dev/docs/operations): Upgrades, backups, restore, rollback, diagnostics, and where your data lives.

### Reference

- [Security and privacy](https://netmapper.nx1xlab.dev/docs/security): The security posture, how to report a vulnerability, and exactly what telemetry sends.