From hardware to
command center.

You'll need:

• A Raspberry Pi 4 or 5 with 2 GB of memory or more (4 GB recommended) and its power supply. A USB SSD is strongly recommended over an SD card, which wears out under constant writes. Or a 64-bit Linux server or virtual machine (Proxmox included) running Debian 12 or 13, or Ubuntu 22.04 or 24.04.
• Your two files from your purchase, which arrive by email: the OMNIVAREN package (omnivaren-1.11.2-signed.zip) and your license file (LNS-….omnivaren-license).
• A computer on the same network to connect to the Pi with SSH: Windows Terminal or PowerShell, or the macOS Terminal. MobaXterm on Windows is handy because it shows files too.
• Internet access for the Pi during installation.

Raspberry Pi

1. On your computer, install Raspberry Pi Imager and connect the SSD or SD card.
2. Choose your Pi model, then Raspberry Pi OS (other) › Raspberry Pi OS Lite (64-bit). The 64-bit version is required.
3. When Imager offers OS customisation, choose Edit settings: set a hostname (for example omnivaren), a username and password, and under Services tick Enable SSH. Wired Ethernet is recommended; set up Wi-Fi here only if you need it.
4. Write the card or SSD, connect it to the Pi with the network cable, and power on. The first start takes a couple of minutes.
5. Find the Pi's IP address in your router's list of connected devices, and give it a DHCP reservation (sometimes called a fixed IP) so its address never changes.

Linux server or virtual machine

Install 64-bit Debian 12/13 or Ubuntu 22.04/24.04 (the minimal or server edition is fine) with SSH enabled, and give it a fixed address or DHCP reservation.

Connect and update

From your computer, connect over SSH with your username and the Pi's address, then bring the system up to date and add the unzip tool:

ssh pi@192.168.1.250
sudo apt update && sudo apt full-upgrade -y
sudo apt install -y unzip

Put both files in your home folder on the Pi. Either way works:

• MobaXterm: open your SSH session and drag both files into the Sftp panel on the left (it opens in your home folder).
• PowerShell, Terminal or any command line on your computer, from the folder holding the files:

scp omnivaren-1.11.2-signed.zip LNS-*.omnivaren-license pi@192.168.1.250:~/

Back in your SSH session, unzip the package and start the installer, pointing it at your license file (use your file's actual name):

cd ~
unzip omnivaren-1.11.2-signed.zip
cd omnivaren
sudo OMNIVAREN_LICENSE_FILE=~/LNS-XXXXXXXX-XXXXXXXX.omnivaren-license ./install.sh

It takes a few minutes. Along the way it checks every file against the signed release manifest, verifies the publisher's signature and sets up the HTTPS web server. It asks you a few things:

It finishes with the console's address, for example https://192.168.1.250:8443.

1. On your computer, open the address the installer showed, for example https://192.168.1.250:8443.
2. The browser warns that the connection isn't private. That's expected for now (step 5 fixes it): choose Advanced › Proceed.
3. Sign in with the username and password you just created.

Most panels say Not enabled until you connect your services; the setup guide walks through each one.

OMNIVAREN's HTTPS certificate comes from a private authority on the Pi, because public certificate authorities can't issue certificates for addresses on your home network. Install that authority once on each device you use and the warning disappears. It's required for the phone app.

On the sign-in screen choose Seeing a certificate warning? Trust this console, then Download certificate (the file is named lodestar-ca.crt). Then:

Every backup OMNIVAREN makes is encrypted with a key that exists only on your Pi. Save a copy now:

sudo omnivaren export-key

Keep the key it prints in your password manager. Without it, no backup can ever be restored, for example onto a new Pi after a failure. It's never stored inside a backup.

1. Trust the certificate on the phone first (step 5); browsers only install apps from trusted pages.
2. Android (Chrome): open the console's address, check the address bar shows a lock, then ⋮ › Install app.
3. iPhone (Safari): open the console, then tap Share › Add to Home Screen › Add.

In the console, Systems › Install App shows the exact steps for the device you're on. Away from home, connect your VPN first.