MERIDIAN 1.0.0 · DOCUMENTATION INDEX

Meridian · Network Intelligence Platform

Self-hosted network intelligence for network teams. Every portal page is documented here — summary, purpose, and every tab it contains.
OFFLINE
These docs live at /opt/meridian/docs/ and are served by the portal at /docs. Each portal page has a "Docs ↗" button on the top-right that jumps to the matching page here. No internet required.

Start here

  1. Install overview — prerequisites, what the installer does, ~10 min to a working portal.
  2. Installer prompts — every prompt explained with "why it matters" context.
  3. Getting started — first login, tour of the portal, finding your way.

User portal — tools & pages

Every regular (non-admin) page in the portal. For each: what it is, why it exists, and the tabs you'll see on it.

Dashboard

Summary. The landing page after login. Shows a welcome line, stat tiles, and quick links.

Purpose. Give operators an instant read on portal health without drilling anywhere — "are the services green, and is there anything that needs me?"

DNS Tools

Summary. Sandboxed DNS diagnostics with scope-guardrails: everything from a simple dig to zone-health and typosquat hunts.

Purpose. Replace a grab-bag of dig, delv, whois, and web-UI tools with one consistent, audited interface. Every query is logged with who ran it.

Network Tools

Summary. Reachability, performance, and capture tools. All scope-guardrailed so you don't accidentally probe outside what your install is allowed to touch.

Purpose. Give the network team a single audited place to run the "every day" probes without ad-hoc shells, and make the results shareable with a link.

Monitors

Summary. Scheduled synthetic checks: HTTP/HTTPS response, TCP port reachability, ICMP ping — with history.

Purpose. Know when something slips from OK → WARN → FAIL without you watching — and keep enough history to spot slow-burn issues (e.g., rising latency over weeks).

Wizards

Summary. Guided multi-step diagnostics. Each step explains what it checked, why it passed/warned/failed, and suggests evidence-backed next steps.

Purpose. Turn "something feels off" into a structured investigation that a less-senior operator can drive, and that produces a shareable report.

Certificates

Summary. Manage the portal's own TLS cert, watch a list of external certs for expiry, and generate CSRs.

Purpose. Three jobs that usually live in three different tools — consolidated so the cert story for your estate lives in one place.

Runbooks

Summary. Chain individual tools into repeatable, permission-gated workflows.

Purpose. Codify "the way we investigate X" so it runs the same way every time and is safe to delegate to a junior operator.

DHCP

Summary. Unified query interface across external DHCP systems. The portal does not run DHCP itself.

Purpose. Stop logging into Kea / ISC / Infoblox / Windows consoles to answer "which lease does this MAC have?" — ask Meridian instead.

IPAM

Summary. Unified query across external IPAM systems (Infoblox, Netbox, …). The portal does not store IPAM records itself.

Purpose. One lookup surface for "what's at this IP / in this subnet / assigned to this VLAN" regardless of which backend owns the record.

Directory

Summary. Active Directory / LDAP lookups — read-only by default. Write actions flow through the Approvals queue.

Purpose. Let the helpdesk answer "who is this user, what groups, when did their password change" without giving them write access to AD.

File Repo

Summary. Personal storage for scripts, pcaps, exports, and docs. Quota-enforced. Pinned files skip the retention cleanup.

Purpose. A consistent place to stash captures and one-off scripts without dropping them on a shared server — and without shipping them off-box.

Messages

Summary. Direct messages between users · admin broadcasts · group-addressed notices.

Purpose. Keep operational comms inside the audited portal rather than scattered across chat systems that don't tie back to who-did-what.

Approvals

Summary. Two-person sign-off queue for destructive or sensitive operations.

Purpose. Enforce the "no operator can destroy data or make a vault change alone" policy. Every write-grade action produces an approval request routed to another admin.

User Settings

Summary. Your personal profile, sessions, security, and preferences.

Purpose. Self-service for the things operators need to manage about themselves without pulling an admin in.


Admin portal — pages

Only visible to users with admin or super-admin role.

Admin overview

Summary. The admin landing page — at-a-glance numbers plus tab navigation to every admin surface.

Purpose. A single dashboard telling you "is the install healthy, is there admin attention needed anywhere" before drilling into specifics.

Users

Summary. Create, enable, lock, reset. Every change goes to the HMAC-chained audit log.

Purpose. Own the full lifecycle of a portal account — without SSH or direct-DB access — while staying fully auditable for compliance.

Scope Manager

Summary. Override which networks count as internal vs. external, plus a hard deny list. Applies to every probe (ping, traceroute, port scan, SNMP, pcap, HTTP test).

Purpose. Your single kill-switch for "Meridian must never probe X" and the single knob that governs which side of the Internet any tool is allowed to touch.

Integrations

Summary. Configure DHCP / IPAM / Directory backend endpoints and credentials. Secrets are AES-256-GCM encrypted at rest in the vault.

Purpose. The one place credentials for all your external systems live — not scattered across scripts and .env files.

Network Devices

Summary. SSH-based config backup with change detection. A new snapshot is only written when the SHA-256 differs from the last — cosmetic refreshes don't pollute history.

Purpose. Keep a safe, versioned copy of the running-config of every switch/router/firewall you care about, and fire a notification when something actually changes.

Vulnerabilities

Summary. OSV.dev + NVD scan of installed apt + pip components. Multi-select to bulk-suppress or open external advisories.

Purpose. Know your own CVE posture without standing up a separate vuln-mgmt tool — and keep the CVE list small enough that people actually read it.

System Health

Summary. Live self-check of services, DB, keys, cert, disk, memory, integrity chain. Destructive repair actions require a second admin.

Purpose. The first place to look when "is something broken on this box" — and a common truth-source so admins don't disagree about service state.

Updates

Summary. Pending apt updates, pinned version manifest, drift detection, snapshot + update history. Actual upgrade is CLI-only (meridian-nip upgrade).

Purpose. Let admins prepare upgrades (review what changes, snapshot, schedule) from the portal, without the portal silently upgrading itself under load.

Webhooks

Summary. HMAC-signed inbound receivers + outbound fan-out. Signing secrets are shown exactly once — store them then, they're vault-only after.

Purpose. The integration edge: bring events in from outside systems (receivers) and push events out to chat / ticketing / SIEM (fan-out).

Branding & identity

Summary. Customer-level personalization — logo, colors, login banner, display name, contact links. Applies site-wide on save.

Purpose. Let MSPs & enterprises reskin the portal so it reads as "their tool" without code changes.

Database security

Summary. The 4-layer data protection model — LUKS, AES-256-GCM field-level, HMAC hash-chain audit, localhost-only SQL. Master key handling + tamper detection.

Purpose. Reference doc for auditors and for admins preparing backup/restore plans that must preserve the security posture.

Scheduled jobs

Summary. The pre-made job catalog, cron editing, retention policy, CAB freeze windows.

Purpose. Tune what runs when, and how long the results are kept — without editing crontabs on the box.

Backup & restore

Summary. Full backup bundles · WAL shipping · the include-keys decision · step-by-step restore.

Purpose. The playbook for "we have to move this install to new hardware" or "we have to recover from a bad upgrade."


Reference

meridian-nip CLIEvery command, flag, and exit code

Legal & compliance

License + trademarkApache 2.0 explainer + the "MeridianNIP" trademark carve-out
Acceptable Use Policy templateSample policy text; customize in Admin → Branding
Open-source licensesHow Meridian handles third-party attribution and SBOM export