Oxidized & LibreNMS Setup Guide

Architecture

Oxidzed and LibreNMS run as containers on oxidized.its.carleton.edu, a virtual machine.

The relationship between the services is shown below where the arrow points to each service container’s “dependency”.

 

The files

Files are located at /home/oxidized/oxidized-librenms

Configuration files

  • docker-compose.yml → defines all container services

  • data → directory for libreNMS, redis and mariadb data.

  • librenms.env → ENV variables for libreNMS.

  • oxidized-config → directory for oxidized configuration, backup files, crash report etc.

 

See this github repo all config files.

 

Useful docker and docker-compose commands

Start all services

cd /home/oxidized/oxidized-librenms docker-compose up --no-build --detach

Stop all services

docker-compose down

Check status of all containers

docker ps -a

 

Backup files

Backup files are stored by Oxidized as a git repo at /home/oxidized/oxidized-librenms/oxidized-config/devices.git

Here are some useful CLI commands for accessing files in the git directory