Installation

Requirements

Item

Requirement

Computer

A Linux computer, or a Linux virtual machine (Hyper-V, VirtualBox, VMware), on a 64-bit Intel or AMD processor (x86-64).

Not supported

WSL 2 on Windows and Docker Desktop. They don’t expose the hardware ID that the license is tied to. On a Windows or Mac computer, run OWS in a Linux virtual machine instead.

Docker

Docker Engine, installed and running. See https://docs.docker.com/engine/install/ for your Linux distribution.

Access

An account that can use sudo. The installer and the ows command run as root.

Disk

About 100 MB for OWS itself. Your SDS archive stays where it is; OWS only reads it.

Network

OWS must reach your SeedLink server, and your Winston clients must reach OWS on TCP port 16032 (or the port you choose, see Configuration). Open that port in your firewall if clients connect from other computers.

The installer contains everything OWS needs. It doesn’t download anything, so it also works on computers without internet access.

Install

Copy ows-install.sh to the computer, then run:

chmod +x ows-install.sh
sudo ./ows-install.sh

The installer loads the OWS Docker image (this can take a minute) and creates:

Path

Contents

/usr/local/bin/ows

The ows command (Running OWS).

/opt/osop/ows/config/ows.conf

OWS configuration: SeedLink server, logging (Configuration).

/opt/osop/ows/config/ows-host.conf

Settings for this computer: port and archive location (Configuration).

/opt/osop/license/

Put the license from OSOP here as ows.key (License).

/opt/osop/ows/log/

Log files.

/opt/osop/ows/cache/

OWS’s list of stations and channels, kept between restarts.

/opt/osop/ows/archive/

The default archive location. Point ARCHIVE_DIR at your own SDS archive instead.

When it finishes, the installer prints the next steps. Continue with Configuration and License.

Upgrade

Run the newer ows-install.sh the same way. It keeps your ows.conf, ows-host.conf, license, logs and archive. If OWS is running, switch to the new version with:

sudo ows restart

The installer checks your license file. If it says your ows.key is from an older OWS version, start OWS once with sudo ows and send the machine ID it prints to OSOP for a new license (License).

Uninstall

sudo ows uninstall

This stops OWS and removes the ows command and the OWS Docker image. Your configuration, logs, archive and license in /opt/osop are kept. Delete /opt/osop/ows by hand if you don’t need them, but keep your archive if it is stored there.