Skip to content

Instance Generator

Choose where Arcane runs, fill in the fields, then copy or download the files. See the installation guide or the environment variables.

Show

Deployment

Role
Runs on

Basics

Image, address, and file ownership.

Registry to pull the Manager image from.

The address you open Arcane at, with http:// or https://.

Host port that serves Arcane.

User ID that owns files Arcane creates. Rootless Podman: run id -u.

Group ID that owns files Arcane creates. Rootless Podman: run id -g.

More options (1)

Named volume for Arcane's data.

Host access

Choose how Arcane reaches the container engine on this host.

Host path to the Docker socket. On Podman, use the Podman socket.

Send Docker API calls through a filtering proxy instead of mounting the socket.

Relabel bind mounts and turn off labeling for the socket mount.

More options (2)

Adds the mounts Arcane needs for host metrics in LXC, such as Proxmox.

Runs arcane health every 10 seconds.

Storage

Optional host folder for Compose projects, mounted at the same path inside the container.

Absolute host path to your Compose projects folder.

Runtime

Logging and runtime behavior.

How much Arcane logs. Default: Info.

Write logs as JSON, for log collectors.

IANA timezone for scheduled jobs. Default: UTC.

More options (1)

Raises the GitHub rate limit for image release notes.

OpenTelemetry

Send metrics, traces, and logs to an OTLP collector.

Network

Reverse proxy trust and direct HTTPS.

Comma-separated CIDR ranges of your proxies. Arcane trusts their forwarded headers.

Use your own certificate instead of a reverse proxy.

Security

The key Arcane uses to encrypt stored secrets.

Required

Encrypts stored secrets. Save a copy: Arcane can't decrypt them without it.

Database

Arcane uses SQLite unless you switch to PostgreSQL.

Authentication

Single sign-on through your OIDC provider.

Docker Compose

Save the Compose file on your Docker host, then start Arcane.

Docs

Fix this field to copy or download: