Skip to content

tchevalleraud/auditix

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

115 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Auditix

Discover · Audit · Visualize · Report Open-source network audit & compliance platform for modern infrastructure teams.

Latest release License Languages Docker

📖 Documentation · 💡 Request a feature


What you get

Live dashboard at a glance

Compliance scoring, fleet health, and recent activity in one place.

Dashboard

Auto-discovered topology

LLDP, STP, OSPF, BGP and ISIS links, drawn from your collected configurations.

Topology

Unified node inventory

Every device, its profile, score, tags and last collection — searchable and sortable.

Nodes


Why Auditix?

  • 🔍 Discover everything — automatic SSH-based configuration collection across your entire fleet, no agent required.
  • 🛡️ Audit with confidence — flexible compliance rules with regex extraction, condition trees and severity-weighted A–F grading.
  • 🗺️ See the whole network — topology maps auto-built from LLDP/STP/OSPF/BGP/ISIS, with manual link overrides and area coloring.
  • 📄 Ship pretty PDF reports — drag-and-drop block editor with compliance matrices, recommendations, CLI excerpts and themed cover pages.
  • Stays in sync, live — Mercure-powered real-time progress for collections, evaluations and pings, with horizontally scalable async workers.
  • 🔐 Multi-tenant by design — context isolation, TOTP 2FA, fine-grained credentials, dark mode and a UI in 6 languages.

Highlights

📦 Fleet management

  • Nodes with manufacturer / model / profile metadata
  • Color-coded tags
  • Multi-tenant contexts for full data isolation
  • CSV import, ZIP import for offline collections
  • TOTP two-factor authentication

🔌 Configuration collection

  • SSH via phpseclib3, model-specific connection scripts
  • Tree-organized commands and folders
  • Regex-based extraction → inventory mapping
  • File-based storage, scalable async workers
  • Real-time progress over SSE

🛡️ Compliance

  • Policies grouping rules and target nodes
  • Multi-source rules: inventory, collection files, live SSH
  • match / count / capture regex modes
  • Condition trees (AND / OR, operators)
  • Severity-weighted A–F scoring with error penalty
  • Folder-organized rule libraries

🗺️ Topology

  • LLDP / STP / OSPF / BGP / ISIS auto-discovery
  • Manual link editing & context menu
  • Multi-area ISIS coloring with draggable labels
  • Compliance & monitoring overlays
  • Custom viewport framing for reports

📄 Reports

  • Drag-and-drop block editor with 13 block types
  • Inventory tables, CLI excerpts, equipment lists, action plans
  • Compliance matrix, non-compliant devices, status by device
  • Rule recommendation block (static or live-evaluated, text or CLI)
  • Themed PDF generation, cover pages, TOC, revisions

🔧 Operations

  • ICMP ping with live status
  • Unified task board (collections + tasks)
  • Public REST API v1 with Swagger UI & token auth
  • Scheduler, cleanup and health-check workers
  • 6-language UI · built-in dark mode

Quick start

One-line install

curl -fsSL https://raw.githubusercontent.com/tchevalleraud/auditix/main/scripts/install.sh | bash

You'll be prompted for an install directory (default /opt/auditix). Pin a version with AUDITIX_VERSION=v4.3.0 or pick a branch with AUDITIX_BRANCH=main. See docs/UPGRADE.md for all options.

Manual install

git clone https://github.com/tchevalleraud/auditix.git
cd auditix
cp .env.example .env
make up

Open http://localhost and sign in with admin / password.

💡 For remote / production deployment, set APP_ENV=prod and DEFAULT_URI=http://<your-host>:<port> in .env before make up.

Useful commands

make up           # Start everything (build + install on first launch)
make down         # Stop all services
make restart      # Restart all services
make logs         # Tail logs
make status       # Compact status table for all services
make upgrade      # Pull latest, backup, rebuild, migrate, restart workers
make backup       # Manual backup (database + uploads + reports + collections)
make restore BACKUP=backups/auditix-*.tar.gz   # Restore from a backup
make doctor       # Diagnose common issues (containers, schema, migrations…)
make doctor-fix   # Apply safe auto-fixes detected by doctor

See docs/UPGRADE.md for upgrade paths from older versions and recovery procedures.


License

Auditix is open-source under the MIT License.

About

Auditix is a lightweight, automated network audit tool that collects and analyzes device configurations to quickly spot misconfigurations, policy drifts, and compliance issues.

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

 
 
 

Contributors