Get started

Install Matmon

One image for Docker, one setup for Windows – pick your row, download, done. Details fold out.

Install

Pick the row that fits your machine. Everything Matmon keeps lives in one place on it – configuration, history and the cloud link.

Docker ComposeLinux server, NAS, Raspberry Pi – any Docker hostrecommendeddocker compose up -d

Put this into docker-compose.yml and start it with docker compose up -d:

docker-compose.yml
services:
  matmon:
    image: ghcr.io/real-ttx/matmon:latest
    container_name: matmon
    restart: unless-stopped
    ports:
      - "8099:8099"
    volumes:
      - matmon-data:/app/data
      # lets Matmon update itself (System > Updates)
      - /var/run/docker.sock:/var/run/docker.sock

volumes:
  matmon-data:
    name: matmon-data

The socket line lets Matmon update itself: it pulls the new image of the tag it runs and replaces its own container, keeping its settings. It also gives the container control over Docker on that machine – leave the line out where that is not acceptable, and update with docker compose pull && docker compose up -d instead.

docker runThe same without Compose, one commandghcr.io/real-ttx/matmon
docker run
docker run -d --name matmon \
  --restart unless-stopped \
  -p 8099:8099 \
  -v matmon-data:/app/data \
  -v /var/run/docker.sock:/var/run/docker.sock \
  ghcr.io/real-ttx/matmon:latest
Windows setupWindows 10 / 11, Windows Server – x64recommended Download .exe

Matmon runs as the Windows service Matmon – program in %ProgramFiles%\Matmon, data in %ProgramData%\Matmon – with an icon in the notification area, and updates itself. The setup asks for the folders, the port, whether other computers may connect (Windows firewall) and whether to show the tray icon. Running it again updates in place; Matmon is removed under Settings › Apps and keeps its data unless you ask otherwise.

unattended – for software distribution
.\MatmonSetup-x64.exe /silent /port=8099 /firewall
Windows online setupSmall download – fetches the newest build while it installs Download .exe

Same setup, same options – it downloads the newest build during setup and checks its checksum and signature before anything is installed.

Windows ZIPNo setup – unpack and register the service yourself Download .zip

Unpack it to a folder of your choice and register the service from an elevated prompt:

PowerShell (as administrator)
.\Matmon.Host.exe install-service

The newest features before they are released: the nightly channel.

Extend it

When one machine is not enough.

Remote probeA second site, behind NAT – no open port neededMatmon__Mode: Secondary

A probe is the same image in Secondary mode. It connects outbound to your primary, so the remote site needs no open port. Give each probe its own id and token:

docker-compose.yml – next to the matmon service
  probe:
    image: ghcr.io/real-ttx/matmon:latest
    container_name: matmon-probe
    restart: unless-stopped
    environment:
      Matmon__Mode: Secondary
      Matmon__ProbeId: probe-01
      Matmon__ProbeName: Remote Probe 01
      Matmon__ProbeToken: change-me-to-a-secret
      Matmon__PrimaryUrl: http://your-primary-host:8099

The probe then appears in the tree; sensors assigned to it run from its network. While the primary is away it keeps collecting and delivers later, with the real times.

Syslog and SNMP trapsReceive the logs and traps of switches, firewalls, servers, UPS514/udp · 162/udp

Switch the Syslog collector and the SNMP trap collector on under System › Plugins – on the primary, or on a probe next to the devices – and publish their ports:

ports of the service
    ports:
      - "8099:8099"
      - "514:514/udp"   # syslog – what most devices send
      - "514:514/tcp"   # syslog over TCP, optional
      - "162:162/udp"   # SNMP traps
AgentsWatch a Windows or Linux machine from the insidefrom your instance

Agents are set up from your own instance, under Agents in its menu. An agent runs as a Windows service or systemd unit, keeps itself up to date – and no plan counts it.

After the install

The first startOpen http://your-host:8099

A short setup wizard creates your admin account – or sets the instance up with your Matmon Cloud account, switches on remote access if you want it and hands you a recovery file. Then:

  • Let discovery find the devices on your network, or add hosts by hand
  • Pick sensors from the catalog – sensible thresholds are already set
  • Add a notification rule: e-mail, a push preset or the browser on your phone
UpdatesSystem › Updates – on request or at night

System › Updates shows the running version, checks for a newer build and installs it on request – or on its own in a nightly window (03:00–05:00 by default). Before every install the configuration is saved as a local snapshot, and when the new version does not come up within three minutes, Matmon goes back to the one that ran. Docker needs the mounted socket for that; the Windows service does it by itself.

Channels: latest are the releases, nightly the newest features. What changed: What's new.

Rather not do it yourself?

A partner installs and looks after Matmon for you – or start with Matmon Cloud.