Docs / Install

Raspberry Pi

For Docker hosts running Raspberry Pi OS 64-bit. The instructions are not limited to one specific Raspberry Pi model.

OS and architecture

Vyline publishes a linux/arm64 image, so use 64-bit Raspberry Pi OS. The current Compose configuration does not select a 32-bit ARM image.

uname -m
# expected: aarch64

Hardware

Vyline does not branch behavior based on Raspberry Pi model names. The practical differences are mainly RAM capacity, CPU performance, and storage I/O.

Condition	Impact
4 GB RAM or more	More headroom for large history restores and other containers running at the same time.
Around 1 GB RAM	Restore and sync operations can fall back to swap more easily, increasing response times.
microSD	Docker layers, databases, cache, and media writes all share the same medium.
USB SSD / USB storage	Makes it easier to place persistent data or Docker's data-root on a separate device.

Raspberry Pi OS 64-bit

sudo apt update && sudo apt full-upgrade -y
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
sudo usermod -aG docker "$USER"
# after logging in again
docker run --rm hello-world

This example uses Docker's official convenience script. For long-term operation, also review Docker's Raspberry Pi OS installation and update guidance.

Storage

data/, storage/, and Docker layers are written continuously. For large histories or media libraries, consider placing persistent data on USB SSD or other external storage instead of relying only on microSD.

df -hT
lsblk -o NAME,SIZE,FSTYPE,MOUNTPOINTS,MODEL

Low-memory systems

zram and swap can prevent OOM conditions, but heavy swap I/O during history restore can also slow the API and UI. On systems around 1 GB, stop unnecessary containers and watch both memory and storage I/O during restores.

Start Vyline

mkdir -p ~/vyline && cd ~/vyline
curl -LO https://raw.githubusercontent.com/tqmane/vyline/main/docker-compose.yml
docker compose pull
docker compose up -d
docker compose logs -f --tail=100

Operational checks

Use docker compose ps and docker compose logs --tail=100 to check container state.
Use df -hT to check free space on the filesystem that stores data/ and storage/.
After OS or kernel updates, verify that Docker and Vyline start again.
Do not keep the only backup on the same microSD card that runs the service.