LibreNMS

A fully featured network monitoring system that provides a wealth of features and device support.

LibreNMS is an autodiscovering PHP/MySQL-based network monitoring system which includes support for a wide range of network hardware and operating systems including Cisco, Linux, FreeBSD, Juniper, Brocade, Foundry, HP and many more.

Features

• Auto-discovery: Automatically discover network devices and their interfaces
• Device Support: Support for thousands of device types from major vendors
• SNMP Monitoring: Comprehensive SNMP v1/v2c/v3 support
• Alerting: Flexible alerting system with multiple notification methods
• Graphing: Beautiful graphs and charts for network metrics
• API: RESTful API for integration with other systems
• Multi-user: Role-based access control for team environments
• Mobile Ready: Responsive web interface works on all devices
• Plugin System: Extensible with applications and plugins

Architecture

This template deploys a complete LibreNMS stack including:

• LibreNMS Web Interface: Main application server
• Dispatcher: Background job processing service
• Syslog: System log collection service (port 514)
• SNMP Trap: SNMP trap receiver service (port 162)
• MariaDB: Database backend
• Redis: Cache and session storage
• MSMTP: Email delivery service

Environment Variables

After deployment, the following environment variables are available:

• MARIADB_HOST: The hostname of your MariaDB database
• MARIADB_PORT: The port of your MariaDB database
• MARIADB_DATABASE: The database name for LibreNMS
• MARIADB_USERNAME: The username for database access
• MARIADB_PASSWORD: The password for database access
• REDIS_HOST: The hostname of your Redis instance
• REDIS_PORT: The port of your Redis instance

Getting Started

1. Initial Access: After deployment, visit your LibreNMS domain to complete setup
2. Admin Account: Create your first administrator account during initial setup
3. Network Discovery: Configure network ranges for auto-discovery
4. Device Addition: Start adding devices manually or via auto-discovery
5. Configure Alerting: Set up alert rules and notification methods
6. Customize Dashboards: Create custom dashboards and views

Configuration

• SNMP Community: Default community string is librenmsdocker
• Performance: Optimized with Redis caching and background processing
• Security: Runs with appropriate user permissions and network capabilities
• Monitoring Ports: Syslog (514) and SNMP Trap (162) services available

Email Configuration

Email notifications can be configured using the provided SMTP variables:

• Configure SMTP_HOST, SMTP_USER, SMTP_PASSWORD for your email provider
• Set SMTP_FROM to your desired sender address
• Email settings can also be configured through the web interface

Documentation

For detailed configuration and usage information, visit the official LibreNMS documentation.