Portainer Templates logo

Portainer Templates

Arcane Arcane

Stack

Tools

A beautiful, intuitive interface for managing your Docker containers, images, networks, and volumes. No terminal required.

Image details

Architecture: amd64, arm64, arm/v7, riscv64
Image size: 49 MB
User: getarcaneapp

Source details

Repo: getarcaneapp/arcane
Stars: 7k
Forks: 278
Language: Go
License: BSD-3-Clause
Latest: v2.8.0 · 3 days ago
Updated: 2 hours ago
Website: getarcane.app/

Configuration

Type
Compose
Platform
linux
Image
ghcr.io/getarcaneapp/arcane:latest
Ports
3552:3552
Volumes
/var/run/docker.sock : /var/run/docker.sock/app/data : arcane-data/app/data/projects : /portainer/Files/AppData/Config/arcane/projects
Env vars
APP_URL=http://localhost:3552PUID=1000PGID=1000ENCRYPTION_KEY=ec5019c954f3bbbb13b7ee62123594908718ad0dcaac2908501436c26d0beb57JWT_SECRET=08cfa58367486132fd2dcf14d06bad5347625def217588ec067486b7ad75613e
Restart
unless-stopped
Source
Repo

Template by xneo1·Source

Standalone Install

Select an install method, to see config/commands for deploying Arcane

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Arcane, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  arcane:
    image: ghcr.io/getarcaneapp/arcane:latest
    container_name: arcane
    ports:
      - '3552:3552'
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - arcane-data:/app/data
      - /portainer/Files/AppData/Config/arcane/projects:/app/data/projects
    environment:
      - APP_URL=http://localhost:3552
      - PUID=1000
      - PGID=1000
      - ENCRYPTION_KEY=ec5019c954f3bbbb13b7ee62123594908718ad0dcaac2908501436c26d0beb57 ##CHANGEME
      - JWT_SECRET=08cfa58367486132fd2dcf14d06bad5347625def217588ec067486b7ad75613e  ##CHANGEME
    restart: unless-stopped

volumes:
  arcane-data:

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/arcane.yml up -d

More install options in our documentation, or see getarcaneapp/arcane for app-specific guidance.


Arcane Logo

Modern Docker Management, Designed for Everyone.


Go Reference License Known Vulnerabilities Greptile: The War on Bugs


image

Documentation

For setup instructions, configuration details, and development guides, visit the official documentation site.

Sponsors

This project is supported by the following amazing people:

<img src='https://github.com/kmendell/static/blob/main/sponsors.svg?raw=true' alt="Logos" />

Security & Transparency

View the Software Bill of Materials (SBOM) for Arcane at getarcane.app/sbom.

Translating

Help translate Arcane on Crowdin: https://crowdin.com/project/arcane-docker-management
Thank you for checking out Arcane! Your feedback and contributions are always welcome.

Serve Arcane on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying arcane.example.com to http://arcane:3552

Add this to your Caddyfile

arcane.example.com {
	reverse_proxy http://arcane:3552
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3552 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3552
  • Stop the other service, or pick a different host port. In 3552:3552 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:3552. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, arcane can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3552

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/arcane/projects
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Can't reach the Docker socket

arcane talks to Docker through /var/run/docker.sock. If the logs show "permission denied while trying to connect to the Docker daemon socket", the app's user can't access it.

  • Check the socket exists on the host: ls -l /var/run/docker.sock
  • Run the container as root, or add the docker group's id to the container with group_add.

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/getarcaneapp/arcane:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7, riscv64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Arcane is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything Arcane needs bundled into one download. This template pulls ghcr.io/getarcaneapp/arcane:latest, which Docker fetches once (about 49 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Arcane's comes from the GitHub Container Registry, published by getarcaneapp.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, riscv64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 3552:3552 means it's reachable on port 3552 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 3552:3552

Volumes

A volume is where Arcane keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/run/docker.sock from /var/run/docker.sock on the host (a socket it talks to, not storage)
  • /app/data kept in the arcane-data volume Docker manages
  • /app/data/projects from /portainer/Files/AppData/Config/arcane/projects on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Arcane takes 5 of them, all with defaults you can leave alone or tweak:

  • APP_URL, defaults to http://localhost:3552
  • PUID, defaults to 1000
  • PGID, defaults to 1000
  • ENCRYPTION_KEY, defaults to ec5019c954f3bbbb13b7ee62123594908718ad0dcaac2908501436c26d0beb57
  • JWT_SECRET, defaults to 08cfa58367486132fd2dcf14d06bad5347625def217588ec067486b7ad75613e

Restart policy

The restart policy here is unless-stopped, so Docker restarts Arcane after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Arcane sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container arcane. That's what you'll spot in the containers list and use in commands like docker logs arcane.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Arcane is open source, released under the BSD-3-Clause license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Arcane up. Add the template list to Portainer once, then deploying Arcane is a click rather than a wall of config.