initial commit

2026-06-02 01:00:27 +02:00
commit d2a8072a47
64 changed files with 26467 additions and 0 deletions
@@ -0,0 +1,57 @@
+# IP Addresses (IPAM)
+
+The IP Address tool provides a central place to store and manage the public IP addresses of your servers, VPSs, and services across different vendors. It also cross-references each IP against your locally cached DNS records to show which domains currently point to it.
+
+---
+
+## Accessing the tool
+
+Navigate to **🖥️ IP Addresses** in the sidebar under the **Tools** section.
+
+---
+
+## IP address fields
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| IP Address | Yes | An IPv4 or IPv6 address. Cannot be changed after creation — delete and re-add if the address changes. |
+| Label | No | A friendly name, e.g. `Web Server 1` or `VPN Gateway` |
+| Vendor / Provider | No | The hosting provider, e.g. `Hetzner`, `DigitalOcean`, `AWS` |
+| Location / Region | No | The server location, e.g. `Frankfurt`, `US-East` |
+| Notes | No | Any additional free-text notes (shown as an ℹ icon in the table) |
+
+Both **IPv4** (shown in blue) and **IPv6** (shown in purple) addresses are supported.
+
+---
+
+## DNS cross-reference
+
+The **DNS Records** column automatically scans the locally cached DNS records and shows any **A** or **AAAA** records whose value matches the stored IP address. Each match displays the provider badge and the full domain name.
+
+This makes it easy to see at a glance which domains are pointing to a given server, and to spot IPs that are not referenced by any DNS records.
+
+> **Note:** The cross-reference is based on the local DNS cache. Sync the relevant zones to ensure the data is up to date.
+
+---
+
+## Filtering
+
+Use the filter bar to search across IP address, label, vendor, and location fields simultaneously.
+
+---
+
+## Export
+
+Press **⬇ Export CSV** to download the current (filtered) list as a CSV file. The export includes the IP address, label, vendor, location, notes, and the matching DNS records as a semicolon-separated string.
+
+---
+
+## Audit log
+
+All IP address changes (add, update, delete) are recorded in **📋 Audit Log** under the category **IP Address**.
+
+---
+
+## Data storage
+
+IP addresses are stored in `backend/ipam.json`. This file is created automatically on first use. The path can be overridden with the `IPAM_PATH` environment variable — see `ENVIRONMENT.md` for details.