mapik/watcher-nms

Watcher NMS

3.2.1 2026-01-28 19:48 UTC

Requires

• php: >=8.1
• cakedc/users: ^15.0.0
• cakephp/cakephp: ~5.2.0
• cakephp/migrations: ~4.6.0
• cakephp/plugin-installer: ^2.0
• composer/composer: ^2.6.6
• dereuromark/cakephp-geo: ^3.0.0
• geocoder-php/google-maps-provider: ^4.7.1
• league/oauth2-google: ^4.0
• mapik/audit-log: ^5.0
• mobiledetect/mobiledetectlib: ^4.8

Requires (Dev)

• cakedc/cakephp-phpstan: ^4.0.0
• cakephp/bake: ^3.0.0
• cakephp/cakephp-codesniffer: ^5.0
• cakephp/debug_kit: ^5.0.0
• josegonzalez/dotenv: ^4.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^2.0
• phpunit/phpunit: ^10.1.0
• psalm/phar: ^6.0

Suggests

• cakephp/repl: Console tools for a REPL interface for CakePHP applications.
• dereuromark/cakephp-ide-helper: After baking your code, this keeps your annotations in sync with the code evolving from there on for maximum IDE and PHPStan/Psalm compatibility.
• markstory/asset_compress: An asset compression plugin which provides file concatenation and a flexible filter system for preprocessing and minification.
• phpstan/phpstan: PHPStan focuses on finding errors in your code without actually running it. It catches whole classes of bugs even before you write tests for the code.

AGPL-3.0-or-later

• Martin Patočka

README

Network Management System for ISPs, built on CakePHP.

Description

• Inventory of access points, network devices, electricity-meter readings, …
• RouterOS device auto-registration via SNMP — devices identify themselves through an HTTP/S request and the matching device-type profile is applied automatically.
• Optional checks for radio interference with Czech weather radar stations.

RouterOS device integration

Configure a scheduler on the RouterOS device to fetch and run a generated configuration script. The script URL embeds the device-type identifier and the device's serial number; the system looks both up and returns the appropriate script response.

/tool fetch url=("https://nms.watcher.domain/routeros-devices/configuration-script/{device-type-identifier}/" . [/system routerboard get serial-number] . "/watcher-config.rsc")
/import watcher-config.rsc
:delay 5
/file remove watcher-config.rsc

To also update the admin password (derived from the serial number and the system‑wide salt), enable this option for the device type in the web UI and ensure the script is imported after fetching.

The currently generated password for each device is shown on its detail page.

Otherwise the script only logs the provisioning status and performs no changes.

Requirements

• PHP 8.2 or newer
• PostgreSQL
• Redis
• PHP snmp extension (only when polling RouterOS devices over SNMP — already bundled in the production Docker image)

The Docker Compose stack below provides PostgreSQL and Redis out of the box, so on a fresh host you only need Docker.

Installation

Two install paths are supported. Docker Compose is recommended.

Option A — Docker Compose (recommended)

git clone https://github.com/Mapiiik/Watcher-NMS.git
cd Watcher-NMS
cp config/.env.example config/.env
# edit config/.env — set APP_NAME and any integration URLs / API keys
docker compose -f compose.production.yaml up -d

The production image runs composer run-script migrations and rebuilds the schema cache automatically on container start, so the app is reachable at http://localhost (and https://localhost with a self-signed cert) once the container is healthy. Set SERVER_NAME in the compose environment to a real domain to enable Let's Encrypt issuance via the bundled acme.sh.

Option B — Bare-metal (host nginx + PHP-FPM, FrankenPHP, …)

For hosts already running their own PHP webserver:

git clone https://github.com/Mapiiik/Watcher-NMS.git
cd Watcher-NMS
composer install --no-dev
cp config/.env.example config/.env
# edit config/.env — at minimum DATABASE_URL and CACHE_*_URL

composer run-script migrations
composer run-script schema-cache

Point your webserver's document root at the webroot/ directory. Install the PHP snmp extension if you intend to poll RouterOS devices over SNMP.

Configuration

Runtime settings live in config/.env (or are passed in as environment variables — see the environment: blocks in the compose files for the keys read at boot). Common groups:

• Database / cache: DATABASE_URL, CACHE_*_URL
• Server: APP_NAME (used as cache prefix), SERVER_NAME (domain for ACME / TLS in the production image)
• Geocoding: the app uses Google Maps via geocoder-php/google-maps-provider; configure the key in config/app_local.php (or your environment file).

Customizing the compose stack

If compose.production.yaml doesn't fit your environment, copy it to compose.yaml and customize there — compose.yaml is git-ignored, so git pull won't overwrite your changes.

cp compose.production.yaml compose.yaml
# edit compose.yaml as needed
docker compose up -d

Typical reasons to override: pointing services at infrastructure already running on the host (e.g. an existing PostgreSQL instance, external Redis, reverse proxy), removing bundled containers you don't need, or tweaking volumes / networks.

Development

Two compose files target local development:

• compose.dev-frankenphp.yaml — FrankenPHP (HTTP/1.1, HTTP/2, HTTP/3)
• compose.dev-nginx.yaml — classic nginx + PHP-FPM

Both bind-mount the working tree into the container and place vendor/, tmp/, logs/, plus the PostgreSQL data directory and Redis data on tmpfs — fast iteration and disposable state, but everything in those paths is lost when the stack is torn down.

docker compose -f compose.dev-frankenphp.yaml up

The Postgres and Redis ports are exposed to the host (5432, 6379) so you can connect with local clients while the stack is running.

License

Watcher NMS is licensed under the GNU Affero General Public License v3.0. Copyright (c) 2026 Martin Patočka.

What this means

You are free to use, modify and run this software. If you modify it and make it available to others (including as a network service), you must also make your modifications available under the same license.