The guide in the console
Open User guide in the console's menu. Its chapters:
Getting started
What WatchZit does, how it works and the first steps after sign-in.
Installing the server
Requirements, install script, packages, the appliance, first sign-in, files and services.
Devices, checks and SNMP
Adding devices, discovery, templates, check types, SNMP, VLANs, HA roles, graphs, configuration backups and hypervisors.
Installing agents
Enrollment codes, Windows and Linux, what the agent reports, agent updates and remote collectors.
Network maps
Drawing and reading maps, pictures, racks and cables, HA groups, layers and paths, kiosk displays and links found on the devices.
Problems, alerts and notifications
Triggers, problems, dependencies, maintenance, notifications, escalation and on-call, syslog, SNMP traps and traffic flows.
Dashboards and reports
Dashboards and availability reports with SLA targets.
Data sources
SQL (PostgreSQL, MySQL, SQL Server), Prometheus, InfluxDB and JSON over HTTP on graphs.
Opening devices
The MaxZit Launcher, how it stays safe, built-in and your own tools, links on every device.
REST API
Personal tokens and the endpoints.
Users, settings and updates
Roles, Active Directory / LDAP and single sign-on, settings, updates, operating system and SSH, certificate, console backup and security.
Troubleshooting and FAQ
Ping and SNMP that do not answer, agents that do not connect, notifications that do not arrive, locked out, logs.
Want to read the guide before installing? Import the appliance image — it takes a few minutes and needs no internet access.
On GitHub
The README describes the product, installation, the appliance and the agents:
Features
Everything WatchZit does, area by area.
Installation
VM images, ISO, install script and packages.
First sign-in
Setup token, first administrator, two-factor sign-in.
The appliance
Setup menu, network, certificate and access settings.
Agents
Enrollment codes, Windows and Linux.
Requirements and ports
Supported systems and the ports to open.
Questions that the guide does not answer: ask in GitHub Discussions or get commercial support.