Quick Start

Start Vyline with the published Docker image. The examples here follow the repository's standard Compose configuration.

Requirements

• A 64-bit Docker host. Published images are built for linux/amd64 and linux/arm64.
• Docker Engine and Docker Compose v2.
• Storage for persistent data.

1. Get the Compose file

mkdir -p vyline && cd vyline
curl -LO https://raw.githubusercontent.com/tqmane/vyline/main/docker-compose.yml
docker compose pull
docker compose up -d

The standard image is ghcr.io/tqmane/vyline:latest. The container listens on port 3000, which is published to host port 3000 by default.

2. Open it in a browser

http://127.0.0.1:3000

The default VYLINE_BIND_ADDRESS is 0.0.0.0, while VYLINE_LAN_ACCESS defaults to false. The backend rejects unauthenticated access from non-loopback peers.

3. Protect persistent data

The standard Compose file bind-mounts host ./data to /app/data and host ./storage to /app/storage.

4. Verify

docker compose ps
docker compose logs --tail=100

The image includes a health check against /healthz. To update, run docker compose pull && docker compose up -d so the container is recreated with the new image.

Next

• Regular server: Linux
• Raspberry Pi: Raspberry Pi
• Android device: Android
• Portainer: Portainer
• Remote access: Remote Access