PHPackages devture/nagadmin - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Admin Panels](/categories/admin) 4. / 5. devture/nagadmin ActiveProject[Admin Panels](/categories/admin) devture/nagadmin ================ Web-configurator and frontend for Nagios 1011PHPCI failing Since Feb 15Pushed 1mo ago3 watchersCompare [ Source](https://github.com/devture/nagadmin)[ Packagist](https://packagist.org/packages/devture/nagadmin)[ RSS](/packages/devture-nagadmin/feed)WikiDiscussions master Synced 3mo ago READMEChangelogDependenciesVersions (1)Used By (0) Nagadmin ======== [](#nagadmin) **An all-in-one [Nagios](https://www.nagios.com) monitoring stack** β€” a beautiful web UI to *configure* Nagios and *watch* your services, with **Nagios itself built right in**. [![License: AGPL v3](https://camo.githubusercontent.com/c61341f63648cdd5aba4f7a073b513106a63778c27b15f96c56157642bc943b4/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4147504c25323076332d626c75652e737667)](LICENSE) [![PHP 8.5](https://camo.githubusercontent.com/38189c74fa19d38a84282702897dcd5bf0e54f8ee6be5cb02aa9a3a1f5711862/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e352d3737374242343f6c6f676f3d706870266c6f676f436f6c6f723d7768697465)](https://camo.githubusercontent.com/38189c74fa19d38a84282702897dcd5bf0e54f8ee6be5cb02aa9a3a1f5711862/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e352d3737374242343f6c6f676f3d706870266c6f676f436f6c6f723d7768697465) [![Symfony 8.1](https://camo.githubusercontent.com/98ed7bd584ea7ca898951cdae2b261f3e261560b27d20aa726e0fe7c1f1b1e48/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f53796d666f6e792d382e312d3030303030303f6c6f676f3d73796d666f6e79266c6f676f436f6c6f723d7768697465)](https://camo.githubusercontent.com/98ed7bd584ea7ca898951cdae2b261f3e261560b27d20aa726e0fe7c1f1b1e48/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f53796d666f6e792d382e312d3030303030303f6c6f676f3d73796d666f6e79266c6f676f436f6c6f723d7768697465) [![Nagios 4.5](https://camo.githubusercontent.com/9b48171ecef4997c50e7d47f5d7c2866a71711bdfe1111af582ea303fcc5b2ae/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4e6167696f732d342e352d464636363030)](https://camo.githubusercontent.com/9b48171ecef4997c50e7d47f5d7c2866a71711bdfe1111af582ea303fcc5b2ae/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4e6167696f732d342e352d464636363030) [![Docker required](https://camo.githubusercontent.com/6209833b68522145f4b80b2681aab2fa39e310a10e23a15edd1a82ef03b1d322/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f446f636b65722d72657175697265642d3234393645443f6c6f676f3d646f636b6572266c6f676f436f6c6f723d7768697465)](https://camo.githubusercontent.com/6209833b68522145f4b80b2681aab2fa39e310a10e23a15edd1a82ef03b1d322/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f446f636b65722d72657175697265642d3234393645443f6c6f676f3d646f636b6572266c6f676f436f6c6f723d7768697465) Editing Nagios `.cfg` files by hand is tedious, needs terminal access, and gives you no real overview of what's configured. **Nagadmin** replaces that with a friendly, mobile-friendly web interface β€” and, unlike most configurators, it doesn't expect you to bring your own Nagios. The Nagios engine is **bundled and managed for you**, so a single command brings up a complete, self-hosted monitoring system. It deliberately **optimizes for the common monitoring use-case** rather than supporting every esoteric Nagios feature. That keeps the workflow simple β€” but if your needs are very advanced, you may prefer another solution or a fork. See [🚧 Limitations](#-limitations). [![Nagadmin dashboard](resources/screenshots/dashboard-partial.png)](resources/screenshots/dashboard-partial.png) 🧩 One stack, batteries included ------------------------------- [](#-one-stack-batteries-included) Nagadmin isn't a configurator that talks to a Nagios you have to install and babysit yourself β€” **it ships Nagios too**. A single `just run` brings the whole monitoring stack up in containers: - πŸ–₯️ **Nagadmin web UI** β€” the configurator *and* the status frontend (a [Symfony](https://symfony.com/) app under `app/`) - πŸ“Ÿ **Nagios** β€” the monitoring engine itself, pre-wired and validated for you - πŸ—„οΈ **MongoDB** β€” stores your configuration - 🌐 **nginx** β€” serves the web UI - βœ‰οΈ **exim mail relay** β€” delivers notifications, with a persistent retry spool (production) You configure everything through the web UI; Nagadmin **generates and deploys validated Nagios configuration** for you. No hand-editing `.cfg` files, no separate Nagios install to wire up. 🌟 Why Nagadmin? --------------- [](#-why-nagadmin) - βœ… **Easier than SSHing in to edit raw config** β€” point-and-click instead of `vi nagios.cfg` - 🎨 **A pleasant, modern UI** that also works on mobile devices - πŸ”„ **Configurator and frontend in one** β€” set things up *and* watch their status from the same place - πŸ“¦ **Nagios included** β€” no separate installation; it's part of the stack - πŸ” **Advanced access control** β€” many users can see and do different things - 🎯 **Optimized for the common case** β€” complex Nagios features are hidden to keep the workflow simple - πŸ‘€ **A clear overview** of both your current configuration and live status πŸš€ Getting started ----------------- [](#-getting-started) ### Prerequisites [](#prerequisites) - [Docker](https://www.docker.com/) - Docker Compose (v1 or v2) - [just](https://github.com/casey/just) (command runner) ### 1. Get the code [](#1-get-the-code) ``` cd /srv/http git clone nagadmin cd nagadmin ``` ### 2. Configure [](#2-configure) Nagadmin keeps its configuration in two files, each read natively by the tool that needs it: ``` cp .env.dist .env # infrastructure: timezone, published ports, Nagios UI credentials cp app/.env.dist app/.env # the Symfony app: secrets, mailer DSN, SMS credentials, etc. ``` Edit both to taste. `app/.env` holds deployment-specific values and secrets such as the notification API secret (`NAGADMIN_NOTIFICATION_API_SECRET`), the mailer DSN (`MAILER_DSN`) and the Vonage SMS credentials. ### 3. First run [](#3-first-run) ``` just run ``` `just run` starts the **development** environment, which includes a [mailcrab](https://github.com/tweedegolf/mailcrab) mail-catcher so it never sends real e-mail β€” captured messages are viewable at . To run the **production** environment instead, use `just run prod`(see **Running in production** below). > ℹ️ Nagios won't be fully healthy yet β€” it can't find its configuration until the install step below. ### 4. Initialize the database [](#4-initialize-the-database) ``` just init-database ``` Imports the initial data-set and creates the database indexes. ### 5. Install [](#5-install) ``` just install ``` Sets up the Resource Variables and deploys the initial Nagios configuration. Nagios should now start cleanly. ### 6. Create your first user [](#6-create-your-first-user) ``` ./bin/container-console devture-user:add USERNAME_HERE EMAIL_ADDRESS_HERE ``` You'll be prompted for a password. ### 7. Open it up [](#7-open-it-up) WhatURLCredentialsπŸ–₯️ **Nagadmin**the user you just createdπŸ“Ÿ **Nagios**`NAGIOSADMIN_USER` / `NAGIOSADMIN_PASS` from `.env`Nagadmin's frontend doesn't *replace* the native Nagios CGI interface β€” both run side by side, so you're free to use either (or both). ### 8. Verify [](#8-verify) ``` ./bin/container-console check:status ``` ### Set up a reverse proxy [](#set-up-a-reverse-proxy) The stack publishes the Nagadmin UI (the `nginx` service) and the Nagios UI (the `nagios` service) on the host addresses set by `NGINX_HTTP_BIND_ADDRESS` / `NAGIOS_HTTP_BIND_ADDRESS`. Put a reverse proxy in front of them to add TLS and route your domains. Two approaches: - **Host-level proxy** (nginx, Apache, …) β€” proxy your domains to those published ports. See [`resources/webserver`](resources/webserver) for an nginx example. - **Container-native proxy** (e.g. [Traefik](https://traefik.io)) β€” the `nginx` and `nagios` services each read an optional `label_file` (`var/nginx-labels`, `var/nagios-labels`), empty by default. Drop your proxy's container labels into these files and connect the proxy to the stack's Docker network (`devture-nagadmin_default`). A Traefik example for `var/nginx-labels`: ``` traefik.enable=true traefik.docker.network=devture-nagadmin_default traefik.http.routers.nagadmin.rule=Host(`nagadmin.example.com`) traefik.http.routers.nagadmin.entrypoints=web-secure traefik.http.routers.nagadmin.tls.certResolver=default traefik.http.services.nagadmin.loadbalancer.server.port=8080 ``` The corresponding `var/nagios-labels` would route the Nagios UI on its own host, with `loadbalancer.server.port=80`. You may also want to configure Symfony's trusted proxies via the `SYMFONY_TRUSTED_PROXIES` environment variable (e.g. in `app/.env`), so that the proxy's `X-Forwarded-Proto` is honored and generated URLs come out `https`. βš™οΈ Running in production ------------------------ [](#️-running-in-production) `just run prod` combines `compose.yml` with `compose.prod.yml`, which adds a bundled [exim-relay](https://github.com/devture/exim-relay) `mailer` service for sending Nagios notifications. Point the application at it by setting `MAILER_DSN=smtp://mailer:8025` in the production `app/.env`. Configure outgoing delivery via the repository-root `.env`: - **`SMARTHOST`** β€” upstream SMTP relay as `host::port` (e.g. `smtp.example.com::587`). Leave empty to deliver directly to recipients' MX servers. The relay uses opportunistic STARTTLS, so use a STARTTLS port such as 587 (implicit TLS on port 465 is not supported by this image). - **`SMTP_USERNAME`** / **`SMTP_PASSWORD`** β€” credentials for the smarthost. The relay keeps a persistent on-disk spool (`var/container-data/exim-spool`), so a transient SMTP outage does not lose notifications: queued mail is retried until it is delivered. ❓ FAQ ----- [](#-faq) **Does this support all kinds of esoteric Nagios features?**No β€” Nagadmin optimizes for the common case. See [🚧 Limitations](#-limitations). **Does it provide a frontend to view the status of my services?**Yes. Nagadmin is both a web configurator *and* a frontend β€” a simple alternative to the default Nagios CGI interface, which also remains available alongside it. **Can more than one person log into the Nagios UI?**Yes. The stack seeds a single `nagiosadmin` user from `.env`, but `htpasswd.users` (under `var/container-data/nagios/etc/`) is a standard file you can add users to (`htpasswd -b -s … alice `), then authorize them in `cgi.cfg`. Such changes persist. **What notification channels are supported?**E-mail (via `MAILER_DSN`, typically the bundled exim relay), SMS (via [Vonage](https://www.vonage.com)) and [ntfy](https://ntfy.sh) push notifications. Stock notification commands for all three are seeded into the database. For ntfy, put the contact's full topic URL (e.g. `https://ntfy.sh/my_topic` β€” any server works) in its Address 1 field. In development, e-mail is caught by mailcrab and the other channels are suppressed (`NAGADMIN_NOTIFICATIONS_SUPPRESS_SENDING`), so nobody gets notified for real. **Can I use custom check plugins?**Yes. Drop them into `var/nagios-custom-plugins/` (executable, with the right shebang) and reference them in commands as `$USER1$/custom/`. The directory is mounted read-only into the Nagios container, which provides `sh`, `bash`, `python3`, `curl` and the standard monitoring plugins for them to build on. **Can I import my existing Nagios configuration files?**No. You'd need to start from scratch via the UI. **Can I install the web configurator on a machine separate from Nagios?**No. Nagios runs as part of this all-in-one stack. **I'm running a Nagios-compatible system (Icinga, Shinken, Centreon). Can I use this?**Nagadmin only works with Nagios. Some of these are similar, so you may be able to migrate to Nagios (powered by Nagadmin). **I need to monitor thousands of services. Can I use this?**Not well β€” Nagadmin targets smaller installations and isn't optimized for that scale (yet). **What is it written in?**[PHP](https://php.net), using the [Symfony framework](https://symfony.com/) (the application lives under `app/`). **What are the system requirements?**A Linux server (`amd64` or `arm64`) with Docker and Docker Compose, any distribution. Everything runs in containers. **What about Nagadmin's future?**The source will always be available. The aim is *not* to keep growing features and complexity; community improvements are welcome. 🚧 Limitations ------------- [](#-limitations) These are either features not implemented (yet) or conscious decisions to keep things simple. - **Host checks and notifications** β€” not supported; all hosts are internally forced to an OK state so service checks can run. The automatic service-dependency feature below makes up for it. - **Service groups** β€” not supported (more to enter, little value). - **Templates** (timeperiods/contacts/hosts/services) β€” not supported, to avoid a complex inheritance model. - **Service dependencies** β€” not supported manually, but **automatic** service dependencies are: a service named `ping` or `host-alive` (case-insensitive) automatically becomes the parent of every other service on the same host, so when that "important" service is down, notifications for its children are suppressed. (Configurable via `nagadmin.auto_service_dependency.master_service_regexes` in `app/src/Devture/Bundle/NagiosBundle/Resources/config/services.yaml`.) - **Service escalations** β€” not supported (advanced feature, out of scope for now). - **Event handlers** β€” not supported (advanced feature, out of scope for now). - **Importing existing config files** β€” not supported; reconfigure via the UI. - **Very large installations** β€” the code and UI don't currently scale to thousands of services. πŸ› οΈ Development -------------- [](#️-development) Working on Nagadmin itself? See [docs/development.md](docs/development.md) for the developer tooling β€” static analysis (PHPStan) and the pre-commit hooks. πŸ“œ License --------- [](#-license) [AGPL-3.0](LICENSE). The source code will always be available, and community contributions are welcome. ### Health Score 28 β€” LowBetter than 51% of packages Maintenance61 Regular maintenance activity Popularity9 Limited adoption so far Community11 Small or concentrated contributor base Maturity28 Early-stage or recently created project Bus Factor1 Top contributor holds 99.7% of commits β€” single point of failure How is this calculated?**Maintenance (25%)** β€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** β€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** β€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** β€” Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/9daf523f8e47ddeb8af23183c06721c4e89111eb4eb3f9ce264242b373e9dd80?d=identicon)[spantaleev](/maintainers/spantaleev) --- Top Contributors [![spantaleev](https://avatars.githubusercontent.com/u/388669?v=4)](https://github.com/spantaleev "spantaleev (373 commits)")[![beastafk](https://avatars.githubusercontent.com/u/1488217?v=4)](https://github.com/beastafk "beastafk (1 commits)") --- Tags nagios ### Embed Badge ![Health badge](/badges/devture-nagadmin/health.svg) ``` [![Health](https://phpackages.com/badges/devture-nagadmin/health.svg)](https://phpackages.com/packages/devture-nagadmin) ``` ### Alternatives [kiwicommerce/module-cron-scheduler Easily set up and manage cron jobs from the backend with a beautiful and managed timeline feature. Find the actual load on CPU/Memory by cron job execution. 74608.2k](/packages/kiwicommerce-module-cron-scheduler)[loevgaard/sylius-brand-plugin A Sylius plugin for handling brands 29159.6k3](/packages/loevgaard-sylius-brand-plugin)[dog-ears/crud-d-scaffold Extend Laravel 7's generators scaffold. 183.1k](/packages/dog-ears-crud-d-scaffold) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)