Arcane Setup Guide

Get Arcane running fast with Docker Compose.

1. Create compose.yaml:

services:
  arcane:
    image: ghcr.io/ofkm/arcane:latest
    container_name: arcane
    ports:
      - '3552:3552'
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - arcane-data:/app/data
      - /host/path/to/stacks:/app/data/stacks
    environment:
      - PUID=1000
      - PGID=1000
      - ENCRYPTION_KEY=xxxxxxxxxxxxxxxxxxxxxx
      - JWT_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxx
    restart: unless-stopped
 
volumes:
  arcane-data:

2. Review Volumes & Imports:

/var/run/docker.sock: Lets Arcane manage Docker.

arcane-data: Persists settings, stacks, users, etc.

To manage existing compose projects, in addition to mounting your compose projects folder to the /app/data/stacks folder, you may need to also mount any additional folders you wish to use for config files.

3. Start Arcane:

docker compose up -d

4. Access Arcane:

Go to localhost:3552 in your browser and follow the setup.