Skip to main content

Getting Started

To download, install, and run VirtualMetric Director, follow the instructions below.

System Requirements​

Director supports the amd64 and arm64 versions of Windows, Linux, and macOS. Its minimum requirements are:

  • 1 CPU core - We recommend using a machine with at least 2 CPU cores. As our system uses a vectorized pipeline and can utilize all available cores, having multiples cores will improve performance
  • 150MB memory
  • 250MB disk space

VirtualMetric Director is designed with a strong focus on data safety, utilizing a write-ahead log (WAL) to ensure data integrity. This log is stored in the same directory as the binary and is automatically managed by the system.

If you need to retain logs for extended periods or minimize potential data loss in case of unexpected failures, consider allocating additional disk space accordingly.

Installation​

Director is a single binary, requiring no dependencies or prerequisites, so you can easily download and place it anywhere on your system. It can be installed on a traditional server, on an on-premises virtual machine, or in the cloud. It can also be deployed as an Azure App for a serverless configuration.

You can install Director online or offline, depending on your system's internet access.

warning

The installation process requires administrative privileges if you choose to run it as a service.

Online​

If your system has internet access, you can use our automated installation scripts for a quick setup.

note

The dl.vget.me file contains our official installation script that performs the steps listed below.

To run as a background process:

iwr dl.vget.me | iex

To install as a service:

$p="C:\Program Files\VirtualMetric"; iwr dl.vget.me | iex

The script will

  • detect your operating system and architecture
  • download the appropriate version
  • install and configure the binary based on your selected method (service or background process)
  • launch the executable

Offline​

For systems without internet access, you can download and install Director manually. Choose the appropriate binary for your system from the table below:

Operating SystemDownload Link
WindowsAMD64
ARM64
LinuxAMD64
ARM64
macOSAMD64
ARM64

Director does not require administrative privileges to run as a background process. However, if you choose to install it as a service, administrative privileges are required for the installation. Once installed, you can run it with regular user privileges.

This documentation assumes you are installing Director as a service. If you do not have the necessary privileges to run it as a service, you can configure Director to run as a Scheduled Task (on Windows) or a Cron job (on Linux/macOS) to ensure it starts automatically after a reboot.

Once you have downloaded the binary, open a terminal as Administrator on Windows, as sudo on Linux, or as root on macOS. Then, create and navigate to the directory where you want to run VirtualMetric Director, and copy the downloaded binary into it.

cd `C:\Program Files\VirtualMetric`

If you don't have enough priviliges to start the service, you can run Director as a background process:

.\vmetric-director.exe -background

You can also start Director as a service by running the following commands:

.\vmetric-director.exe -service install
.\vmetric-director.exe -service start

Post-Installation​

After completing the above steps, if you install VirtualMetric Director as a service, you can verify its status using the following commands:

Get-Service vmetric-director