Install with Portainer

Deploy CrossWatch using Portainer (Stacks or the container UI).

Use Portainer if you prefer a UI over CLI.

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

• A working Docker host connected in Portainer.

• A persistent host folder for CrossWatch state.

  • You will mount it to /config.

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

Option A: Portainer Stack (recommended)

1. In Portainer, go to Stacks → Add stack.

2. Name it crosswatch.

3. Paste this compose file.

4. Update the host path for your /config folder.

5. Deploy the stack.

services:
  crosswatch:
    image: ghcr.io/cenodude/crosswatch:latest
    container_name: crosswatch
    ports:
      - "8787:8787"
    environment:
      - TZ=UTC
    volumes:
      - /path/to/config:/config
    restart: unless-stopped

Open http://<docker-host-ip>:8787.

Option B: Portainer “Add container”

1. Go to Containers → Add container.

2. Name: crosswatch.

3. Image: ghcr.io/cenodude/crosswatch:latest.

4. Publish a port:

   • Host: 8787

   • Container: 8787

5. Add a volume:

   • Host: /path/to/config

   • Container: /config

6. Add an environment variable:

   • TZ=UTC

7. Restart policy: unless-stopped.

Updating

• Stacks: Stacks → crosswatch → Update the stack → (optional) re-pull image → Update.

• Containers: Containers → crosswatch → Recreate (pull latest).

Next steps

• Continue with First-time setup.

• If you need HTTPS, use Reverse proxies or HTTPS/TLS.