Why Veyon Agent is Required?

To collect metrics like CPU spikes, low RAM, disk volume usage, and active system services (nginx, mysql, etc.), Veyon requires a lightweight background worker to run locally on your host machine.

Veyon simplifies this deployment down to a single-line installation script. The moment you register a new server, the dashboard provides a unique, time-sensitive install token that automatically maps the incoming server telemetry directly to your account workspace.


Step-by-Step Installation Guide

Before starting, ensure you have an active terminal connection to your target machine and administrative privileges.




Step-1. Prerequisite – Establish an SSH Connection:

Open your local terminal or terminal client and SSH into your target server as a user with root or sudo access:

ssh username@your-server-ip


Step-2. Dashboard Action – Copy the Auto-Generated Command:

Locate the secure, single-line installation string in the Installation Command card and click the blue Copy button.



Token Expiration Notice: The unique authorization token embedded in the installation string is valid for 3 hours from page load. If you do not run the script within this window, simply refresh the browser page to generate a fresh token string.


Step-3. Terminal Action – Execute the Script on Your Server:

Paste the copied string directly into your server's terminal and press Enter. The command uses curl to fetch the binary payload securely and routes it to sudo bash for automated environment creation:

curl -fsSL https://veyon.app/api/resource-monitor/install/[your-unique-token] | sudo bash

 

Step-4. Verification – Await Automated Handshake:

After successful installation of the Veyon Agent, return to your browser window.  Keep your browser window open. The Veyon UI will continuously check for data from your server and display a yellow "Waiting for first data..." message. Once the script successfully completes its local setup and shoots its first telemetry packet back to Veyon, the page will automatically refresh and redirect you to your live Server Overview dashboard.


Under the Hood: What the Script Executes

When the installation macro fires on your host machine, it silently executes the following structural adjustments to keep your system safe and stable:

  • Directory Isolation: The monitoring script files, configuration models, and application configurations are isolated entirely inside /opt/veyon-monitor/.
  • Resource Matching: The setup reads and anchors your server’s unique environment ID so its metric payload never mixes with other servers in your fleet.
  • Cron & Scheduling: The script automatically spins up a native systemd timer that wakes up every 60 seconds to pull and transmit standardized system summaries.
  • High-Resolution Monitoring: A highly optimized, long-running background daemon runs locally to collect high-resolution CPU behavior samples at aggressive 5-second intervals, allowing the app to catch micro-spikes that generic 1-minute tracking completely misses.

Note: Veyon does not collect any data, it only collects & tracks server’s hardware behavior samples.


Completely Removing the Agent

If you ever decide to scale down your infrastructure, decommission a cloud instance, or stop monitoring a specific host, Veyon includes a clean uninstall routine that wipes all script footprint remnants instantly.

Run the following command in your server's terminal to safely purge the daemon, systemd timers, and configurations:


sudo /opt/veyon-monitor/uninstall.sh