Arcane
Run Arcane, a Docker management UI, as a Docker Compose project.
arcane.sh downloads Arcane's basic Compose example, fills in paths and an
encryption key, and starts it.
| Run it | Inside the container or VM. On a Proxmox VE host confirm_not_pve_host warns and asks Continue anyway? (y/N) |
| Requires | Docker with the Compose plugin. If Docker is missing, ensure_docker offers to install it |
| Supported OS | Not checked by the script. ensure_docker installs Docker with apk on Alpine and with setup_docker elsewhere |
| Port | 3552 |
| Source | tools/addon/arcane.sh |
Run
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/tools/addon/arcane.sh)"Prompts
| Prompt | Answer |
|---|---|
Install Arcane? (y/N) | y installs. Anything else exits |
Install Docker now? (y/N) (only when Docker is missing) | y installs Docker. Anything else exits with code 254 |
When /opt/arcane/compose.yaml already exists:
| Prompt | Answer |
|---|---|
Uninstall Arcane? (y/N) | y removes it |
Update Arcane? (y/N) | y updates. Anything else exits with No action selected |
What it creates
| Item | Value |
|---|---|
| Compose project | /opt/arcane/compose.yaml, from docker/examples/compose.basic.yaml in the getarcaneapp/arcane repository |
| Projects directory | /etc/arcane/projects, owned by UID/GID 65532 |
| Builds directory | /etc/arcane/builds, owned by UID/GID 65532 |
| Encryption key | Random, 32 characters, written into the Compose file as both ENCRYPTION_KEY and ARCANE_ENCRYPTION_KEY |
| Update helper | /usr/local/bin/update_arcane |
| Address | http://<ip>:3552 |
| Login | User arcane, password arcane-admin. Arcane asks for a new password on first access |
The two directories are owned by 65532 because the Arcane container runs as that user and must be able to write to its bind mounts.
Update
Run update_arcane, answer y to Update Arcane?, or let the container's
update command offer it (see
how update finds add-ons).
The update re-applies ownership of the two /etc/arcane directories, makes
sure the Compose file carries both the plain and the ARCANE_-prefixed
variable names for ENCRYPTION_KEY and PROJECTS_DIRECTORY, then runs
docker compose pull and docker compose up -d --remove-orphans.
Remove
Uninstall Arcane? runs docker compose down --volumes --remove-orphans,
deletes /opt/arcane and /usr/local/bin/update_arcane. Named volumes of the
project are deleted with it.
/etc/arcane (projects and builds) is not removed. Docker is not removed.