# VRS X Manuals

# [LINUX] VRS X Setup Guide

### Pre-start checklist

Before waking the Linux beast, make sure your system meets the basic requirements:

1. Kernel 5.0 or newer

   Check it with:

   ```bash
   uname -r
   ```

2. OpenSSL 1.1.1 or OpenSSL 3.x with TLS 1.2/1.3 support

   Check it with:

   ```bash
   openssl version
   ```

---

## No sudo needed to run VRSX. Sudo enters the chat only for systemd.

1. Download the Linux zip package from the link provided in the e-mail, for example:

   ```bash
   linux-arm64.zip
   ```

   Use the `linux-arm64` package for ARM64 machines, for example Raspberry Pi 4/5 or other ARM64 devices.

   Use the `linux-x64` package for Intel/AMD 64-bit machines.

2. Unzip the package:

   ```bash
   unzip linux-arm64.zip
   ```

   Or, on Intel/AMD machines:

   ```bash
   unzip linux-x64.zip
   ```

3. Enter the extracted directory:

   ```bash
   cd linux-arm64
   ```

   Or, on Intel/AMD machines:

   ```bash
   cd linux-x64
   ```

4. Make the binary executable:

   ```bash
   chmod +x VRSX
   ```

5. Start VRSX.

   Desktop mode:

   ```bash
   ./VRSX
   ```

   Headless mode:

   ```bash
   ./VRSX --headless
   ```

6. Open VRSX in your browser:

   ```text
   http://IP.OF.YOUR.MACHINE:8085
   ```

   Example:

   ```text
   http://192.168.100.100:8085
   ```

7. Activate VRSX using the license key available under the “My Account” section in ADS-B.Pro RadarView.

**Your instance is ready to go!**

---

## Set up a systemd service, sudo is necessary here

If you want VRSX to start automatically after boot, you can create a systemd service.

The example below assumes:

* your Linux username is `youruser`
* VRSX is located in `/home/youruser/linux-arm64`
* you are running the ARM64 version

If you are using Intel/AMD, replace `linux-arm64` with `linux-x64`.

If your username is not `youruser`, replace `youruser` with your real Linux username.

To check your username, run:

```bash
whoami
```

---

### Create the service file

Open the service file in nano:

```bash
sudo nano /etc/systemd/system/vrsx.service
```

Paste the configuration below:

```ini
[Unit]
Description=VRSX
After=network.target

[Service]
Type=simple
User=youruser
WorkingDirectory=/home/youruser/linux-arm64
ExecStart=/home/youruser/linux-arm64/VRSX --headless
Restart=on-failure
RestartSec=5

[Install]
WantedBy=multi-user.target
```

Before saving, make sure you changed:

```text
youruser
```

to your real Linux username.

If you are using the x64 version, also change:

```text
linux-arm64
```

to:

```text
linux-x64
```

Save and exit nano:

```text
Ctrl+O
Enter
Ctrl+X
```

**WARNING: Old Linux joke:** If you want to create a strong admin password, try editing this file with `vi`.

---

### Enable and start the service

Reload systemd:

```bash
sudo systemctl daemon-reload
```

Enable VRSX at boot and start it now:

```bash
sudo systemctl enable vrsx --now
```

Check service status:

```bash
sudo systemctl status vrsx
```

If everything looks good, open VRSX in your browser:

```text
http://IP.OF.YOUR.MACHINE:8085
```

Example:

```text
http://192.168.100.100:8085
```

Activate VRSX using the license key available under the “My Account” section in ADS-B.Pro RadarView.

---

## RHEL, Rocky Linux, CentOS and SELinux notes

On some RHEL-based systems, SELinux may complain harder than a Windows admin forced to use a terminal.

If the regular `ExecStart` line does not work, you can try wrapping the command in Bash.

Replace this line:

```ini
ExecStart=/home/youruser/linux-arm64/VRSX --headless
```

with:

```ini
ExecStart=/bin/bash -c '/home/youruser/linux-arm64/VRSX --headless'
```

Then reload and restart the service:

```bash
sudo systemctl daemon-reload
sudo systemctl restart vrsx
```

Check the logs if something still refuses to cooperate:

```bash
journalctl -u vrsx -e
```

Or follow logs live:

```bash
journalctl -u vrsx -f
```

---

## Useful service commands

Start VRSX:

```bash
sudo systemctl start vrsx
```

Stop VRSX:

```bash
sudo systemctl stop vrsx
```

Restart VRSX:

```bash
sudo systemctl restart vrsx
```

Disable VRSX from starting at boot:

```bash
sudo systemctl disable vrsx
```

View logs:

```bash
journalctl -u vrsx -e
```

Follow logs live:

```bash
journalctl -u vrsx -f
```

# MacOS setup guide

## Sudo is not necessary anywhere!

### Compatibility information

**Only Apple Silicon is supported.**

This build is intended for Apple Silicon Macs only, for example M1, M2, M3, M4 and newer.

Intel Macs are not supported.

---

## Start VRSX on macOS

1. Download the `osx-arm64.zip` package from releases.

2. macOS may automatically unzip the file after download.

   If it does, move the extracted `osx-arm64` directory anywhere you want.

   If it does not, unzip it manually first.

3. Open the `osx-arm64` directory in Finder and make sure you can see:

   ```text
   VRSX.App
   ```

4. Open Terminal in the `osx-arm64` directory.

   The easiest way:

   * open the `osx-arm64` folder in Finder
   * right-click inside the folder
   * choose “New Terminal at Folder”

   If you do not see that option, open Terminal manually and use `cd` to enter the `osx-arm64` directory.

5. Remove the macOS quarantine flag from the app:

   ```bash
   xattr -dr com.apple.quarantine ./VRSX.App
   ```

   This does not disable Gatekeeper globally. It only tells macOS to stop treating this specific app as a suspicious creature freshly dragged in from the internet swamp.

6. Open VRSX.

   Using Finder:

   ```text
   Double-click VRSX.App
   ```

   Or using Terminal:

   ```bash
   open ./VRSX.App
   ```

7. Known issue: VRSX may not show an icon in the Dock or menu bar.

   I love Apple, including the edible ones, but not this particular behavior.

   For now, VRSX behaves mostly like a background daemon. To stop it, run:

   ```bash
   killall VRSX
   ```

8. Open VRSX in your browser:

   ```text
   http://127.0.0.1:8085
   ```

   You can also use the IP address of your Mac from another device on the same network:

   ```text
   http://IP.OF.YOUR.MAC:8085
   ```

9. Activate VRSX using the license key available under the “My Account” section in ADS-B.Pro RadarView.

10. Enjoy!

---

## Autostart on macOS

macOS uses `launchd`, which is Apple’s own background service creature. It is powerful, weirdly shaped and not documented here yet.

For now, the simplest way to start VRSX automatically is to add it to Login Items.

1. Open:

   ```text
   System Settings
   ```

2. Go to:

   ```text
   General -> Login Items
   ```

3. Add:

   ```text
   VRSX.App
   ```

This is not a full daemon service, but it should be enough for most desktop users.

**NOTE:** Proper `launchd` support may be added later. For now, Login Items is the recommended macOS autostart method.

# Windows (OMG) Manual

## Nah, I hate Windows, but let me try to help ya

The workflow is as simple as Windows, as buggy as Windows and as problematic as... yeah, you guessed correctly. As Windows.

### BEFORE YOU START, READ THIS!

Due to TLS requirements, only certain Windows versions are supported.

**SUPPORTED**

* Windows 10
* Windows 11
* Windows Server 2022
* Windows Server 2025
* newer versions

**MAY WORK, BUT NOT SUPPORTED. NO GUARANTEE.**

* Windows 7
* Windows 8
* Windows 8.1
* Windows Server 2016
* Windows Server 2019

**WILL NOT WORK**

* Windows XP and older
* Windows Vista
* Windows Server 2008 and older
* Windows Server 2012

---

## Start VRSX on Windows

1. Download `win-x64.zip` and extract it.

2. Move the extracted `win-x64` directory anywhere you want.

3. Open the `win-x64` directory and double-click:

   ```text
   VRSX.exe
   ```

   It has no icon yet. Yes, very fancy.

4. Windows SmartScreen will probably show a huge warning:

   ```text
   Windows protected your PC
   Microsoft Defender SmartScreen prevented an unrecognized app from starting.
   ```

   Click:

   ```text
   More info -> Run anyway
   ```

   This happens because VRSX is not code-signed yet. I am not paying Microsoft for a code-signing certificate just for a beta. Windows may complain. Let it have its little moment.

5. VRSX should now be up and running.

6. If Windows Firewall asks for permission, allow access for:

   ```text
   Private Networks
   ```

7. Your browser should open automatically.

   If it does not, open this manually:

   ```text
   http://127.0.0.1:8085
   ```

8. Activate VRSX using the license key available under the “My Account” section in ADS-B.Pro RadarView.

You are now running VRSX on Windows. Nobody panic.

---

## How to make it start automatically?

Windows does not have a simple systemd, because... well, it is Windows.

If you want VRSX to run in the background without a console window staring at you like it knows your browser history, you have two options.

---

### The Lazy Way

Create a shortcut to:

```text
VRSX.exe
```

Then press:

```text
Win + R
```

Type:

```text
shell:startup
```

Press Enter and drop the shortcut into that folder.

VRSX will start when you log in.

Lazy? Yes. Works? Also yes.

---

### The "Pro" Way: NSSM for old-but-bald Windows admins

Old but gold? Nah. Old-but-bald.

This one is for Windows admins who have seen things. Domain controllers at 3 AM. Printer spoolers possessed by demons. Group Policy doing interpretive dance. That one server nobody wants to reboot because “it has always worked like this”.

You know who you are.

NSSM, also known as Non-Sucking Service Manager, is a tiny tool that turns almost any `.exe` into a real Windows Service. Because apparently Windows needs a third-party tool to do what Linux admins solve with one suspiciously simple unit file.

1. Download NSSM.

2. Open Command Prompt as Administrator.

   Yes, Administrator. Windows wants the ceremonial hat.

3. Run:

   ```cmd
   nssm install VRSX
   ```

4. In the NSSM window, select the path to:

   ```text
   VRSX.exe
   ```

5. Set the arguments to:

   ```text
   --headless
   ```

6. Save the service.

BANG. VRSX is now a background service that can start with the OS.

To start it manually:

```cmd
net start VRSX
```

To stop it manually:

```cmd
net stop VRSX
```

Congratulations. You have successfully convinced Windows to behave like a server operating system.