Install the master
Download the release package and install the master, or master + agent, with install.sh.
1. Download the release package
Download 3R Monitor from the official website, 3rsoft.com.pa. The direct link to the latest version is 3rsoft.com.pa/download/3r-monitor. The file is called 3rmonitor-VERSION.tar.gz, for example 3rmonitor-1.1.1.tar.gz.
| File in the package | What it is |
|---|---|
3rmonitor-linux-amd64, -arm64, -arm, -386 | The program, one file per CPU architecture |
install.sh | Installer: install, upgrade and uninstall |
SHA256SUMS | Checksums of the programs; install.sh verifies them before installing |
SHA256SUMS.sig | 3R Soft's signature of the checksums. Agents only update themselves to programs listed in it. |
geoip-country.mmdb | IP-to-country database (DB-IP), for the traffic statistics |
README.md, LICENSE, SECURITY.md, THIRD_PARTY_NOTICES.txt | Documentation, license and third-party notices |
Only the master needs the package. Agents download the program from your master.
The license doesn't allow passing the package on to other people. If someone else wants 3R Monitor, send them to 3rsoft.com.pa.
2. Put it on the server and extract it
Copy the package from your computer:
scp 3rmonitor-1.1.1.tar.gz root@MASTER_SERVER:/root/
ssh root@MASTER_SERVER
tar xzf 3rmonitor-1.1.1.tar.gz && cd 3rmonitor-1.1.1Or download it directly on the server:
curl -fL -o 3rmonitor.tar.gz https://3rsoft.com.pa/download/3r-monitor
tar xzf 3rmonitor.tar.gz && cd 3rmonitor-*/To get a specific version instead of the latest, add ?version=1.1.1 to the download link.
3. Run the installer
Interactive
sudo bash install.shThe installer shows a menu:
| Option | Use it on |
|---|---|
| 1) Agent | A server that reports to an existing master. Agents are easier to install from the panel: see Install the agents. From the release package, give --master and --token on the command line: see Manual installation. |
| 2) Master | A server that only runs the panel and the checks |
| 3) Master + agent (default, recommended) | The master server, which is then monitored too |
| 4) Upgrade | Replace the program with the version in this package, keeping configuration and data |
| 5) Uninstall | Remove 3R Monitor |
For a new master, choose 3. The installer then asks:
- Public panel URL: the address the other servers use to reach the master, and that alert emails link to. The default is
http://THIS_SERVER_IP:8899/. If your servers are in different networks, enter the public IP or domain, not a LAN address. - Admin username (default
admin) and password: at least 8 characters. Press Enter to have one generated; it is shown in the summary at the end.
Unattended
Give everything on the command line and nothing is asked:
sudo bash install.sh both --admin admin --password 'STRONG_PASSWORD' --public-url http://203.0.113.10:8899/If Nginx or Apache is already installed on this server and you want a domain with HTTPS:
sudo bash install.sh both --domain monitor.example.com --https --email you@example.comUse master instead of both if this server should not run the agent.
To install the master without install.sh, step by step, see The master by hand.
Installer options
sudo bash install.sh --help shows them in your language.
| Option | Meaning |
|---|---|
master · both · agent · upgrade · uninstall | Mode; without it, the interactive menu opens |
--port 8899 | Panel port (default 8899) |
--listen 0.0.0.0 | Listen address. Use 127.0.0.1 to serve the panel only through a reverse proxy. |
--public-url URL | Public panel URL, used by agents and in email links. Default http://THIS_IP:PORT/. |
--admin USER --password PASSWORD | Admin account. If omitted, it is asked for, or a password is generated. |
--domain DOMAIN | Create a reverse proxy for this domain in the installed Nginx or Apache |
--https | With --domain: get a free Let's Encrypt certificate with certbot (renewed automatically) and switch the panel to https:// |
--email EMAIL | Email for certificate expiry notices (optional) |
--no-firewall | Don't open the port in the firewall |
--master URL | Agent: the master's URL, the same address you open the panel with |
--token TOKEN | Agent: this server's own token, shown after you add the server in the panel |
--enroll KEY | Agent: bulk enrollment, the server adds itself (can be combined with --name / --group) |
--name NAME --group GROUP | Display name and group when the server adds itself (also in master + agent mode) |
--insecure | Agent: don't verify the master's HTTPS certificate (for self-signed certificates) |
--master-key FP --approvers FP,… | Agent: trust the master's signing key and the administrators' passkeys during the installation, for approved AI repairs. The install command from the panel includes them. |
--purge | With uninstall: also delete the configuration and the data |
-y / --yes | Don't ask anything; use the defaults |
--lang en|es|zh | Installer language. Default: from MONITOR_LANG, LANGUAGE, LC_ALL, LC_MESSAGES or LANG. |
What the installer does
| What | Where |
|---|---|
| The program, and the agent packages that agents download | /opt/3rmonitor (/opt/3rmonitor/dist); the 3rmonitor command in /usr/local/bin and /usr/bin |
| Configuration | /etc/3rmonitor/master.conf and agent.conf |
| Data (SQLite database, IP-to-country database) | /var/lib/3rmonitor, owned by the 3rmonitor user |
| Services | 3rmonitor-master and 3rmonitor-agent: start at boot, restart 3 seconds after a crash, and are restarted by the systemd watchdog if they hang. The master runs in a strict systemd sandbox (3rmonitor-master.service.d/hardening.conf): it can only write to its data directory. Where the system doesn't support it, the installer removes it and says so. |
| The agent's user and helper | The agent runs as the unprivileged user 3rmonitor-agent; 3rmonitor-helper is the small root service that does what needs root, and checks and runs AI operations |
| One-click updates | 3rmonitor-update.path and 3rmonitor-update.service, a small root service that installs the updates you start from the panel |
| Firewall | Opens the panel port in ufw or firewalld |
At the end it prints a summary with ✓ / ✗ for each step, the panel URL, the admin account (and the generated password, if any) and the next steps. Run the installer again at any time: on an existing installation it keeps accounts, settings and data.
4. Sign in
Open the panel URL in your browser and sign in with the admin account. A new installation starts empty. Next:
- Install the agent on your other servers.
- In Settings, check the Time zone (used for every time on the panel and in emails), set up Outgoing mail (SMTP) and the Alert recipients (in Alert notifications). See Settings.
- Add monitors for your websites and APIs.
- If the panel can be reached from the internet, turn on HTTPS.
- Optionally, set up AI analysis.
Use HTTPS on the internet
Over http://, browsers show a "Not secure" warning, and passwords and session cookies travel unencrypted. Opening the panel by IP on a private network is fine; for anything else, see HTTPS.