Documentation
Everything you need to install, configure, and operate Simple PHP IPAM.
Installation
Requirements, web server setup (Apache, nginx, Caddy, OLS), file permissions, and first login steps.
→Configuration
Settings UI walkthrough and all configuration keys explained — SMTP, OIDC, housekeeping, scanning.
→Upgrading
Using upgrade.sh, CLI migration utilities, v3.0 breaking changes, and multi-engine migration paths.
→REST API
Authentication, all endpoints, query filters, pagination, bulk write, and example curl calls.
→OIDC Authentication
SSO setup, IdP-specific examples (Keycloak, Authentik, Azure AD, Google), user provisioning and auto-link.
→Security
HTTPS enforcement, rate limiting, session hardening, audit log, API key management, and security headers.
→SMTP Configuration
Direct SMTP setup with TLS/STARTTLS, Gmail, Office 365, AWS SES, Mailgun, and Postfix examples.
→Network Scanning
ICMP and TCP scan configuration, cron scheduling, stale address thresholds, and ARP import workflow.
→Devices & Interfaces
Link IP addresses to named devices and interfaces, manage equipment inventory, and use the REST API and CSV import.
→Advanced Networking
VRF BGP attributes, VLAN ranges, aggregates, IPv6 Prefix Delegation pools, and DNS zone export.
→Webhooks
HMAC-signed outbound webhooks on address and subnet events — setup, payload reference, signature verification, and retry behaviour.
→Backup & Restore
Unified 5-tab admin surface (Destinations, Backup, History, Restore, Notifications) with drawer-driven CRUD. S3 / SFTP / Local destinations with streaming AES-256-CTR + HMAC-SHA256 encryption, GFS retention, cron-driven schedules, and email failure notifications. History tab has a per-row detail drawer (Verify SHA-256 / Download / DELETE-confirmed Delete) and filter chips by Status / Backup type / Time.
→Restore Database
Phase-locked browser-based restore wizard: stage from any destination, dry-run preview with a real-lexer SQL splitter, then live apply behind a literal-string RESTORE confirm gate. Covers both Logical (PDO replay) and Database (engine-native dump) restore paths, with same-or-newer cross-version policy. Full audit trail; rate-limited; CLI fallback for disaster recovery.
→DHCP Config Export
Generate server-ready dhcpd.conf or Kea 2.x JSON from subnet options and reservations. Per-subnet routers, DNS, lease times, and PXE boot settings.
Contacts
Link contacts to IP addresses via the Owner typeahead. Reusable people / org records with name, email, phone, and notes that surface as clickable owner cards in the address list.
→Custom Fields
Admin-defined per-entity metadata on subnets and addresses — text, number, date, boolean, and select types with strict validation.
→Sidebar & Command Palette
Desktop sidebar layout, mobile hamburger overlay, and the ⌘K / Ctrl+K command palette for keyboard-driven navigation and record creation.
→