Install on OpenMediaVault

Deploy CrossWatch on OMV using Docker Compose or Portainer.

OMV is usually “Docker + Compose”, optionally managed via Portainer.

We do not provide support for installing or troubleshooting container runtimes.

These pages assume Docker (or your NAS container manager) is already installed and working.

If Docker itself is broken, use your platform docs first.

The install guides are provided for reference only.

What you need

• OMV with Docker installed (commonly via omv-extras).

• A persistent folder on your data disk for CrossWatch state.

Do not run without the /config volume. You will lose state when the container is recreated.

Option A: Docker Compose on OMV (recommended)

1. Pick a folder on your data disk.

   • Example: /srv/dev-disk-by-uuid-XXXX/appdata/crosswatch/config

2. Create docker-compose.yml:

services:
  crosswatch:
    image: ghcr.io/cenodude/crosswatch:latest
    container_name: crosswatch
    ports:
      - "8787:8787"
    environment:
      - TZ=UTC
    volumes:
      - /srv/dev-disk-by-uuid-XXXX/appdata/crosswatch/config:/config
    restart: unless-stopped

Start it:

docker compose up -d

Open http://<omv-ip>:8787.

Option B: Portainer

If you already use Portainer, follow Install with Portainer and just use your OMV path for /config.

Permissions for /config

If CrossWatch can’t write to /config, fix the folder ownership/permissions.

You can also set APP_UID/APP_GID to match the folder owner.

Next steps

• Continue with First-time setup.