Files
ansible-role-librenms/README.md

47 lines
1.4 KiB
Markdown

# ansible-role-librenms
Installs LibreNMS from GitHub releases on Debian-based distributions. Handles
package dependencies, PHP Composer install, file permissions, cron jobs and
the systemd dispatcher service.
The following are out of scope and must be handled separately:
- Database (MariaDB/MySQL) setup and LibreNMS database migration
- nginx/apache virtual host configuration
- LibreNMS `.env` application configuration
The service is left disabled/stopped by default until the database and
config are in place.
## Requirements
- Ansible >= 2.14
- Debian Bookworm or Ubuntu Jammy/Noble
- The `librenms_user` and `librenms_group` must be created beforehand
## Role Variables
| Variable | Default | Description |
|---|---|---|
| `librenms_version` | `""` | Version to install (empty = latest) |
| `librenms_user` | `librenms` | User to own the installation |
| `librenms_group` | `librenms` | Group to own the installation |
| `librenms_install_dir` | `/opt/librenms` | Installation directory |
| `librenms_php_version` | `"8.2"` | PHP version to install |
| `librenms_service_enabled` | `false` | Enable dispatcher at boot |
| `librenms_service_state` | `stopped` | Service state (needs DB config first) |
## Example Playbook
```yaml
- hosts: monitoring_servers
roles:
- role: ansible-role-librenms
vars:
librenms_user: librenms
librenms_group: librenms
```
## License
MIT