🤖 Containerized Oxidized Deployment for RHEL

Production-grade deployment framework for running Oxidized as a containerized service on RHEL 10/9 using Podman Quadlets and systemd.

For Oxidized usage and configuration, see README-OXIDIZED.md.

📋 Table of Contents

Overview
Features
Architecture
Requirements
Quick Start
Installation
Configuration
Management Scripts
Uninstallation
Security
Documentation
Contributing
License

🎯 Overview

This repository provides automated deployment scripts and configuration templates for running Oxidized (network device configuration backup tool) as a containerized service on RHEL.

What is Oxidized?

Oxidized is a network device configuration backup tool that automatically backs up network device configurations, tracks changes using Git, and supports 130+ device models.

Full Oxidized documentation: README-OXIDIZED.md

Why This Repository?

✅ Production-ready: Designed for enterprise RHEL environments
✅ Systemd integrated: Auto-starts on boot via Podman Quadlets
✅ SELinux compatible: Works with enforcing mode out of the box
✅ Version pinned: Stable, predictable releases
✅ Automated deployment: Single script deployment with validation
✅ Fully documented: Step-by-step guides and runbooks
✅ Idempotent: Safe to re-run and upgrade

✨ Features

🚀 Deployment

Podman Quadlets: Declarative systemd-managed containers
Automatic startup: Starts on boot, restarts on failure
Persistent storage: All data survives container recreation
SELinux enforcing: No custom policies required
Version pinned: Explicit image versions, no latest tag
Idempotent scripts: Safe to re-run deployment

📦 Data Management

Git versioning: Every config change tracked automatically
CSV inventory: Simple, colon-delimited device list (router.db)
Log rotation: Automated via logrotate
Backup procedures: Scripts and documentation provided

🔍 Monitoring & Management

Health check script: Automated validation
REST API: JSON endpoints for status and metrics
Web UI: View configs and diffs in browser
Zabbix ready: Pre-built monitoring templates

🛡️ Security

Container isolation: Strong namespace and cgroup isolation
SELinux enforcing: Proper context labeling (:Z mounts)
Isolated storage: Dedicated paths under /var/lib/oxidized
No secrets in repo: Credentials managed via .env file
Secret removal: Automatically strips passwords, SNMP strings, and keys from backups (docs)
DNS disabled: Prevents DNS-based attacks, uses IP addresses only
Minimal capabilities: Only SETUID/SETGID for init system
NoNewPrivileges: Prevents privilege escalation

Note: See SECURITY-HARDENING.md for complete security documentation.

🏗️ Architecture

High-Level Overview

┌─────────────────────────────────────────────────────────────┐
│                      RHEL 10/9 Host                         │
│                                                             │
│  ┌─────────────────────────────────────────────────────┐   │
│  │              systemd (Quadlets)                     │   │
│  │                                                     │   │
│  │  ┌──────────────────────────────────────────────┐  │   │
│  │  │    Podman Container (oxidized:0.35.0)       │  │   │
│  │  │                                              │  │   │
│  │  │  🤖 Oxidized Service                         │  │   │
│  │  │     ├─ REST API (port 8888)                 │  │   │
│  │  │     ├─ Web UI                               │  │   │
│  │  │     ├─ Polling Engine (hourly)              │  │   │
│  │  │     └─ Git Output                           │  │   │
│  │  │                                              │  │   │
│  │  │  Volumes (bind mounts with :Z)              │  │   │
│  │  │     /var/lib/oxidized/config  ← config      │  │   │
│  │  │     /var/lib/oxidized/ssh     ← keys        │  │   │
│  │  │     /var/lib/oxidized/data    ← logs        │  │   │
│  │  │     /var/lib/oxidized/output  ← backups     │  │   │
│  │  │     /var/lib/oxidized/repo    ← git         │  │   │
│  │  └──────────────────────────────────────────────┘  │   │
│  └─────────────────────────────────────────────────────┘   │
│                                                             │
│  📁 Host Persistent Storage: /var/lib/oxidized/            │
│     ├── config/         (Oxidized configuration)           │
│     │   ├── config      (main config file)                 │
│     │   └── router.db   (device inventory)                 │
│     ├── ssh/            (SSH keys)                         │
│     ├── data/           (runtime data & logs)              │
│     ├── output/         (backup output)                    │
│     └── repo/           (Git repository)                   │
│                                                             │
│  🔄 logrotate: /etc/logrotate.d/oxidized                   │
│  🎯 Quadlet: /etc/containers/systemd/oxidized.container    │
└─────────────────────────────────────────────────────────────┘
              │                              │
              │ SSH/Telnet                   │ HTTP
              ▼                              ▼
    ┌──────────────────┐          ┌──────────────────┐
    │  Network Devices │          │  Monitoring      │
    │  (routers,       │          │  (Zabbix, etc.)  │
    │   switches,      │          │                  │
    │   firewalls)     │          │  🔍 API Polling  │
    └──────────────────┘          └──────────────────┘

Key Components

Podman Quadlets: Systemd-native container management
SELinux Context: All mounts properly labeled (:Z)
Persistent Storage: All data under /var/lib/oxidized
Device Inventory: CSV file at /var/lib/oxidized/config/router.db
Git Repository: Version-controlled configs at /var/lib/oxidized/repo

📋 Requirements

Operating System

Platform	Status	Notes
RHEL 10	✅ Primary	Fully tested
RHEL 9	✅ Secondary	Supported

Software Dependencies

Package	Version	Purpose
podman	4.x+	Container runtime
systemd	247+	Quadlet support
git	2.x+	Version control
logrotate	Any	Log rotation

System Requirements

Resource	Minimum	Recommended	Notes
CPU	1 core	2+ cores	More threads = faster backups
RAM	512 MB	1 GB	Depends on device count
Disk	2 GB	10 GB	Grows with config history
Network	SSH/Telnet	Outbound only	To devices

Network Requirements

Outbound: SSH (22) and/or Telnet (23) to network devices
Optional: Port 8888 for Web UI/API (inbound, if remote access needed)

🚀 Quick Start

Automated Deployment (Recommended)

Complete deployment in 5 minutes:

# 1. Clone repository

git clone https://github.com/christopherpaquin/deploy-containerized-oxidized.git
cd deploy-containerized-oxidized

# 2. Create .env file

cp env.example .env
chmod 600 .env

# 3. Edit .env (REQUIRED: change OXIDIZED_PASSWORD)

vim .env

# 4. Validate configuration

./scripts/validate-env.sh

# 5. Deploy (creates user, directories, installs service)

sudo ./scripts/deploy.sh

# 6. Verify deployment

sudo ./scripts/health-check.sh

Post-deployment:

# Create device inventory

sudo cp inventory/router.db.template /var/lib/oxidized/config/router.db
sudo vim /var/lib/oxidized/config/router.db
sudo chown 30000:30000 /var/lib/oxidized/config/router.db
sudo chmod 644 /var/lib/oxidized/config/router.db

# Restart to load inventory

sudo systemctl restart oxidized.service

# Check status

sudo systemctl status oxidized.service

📝 IMPORTANT: Test Device Included

The router.db.template includes a test device entry:
test-device:192.0.2.1:ios:testing::
Purpose: This dummy device (using non-routable TEST-NET IP) allows the Oxidized Web UI and API to start successfully for verification.

Action Required:

✅ Leave it during initial deployment/testing

❌ Remove or replace it before production use with your real devices

See DEVICE-MANAGEMENT.md for adding real devices.

Access Web UI: http://<your-server-ip>:8888

🔧 Installation

Detailed Installation Steps

1. Install Prerequisites

# Install required packages

sudo dnf install -y podman git logrotate curl jq

# Verify installations

podman --version
git --version
systemctl --version

2. Clone Repository

git clone https://github.com/christopherpaquin/deploy-containerized-oxidized.git
cd deploy-containerized-oxidized

3. Configure Environment

# Copy template

cp env.example .env

# Secure permissions (contains credentials)

chmod 600 .env

# Edit configuration

vim .env

Required Changes:

OXIDIZED_PASSWORD - Change from default "changeme"
OXIDIZED_USERNAME - Device login username
GIT_USER_NAME - Git commit author
GIT_USER_EMAIL - Git commit email

Optional Changes:

OXIDIZED_ROOT - Default: /var/lib/oxidized
POLL_INTERVAL - Default: 3600 (1 hour)
OXIDIZED_IMAGE - Container image version

See env.example for all options with detailed comments.

4. Validate Configuration

./scripts/validate-env.sh

This checks for:

Missing required variables
Default passwords
Invalid paths
Permission issues
Common misconfigurations

5. Run Deployment Script

sudo ./scripts/deploy.sh

This script:

Creates system user (oxidized, UID 2000)
Creates directory structure under /var/lib/oxidized
Generates Oxidized config from templates
Installs Podman Quadlet service
Sets up logrotate
Pulls container image
Starts service

The deployment is idempotent - safe to re-run.

6. Create Device Inventory

# Copy template

sudo cp inventory/router.db.template /var/lib/oxidized/config/router.db

# Edit with your devices

sudo vim /var/lib/oxidized/config/router.db

# Set permissions (CRITICAL - must be owned by container's UID)

sudo chown 30000:30000 /var/lib/oxidized/config/router.db
sudo chmod 644 /var/lib/oxidized/config/router.db

# Restart service

sudo systemctl restart oxidized.service

Format: name:ip:model:group:username:password

See README-OXIDIZED.md - Device Inventory for complete documentation.

7. Verify Deployment

# Run health check

sudo ./scripts/health-check.sh

# Check service status

sudo systemctl status oxidized.service

# View logs

sudo journalctl -u oxidized.service -f

⚙️ Configuration

Environment Configuration (.env)

Location: .env (in repository root)

⚠️ SECURITY: This file contains sensitive information (credentials, IP addresses).

Copy from env.example: cp env.example .env
Restrict permissions: chmod 600 .env
Never commit to Git (already in .gitignore)

Key Configuration Variables

# System user (runs container)

OXIDIZED_USER="oxidized"
OXIDIZED_UID=2000
OXIDIZED_GID=2000

# Data directory (all persistent data)

OXIDIZED_ROOT="/var/lib/oxidized"

# Container image (pinned version)

OXIDIZED_IMAGE="docker.io/oxidized/oxidized:0.35.0"

# Device credentials (global defaults)

OXIDIZED_USERNAME="admin"
OXIDIZED_PASSWORD="changeme"  # CHANGE THIS!

# Operational settings

POLL_INTERVAL=3600  # Hourly backup (seconds)
THREADS=30          # Parallel device connections
TIMEOUT=20          # Device timeout (seconds)

# Git configuration

GIT_USER_NAME="Oxidized"
GIT_USER_EMAIL="oxidized@example.com"

# Network settings

OXIDIZED_API_PORT=8888
OXIDIZED_API_HOST="0.0.0.0"
OXIDIZED_WEB_UI="true"

See env.example for all available options with detailed documentation.

Bind Mounts

All host directories are automatically mounted into the container:

Host Path	Container Path	Purpose
`/var/lib/oxidized/config`	`/home/oxidized/.config/oxidized`	Configuration files, router.db
`/var/lib/oxidized/ssh`	`/home/oxidized/.ssh`	SSH keys (read-only)
`/var/lib/oxidized/data`	`/home/oxidized/.config/oxidized/data`	Logs, runtime data
`/var/lib/oxidized/output`	`/home/oxidized/.config/oxidized/output`	Backup output
`/var/lib/oxidized/repo`	`/home/oxidized/.config/oxidized/repo`	Git repository

Important: Always place your router.db inventory file in /var/lib/oxidized/config/ so it's accessible to the container.

Device Inventory (router.db)

Location: /var/lib/oxidized/config/router.db (on host)

Format: Colon-delimited CSV

name:ip:model:group:username:password
core-router01:10.1.1.1:ios:core::
edge-switch01:10.1.2.1:procurve:distribution::

Complete device inventory documentation: README-OXIDIZED.md - Device Inventory

🛠️ Management Scripts

This repository includes automated scripts for common operations:

Deployment Script

Path: scripts/deploy.sh

Purpose: Install and configure Oxidized service

Usage:

sudo ./scripts/deploy.sh

What it does:

Creates system user and group
Creates directory structure
Generates configuration files
Installs Podman Quadlet
Sets up logrotate
Pulls container image
Starts service

Options:

# Dry-run mode (show what would be done)

sudo ./scripts/deploy.sh --dry-run

# Skip validation

sudo ./scripts/deploy.sh --skip-validation

Idempotent: Safe to re-run for upgrades or configuration changes.

Health Check Script

Path: scripts/health-check.sh

Purpose: Validate deployment and service health

Usage:

sudo ./scripts/health-check.sh

Checks:

System user exists
Directories exist with correct permissions
Configuration files present and valid
Service running
Container healthy
Recent backups successful
Disk space adequate
Network connectivity
Log file accessible

Exit codes:

0 = All checks passed
1 = One or more checks failed

Use in monitoring:

# Cron job example (check every hour)

0 * * * * /path/to/deploy-containerized-oxidized/scripts/health-check.sh || mail -s "Oxidized Health Check Failed" admin@example.com

Add Device Script

Path: scripts/add-device.sh

Purpose: Interactive script to add network devices to the inventory

Usage:

sudo /var/lib/oxidized/scripts/add-device.sh

Features:

Interactive prompts with validation for hostname, IP, model, and group
Shows list of 38+ supported device models
Displays existing groups or allows creating new ones
Shows default credentials from config (username only, password masked)
Optional per-device credential override
Comprehensive spell checking with 50+ typo patterns
Intelligent suggestions for common mistakes (tp-link → tplink, arista → eos)
Automatic timestamped backups in /var/lib/oxidized/config/backup/
Full syntax validation after addition
Append-only operation (never overwrites router.db)

Interactive Commands:

# During model selection:

list   # Show all 38+ device models again
help   # Display common typo guide

What it does:

Prompts for device hostname with duplicate detection
Prompts for IP address or FQDN with validation
Shows available OS types (ios, nxos, junos, fortios, etc.)
Displays existing groups or creates new group
Shows default credentials, allows override
Validates entry format
Creates timestamped backup of router.db
Appends entry to router.db
Runs full validation on all devices

Example:

sudo /var/lib/oxidized/scripts/add-device.sh

# Follow interactive prompts:
# 1. Hostname: core-router01
# 2. IP: 10.1.1.1
# 3. Model: ios (or type 'help' to see common typos)
# 4. Group: core (or create new)
# 5. Credentials: Use defaults or override
# 6. Confirm and add

Spell Checking: Automatically detects and corrects common typos like:

tp-link → tplink
cisco-ios → ios
arista → eos (vendor vs. model)
fortigate → fortios
And 50+ more patterns

Safety: Never overwrites router.db, creates backup before changes, validates all entries.

Documentation: See docs/ADD-DEVICE.md for complete guide.

Validate Router DB Script

Path: scripts/validate-router-db.sh

Purpose: Validate router.db syntax and format

Usage:

/var/lib/oxidized/scripts/validate-router-db.sh [path-to-router.db]

Checks:

File format (6 fields, colon-delimited)
Device name format
Duplicate device names
IP address/hostname format
Duplicate IP addresses (warning)
Empty required fields
Known device models (warning if unknown)
Credential consistency

Automatically run by: add-device.sh after adding new devices

Test Device Script

Path: scripts/test-device.sh

Purpose: Test connectivity and trigger backup for a specific device

Usage:

/var/lib/oxidized/scripts/test-device.sh <device-name>

Checks:

Container is running
Device exists in router.db
Device is registered in Oxidized
Network connectivity (ping)
SSH port is reachable
Triggers backup
Shows recent logs

Example:

/var/lib/oxidized/scripts/test-device.sh core-router01

Uninstall Script

Path: scripts/uninstall.sh

Purpose: Remove Oxidized deployment

Usage:

# Remove service only (preserve data)

sudo ./scripts/uninstall.sh

# Remove everything including data (prompts to backup router.db)

sudo ./scripts/uninstall.sh --remove-data

# Remove everything without prompts (NO BACKUP!)

sudo ./scripts/uninstall.sh --remove-data --force

What it removes:

Systemd service
Podman Quadlet file
Logrotate configuration
Helper scripts
System user (optional)

Safety Feature: When using --remove-data, the script prompts to backup router.db to your home directory with a timestamp before deletion.

Data directories (only with --purge)

⚠️ WARNING: --purge permanently deletes all backups and Git history!

Validation Script

Path: scripts/validate-env.sh

Purpose: Validate .env configuration before deployment

Usage:

./scripts/validate-env.sh

Checks:

.env file exists
Required variables present
No default passwords
Valid UID/GID
Absolute paths
Correct file permissions

🗑️ Uninstallation

Remove Service (Preserve Data)

sudo ./scripts/uninstall.sh

This removes:

Systemd service
Podman Quadlet
Logrotate config
Container

Preserves:

Data directories (/var/lib/oxidized)
System user
Container image

Complete Removal (Delete Everything)

sudo ./scripts/uninstall.sh --remove-data

Safety: You'll be prompted to backup router.db before deletion.

⚠️ WARNING: This permanently deletes:

All device configurations
Git history
Logs
SSH keys
Everything under /var/lib/oxidized

Before purging, back up data:

sudo tar -czf oxidized-backup-$(date +%Y%m%d).tar.gz /var/lib/oxidized

🔒 Security

Security Features

This deployment includes multiple security hardening measures:

Container isolation: Strong namespace and cgroup isolation
SELinux enforcing: Proper context labeling (:Z mounts)
Network isolation: Dedicated Podman network
Minimal capabilities: Only SETUID/SETGID (required for init system)
NoNewPrivileges: Prevents privilege escalation within container
Restricted permissions:
- Config files: 640
- Credentials: 600
- Directories: 750
No secrets in repo: All credentials in .env (Git-ignored)
Version pinned: Explicit container versions
Resource limits: CPU and memory constraints enforced

Container Security Note: The Oxidized container uses baseimage-docker with an init system that requires root privileges inside the container. However, the container remains securely isolated through:

Namespace isolation (PID, network, mount, IPC, UTS)
Cgroup resource limits
SELinux mandatory access controls
NoNewPrivileges flag
Dedicated bridge network

For detailed security analysis and trade-offs, see DEPLOYMENT-NOTES.md.

Security Best Practices

Change default passwords immediately:

# In .env
OXIDIZED_PASSWORD="strong_unique_password_here"

Use SSH keys instead of passwords (recommended):

sudo -u oxidized ssh-keygen -t ed25519 -f /var/lib/oxidized/ssh/id_ed25519
sudo -u oxidized ssh-copy-id -i /var/lib/oxidized/ssh/id_ed25519.pub admin@device

📖 For detailed SSH key setup, see SSH Key Authentication in README-OXIDIZED.md

Secure the .env file:
```
chmod 600 .env
# Never commit to Git
```

Secure router.db (if using per-device credentials):

sudo chmod 644 /var/lib/oxidized/config/router.db
sudo chown 30000:30000 /var/lib/oxidized/config/router.db

Restrict network access:

# Allow only from monitoring server
sudo firewall-cmd --permanent --add-rich-rule='rule family="ipv4" source address="10.1.1.100" port port="8888" protocol="tcp" accept'

Regular updates:
- Monitor Oxidized releases
- Test upgrades in non-production first
- Keep .env variables up to date
Use least-privilege device accounts:
- Create read-only accounts on network devices
- Limit access to config commands only
- Monitor Oxidized's device access in device logs

Back up the Git repository:

# Push to remote Git server
cd /var/lib/oxidized/repo
sudo git remote add origin git@github.com:yourorg/network-configs.git
sudo git push origin main

Complete security documentation: docs/SECURITY-HARDENING.md

📚 Documentation

Repository Documentation

📖 Not sure which doc to read? See DOCUMENTATION-GUIDE.md for a complete guide to our documentation structure.

QUICK-START.md - ⚡ Quick reference guide for deployment and common tasks
DEVICE-MANAGEMENT.md - 📱 Complete device management, groups, logging, and validation
DIRECTORY-STRUCTURE.md - 📁 Directory layout and file locations explained
CREDENTIALS-GUIDE.md - 🔑 IMPORTANT: Understanding the TWO sets of credentials
DEPLOYMENT-NOTES.md - ⭐ Deployment improvements, testing notes, and troubleshooting
AUTHENTICATION-SETUP.md - 🔒 Web UI login configuration and management
SECURITY-AUTHENTICATION.md - ⚠️ Security options and considerations
FIREWALL-IMPLEMENTATION.md - Automatic firewall configuration details
README-OXIDIZED.md - Oxidized usage, configuration, and troubleshooting
docs/INSTALL.md - Detailed installation guide
docs/CONFIGURATION.md - Configuration deep-dive
docs/ENV-ARCHITECTURE.md - Environment variable architecture
docs/SECURITY-HARDENING.md - Security best practices
docs/UPGRADE.md - Upgrade procedures
docs/PREREQUISITES.md - Prerequisite details
docs/DECISIONS.md - Architecture decisions
docs/TROUBLESHOOTING-WEB-UI.md - Web UI / Backend Not Responding troubleshooting
docs/monitoring/ZABBIX.md - Zabbix monitoring setup

Templates

env.example - Environment variable template with extensive documentation
inventory/router.db.template - Device inventory template with examples
config/oxidized/config.template - Oxidized configuration template
containers/quadlet/oxidized.container.template - Podman Quadlet template

External Documentation

Oxidized GitHub: https://github.com/yggdrasil-network/oxidized
Oxidized Documentation: https://github.com/yggdrasil-network/oxidized/wiki
Supported Models: https://github.com/yggdrasil-network/oxidized/tree/master/lib/oxidized/model
Podman Quadlets: https://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html

🤝 Contributing

Contributions are welcome! Please follow these guidelines:

Reporting Issues

Use GitHub Issues
Include system information (RHEL version, Podman version)
Provide relevant logs
Describe expected vs actual behavior

Pull Requests

Fork the repository
Create a feature branch
Make your changes
Run ./scripts/validate-env.sh
Test deployment on clean system
Submit pull request with clear description

Development Standards

Shell scripts: Follow ShellCheck recommendations
Documentation: Update relevant docs for any changes
Testing: Test on RHEL 10 and RHEL 9
SELinux: Ensure compatibility with enforcing mode
Idempotency: Scripts must be safe to re-run

📄 License

Copyright 2026 Christopher Paquin

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Full license text: LICENSE

🙏 Acknowledgments

Oxidized: https://github.com/yggdrasil-network/oxidized
Podman: https://podman.io/
Red Hat Enterprise Linux: https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux
Community contributors and testers

📞 Support

GitHub Issues: https://github.com/christopherpaquin/deploy-containerized-oxidized/issues
Documentation: docs/
Oxidized Community: https://gitter.im/oxidized/Lobby

Quick Links:

Name		Name	Last commit message	Last commit date
Latest commit History 19 Commits
.github		.github
config		config
containers/quadlet		containers/quadlet
docs		docs
inventory		inventory
scripts		scripts
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
.pymarkdown.json		.pymarkdown.json
AUTHENTICATION-SETUP.md		AUTHENTICATION-SETUP.md
CLEANUP-SUMMARY.md		CLEANUP-SUMMARY.md
CREDENTIALS-GUIDE.md		CREDENTIALS-GUIDE.md
DEPLOYMENT-NOTES.md		DEPLOYMENT-NOTES.md
DEVICE-MANAGEMENT.md		DEVICE-MANAGEMENT.md
DIRECTORY-STRUCTURE.md		DIRECTORY-STRUCTURE.md
DOCUMENTATION-GUIDE.md		DOCUMENTATION-GUIDE.md
FIREWALL-IMPLEMENTATION.md		FIREWALL-IMPLEMENTATION.md
FIREWALL-QUICKREF.md		FIREWALL-QUICKREF.md
LICENSE		LICENSE
QUICK-START.md		QUICK-START.md
README-OXIDIZED.md		README-OXIDIZED.md
README.md		README.md
SECURITY-AUTHENTICATION.md		SECURITY-AUTHENTICATION.md
env.example		env.example

License

christopherpaquin/deploy-containerized-oxidized

Folders and files

Latest commit

History

Repository files navigation

🤖 Containerized Oxidized Deployment for RHEL

📋 Table of Contents

🎯 Overview

What is Oxidized?

Why This Repository?

✨ Features

🚀 Deployment

📦 Data Management

🔍 Monitoring & Management

🛡️ Security

🏗️ Architecture

High-Level Overview

Key Components

📋 Requirements

Operating System

Software Dependencies

System Requirements

Network Requirements

🚀 Quick Start

Automated Deployment (Recommended)

🔧 Installation

Detailed Installation Steps

1. Install Prerequisites

2. Clone Repository

3. Configure Environment

4. Validate Configuration

5. Run Deployment Script

6. Create Device Inventory

7. Verify Deployment

⚙️ Configuration

Environment Configuration (.env)

Key Configuration Variables

Bind Mounts

Device Inventory (router.db)

🛠️ Management Scripts

Deployment Script

Health Check Script

Add Device Script

Validate Router DB Script

Test Device Script

Uninstall Script

Validation Script

🗑️ Uninstallation

Remove Service (Preserve Data)

Complete Removal (Delete Everything)

🔒 Security

Security Features

Security Best Practices

📚 Documentation

Repository Documentation

Templates

External Documentation

🤝 Contributing

Reporting Issues

Pull Requests

Development Standards

📄 License

🙏 Acknowledgments

📞 Support

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages