Environment Variables
Every environment variable Arcane reads, and which settings you can override from the environment.
Set these variables on the Arcane container in your Compose file. Most settings can also be changed later in the Settings UI.
Jump to: Manager Settings overrides Agent
217 of 217 variables
No variables match. Try a shorter name or clear the search.
Manager variables
Section titled “Manager variables”For the ARCANE_DATABASE_URL Postgres format, see External Postgres database.
Settings overrides
Section titled “Settings overrides”Set a variable below to override that setting. The UI locks the setting and shows Set by with the variable name.
- An invalid value stops Arcane at startup.
ARCANE_UI_CONFIGURATION_DISABLED=truemakes every setting read-only in the UI.
| Variable | Details |
|---|---|
ARCANE_AUTO_HEAL_INTERVAL | How often to check container health (cron expression) Requires: ARCANE_AUTO_HEAL_ENABLED=true to have effect at runtime. |
ARCANE_ENVIRONMENT_HEALTH_INTERVAL | How often to check environment connectivity (cron expression) |
ARCANE_EVENT_CLEANUP_INTERVAL | How often to delete old events (cron expression) |
ARCANE_EXPIRED_SESSIONS_CLEANUP_INTERVAL | How often to delete expired and old revoked sessions (cron expression) |
ARCANE_ACTIVITY_HISTORY_MAX_ENTRIES | Maximum completed Activity Center entries to keep per environment. Set 0 to disable count-based cleanup. |
ARCANE_ACTIVITY_HISTORY_RETENTION_DAYS | Delete completed Activity Center entries older than this many days. Set 0 to disable age-based cleanup. |
ARCANE_MAX_CONCURRENT_ACTIVITIES | Maximum long-running activities per environment before new ones queue. Set 0 for unlimited. |
ARCANE_UPGRADE_LOG_RETENTION_DAYS | Delete upgrade log files older than this many days. Cleanup runs hourly. Set 0 to keep logs indefinitely. |
ARCANE_AUTH_LOCAL_ENABLED | Enable local username/password authentication |
ARCANE_AUTH_PASSWORD_MIN_LENGTH | Minimum number of characters a password must contain |
ARCANE_AUTH_PASSWORD_REQUIRE_LOWERCASE | Require at least one lowercase letter in passwords |
ARCANE_AUTH_PASSWORD_REQUIRE_NUMBER | Require at least one number in passwords |
ARCANE_AUTH_PASSWORD_REQUIRE_SYMBOL | Require at least one symbol in passwords |
ARCANE_AUTH_PASSWORD_REQUIRE_UPPERCASE | Require at least one uppercase letter in passwords |
ARCANE_AUTH_SESSION_TIMEOUT | How long user sessions remain active |
ARCANE_HSTS_ENABLED | Send the Strict-Transport-Security header on HTTPS responses |
ARCANE_LDAP_ATTRIBUTE_GROUP_MEMBER | Group attribute that lists its members |
ARCANE_LDAP_ATTRIBUTE_GROUP_NAME | Group attribute matched against role mappings |
ARCANE_LDAP_ATTRIBUTE_USER_DISPLAY_NAME | User attribute that holds the display name |
ARCANE_LDAP_ATTRIBUTE_USER_EMAIL | User attribute that holds the email address |
ARCANE_LDAP_ATTRIBUTE_USER_PROFILE_PICTURE | User attribute that holds a profile picture URL or image data |
ARCANE_LDAP_ATTRIBUTE_USER_UNIQUE_IDENTIFIER | User attribute that uniquely and permanently identifies a user |
ARCANE_LDAP_ATTRIBUTE_USER_USERNAME | User attribute that holds the username |
ARCANE_LDAP_BASE | Base DN to search for users and groups |
ARCANE_LDAP_BIND_DN | Distinguished name of the service account used to read the directory |
ARCANE_LDAP_BIND_PASSWORD | Password of the LDAP service account Sensitive |
ARCANE_LDAP_ENABLED | Enable LDAP user sync and sign-in |
ARCANE_LDAP_SKIP_CERT_VERIFY | Skip TLS certificate verification for the LDAP server |
ARCANE_LDAP_SOFT_DELETE_USERS | Disable users removed from the directory instead of deleting them |
ARCANE_LDAP_START_TLS | Upgrade ldap:// connections to TLS before sending credentials |
ARCANE_LDAP_SYNC_INTERVAL | How often to sync users from LDAP (cron expression) |
ARCANE_LDAP_URL | LDAP server URL, for example ldaps://ldap.example.com:636 |
ARCANE_LDAP_USER_GROUP_SEARCH_FILTER | Filter that selects the groups to sync |
ARCANE_LDAP_USER_SEARCH_FILTER | Filter that selects the users to sync |
ARCANE_OIDC_AUTHORIZATION_ENDPOINT | Override OIDC authorization endpoint |
ARCANE_OIDC_AUTO_REDIRECT_TO_PROVIDER | Automatically redirect to OIDC provider on login page |
ARCANE_OIDC_CLIENT_ID | OIDC provider client ID |
ARCANE_OIDC_CLIENT_SECRET | OIDC provider client secret Sensitive |
ARCANE_OIDC_DEVICE_AUTHORIZATION_ENDPOINT | Override OIDC device authorization endpoint for CLI authentication |
ARCANE_OIDC_ENABLED | Enable OpenID Connect (OIDC) authentication |
ARCANE_OIDC_GROUPS_CLAIM | Claim name to read group memberships from for role mapping |
ARCANE_OIDC_ISSUER_URL | OIDC provider issuer URL |
ARCANE_OIDC_JWKS_ENDPOINT | Override OIDC JWKS endpoint |
ARCANE_OIDC_MERGE_ACCOUNTS | Allow OIDC logins to merge with existing accounts by email |
ARCANE_OIDC_MOBILE_REDIRECT_URIS | Comma-separated allowlist of native app redirect URIs (e.g., arcane-mobile://oidc-callback) |
ARCANE_OIDC_PROVIDER_LOGO_URL | Custom logo URL for the OIDC provider |
ARCANE_OIDC_PROVIDER_NAME | Custom name for the OIDC provider (e.g., Authentik, Keycloak) |
ARCANE_OIDC_SCOPES | OIDC scopes to request |
ARCANE_OIDC_SKIP_TLS_VERIFY | Skip TLS verification for OIDC provider |
ARCANE_OIDC_TOKEN_ENDPOINT | Override OIDC token endpoint |
ARCANE_OIDC_USERINFO_ENDPOINT | Override OIDC userinfo endpoint |
ARCANE_BUILDS_DIRECTORY | Root directory for manual build workspaces |
ARCANE_BUILD_HISTORY_RETENTION_DAYS | Delete completed and failed image build records older than this many days. Set 0 to disable age-based cleanup. |
ARCANE_BUILD_PROVIDER | Default build provider (local or depot) |
ARCANE_BUILD_TIMEOUT | Timeout for BuildKit builds in seconds |
ARCANE_DEPOT_PROJECT_ID | Depot project identifier |
ARCANE_DEPOT_TOKEN | Depot API token Sensitive |
ARCANE_AUTO_INJECT_ENV | Automatically inject project .env variables into all containers |
ARCANE_BASE_SERVER_URL | Set the base URL for the application |
ARCANE_DEFAULT_DEPLOY_PULL_POLICY | Default image pull policy when deploying projects |
ARCANE_DEFAULT_SHELL | Default shell to use for commands |
ARCANE_PRUNE_BUILD_CACHE_MODE | Select how build cache should be pruned when the scheduled prune job runs Requires: ARCANE_SCHEDULED_PRUNE_ENABLED=true to have effect at runtime. |
ARCANE_PRUNE_BUILD_CACHE_UNTIL | Duration threshold for scheduled build cache prune when mode is olderThan Requires: ARCANE_SCHEDULED_PRUNE_ENABLED=true and ARCANE_PRUNE_BUILD_CACHE_MODE=olderThan to have effect at runtime. |
ARCANE_PRUNE_CONTAINER_MODE | Select how containers should be pruned when the scheduled prune job runs Requires: ARCANE_SCHEDULED_PRUNE_ENABLED=true to have effect at runtime. |
ARCANE_PRUNE_CONTAINER_UNTIL | Duration threshold for scheduled container prune when mode is olderThan Requires: ARCANE_SCHEDULED_PRUNE_ENABLED=true and ARCANE_PRUNE_CONTAINER_MODE=olderThan to have effect at runtime. |
ARCANE_PRUNE_IMAGE_MODE | Select how images should be pruned when the scheduled prune job runs Requires: ARCANE_SCHEDULED_PRUNE_ENABLED=true to have effect at runtime. |
ARCANE_PRUNE_IMAGE_UNTIL | Duration threshold for scheduled image prune when mode is olderThan Requires: ARCANE_SCHEDULED_PRUNE_ENABLED=true and ARCANE_PRUNE_IMAGE_MODE=olderThan to have effect at runtime. |
ARCANE_PRUNE_NETWORK_MODE | Select how networks should be pruned when the scheduled prune job runs Requires: ARCANE_SCHEDULED_PRUNE_ENABLED=true to have effect at runtime. |
ARCANE_PRUNE_NETWORK_UNTIL | Duration threshold for scheduled network prune when mode is olderThan Requires: ARCANE_SCHEDULED_PRUNE_ENABLED=true and ARCANE_PRUNE_NETWORK_MODE=olderThan to have effect at runtime. |
ARCANE_PRUNE_VOLUME_MODE | Select how volumes should be pruned when the scheduled prune job runs Requires: ARCANE_SCHEDULED_PRUNE_ENABLED=true to have effect at runtime. |
ARCANE_TOOLS_IMAGE_REGISTRY | Container registry used to pull the Arcane tools helper image |
ARCANE_UPDATE_CHECK_REGISTRY | Registry queried when checking whether the Arcane image has a newer digest |
ARCANE_DEVELOPMENT_BRANDING_ENABLED | Show the development icon instead of the standard Arcane logo on non-stable builds |
ARCANE_EXPERIMENTAL_FEATURES_ENABLED | Enable experimental features that may change or be removed in future releases |
ARCANE_FEATURE_SWARM_ENABLED | Show Docker Swarm for this environment. An active swarm cluster keeps it enabled An active swarm cluster keeps Swarm enabled regardless of this value. |
ARCANE_FEATURE_VULNERABILITY_MANAGEMENT_ENABLED | Enable vulnerability management for this environment. Disabling retains reports and configuration and leaves standalone image patching available Disabling retains existing reports and scanner settings, allows active work to finish, and leaves standalone image patching available. |
ARCANE_ALL_ENVIRONMENTS_LIMIT | Maximum environments included in one all-environments request |
ARCANE_ANALYTICS_ENABLED | Send an anonymous usage heartbeat |
ARCANE_AUTO_HEAL_ENABLED | Automatically restart containers that become unhealthy |
ARCANE_AUTO_HEAL_EXCLUDED_CONTAINERS | Comma-separated list of containers to exclude from auto-heal Requires: ARCANE_AUTO_HEAL_ENABLED=true to have effect at runtime. |
ARCANE_AUTO_HEAL_MAX_RESTARTS | Maximum auto-heal restarts per container within the restart window Requires: ARCANE_AUTO_HEAL_ENABLED=true to have effect at runtime. |
ARCANE_AUTO_HEAL_RESTART_WINDOW | Time window in minutes for counting auto-heal restarts Requires: ARCANE_AUTO_HEAL_ENABLED=true to have effect at runtime. |
ARCANE_AUTO_UPDATE | Automatically update containers when new images are available |
ARCANE_AUTO_UPDATE_DELAY | Hours a new image must be available before auto-update applies it (0 = immediately) Requires: ARCANE_AUTO_UPDATE=true to have effect at runtime. |
ARCANE_AUTO_UPDATE_EXCLUDED_CONTAINERS | Comma-separated list of containers to exclude from auto-update |
ARCANE_AUTO_UPDATE_INTERVAL | How often to check for automatic updates (cron expression) Requires: ARCANE_AUTO_UPDATE=true to have effect at runtime. |
ARCANE_DOCKER_CLIENT_REFRESH_INTERVAL | How often to refresh the cached Docker client API version (cron expression) |
ARCANE_FRONTEND_CACHE_MINUTES | Minutes the browser keeps page data after leaving the page |
ARCANE_GITHUB_TOKEN | Optional GitHub token used to fetch image release notes with a higher API rate limit Sensitive |
ARCANE_GPU_MONITORING_ENABLED | Report GPU VRAM usage in system stats |
ARCANE_GPU_TYPE | GPU vendor to monitor, or auto to detect it |
ARCANE_IMAGE_EVENT_WATCHER_ENABLED | Check image registries immediately after Docker image events |
ARCANE_POLLING_ENABLED | Enable automatic checking for image updates |
ARCANE_POLLING_INTERVAL | How often to check for image updates (cron expression) |
ARCANE_PROJECT_SCAN_MAX_DEPTH | Maximum directory depth searched when discovering projects |
ARCANE_PROJECT_SCAN_SKIP_DIRS | Comma-separated directory names skipped during project discovery and workspace listing |
ARCANE_PROJECT_WORKSPACE_MAX_DEPTH | Maximum directory depth listed in the project workspace |
ARCANE_PROJECT_WORKSPACE_MAX_ENTRIES | Maximum number of entries listed in the project workspace |
ARCANE_PROJECT_WORKSPACE_MAX_FILE_SIZE_MB | Largest project workspace file that can be viewed, edited, or uploaded |
ARCANE_SCHEDULED_PRUNE_ENABLED | Enable scheduled pruning of unused Docker resources |
ARCANE_SCHEDULED_PRUNE_INTERVAL | How often to run scheduled prunes (cron expression) Requires: ARCANE_SCHEDULED_PRUNE_ENABLED=true to have effect at runtime. |
ARCANE_UPDATE_CHECK_ENABLED | Check for new Arcane releases |
ARCANE_UPGRADE_MAX_PARALLEL_AGENTS | Maximum remote environments upgraded at once by Update all. The manager always upgrades last. |
ARCANE_VOLUME_HELPER_IDLE_TIMEOUT | Minutes a volume helper container may sit idle before automatic removal (0 disables) |
ARCANE_VOLUME_WORKSPACE_MAX_ENTRIES | Maximum number of entries listed per folder in the volume workspace |
ARCANE_VOLUME_WORKSPACE_MAX_FILE_SIZE_MB | Largest volume workspace file that can be viewed, edited, or uploaded |
DOCKER_HOST | URI for Docker daemon |
ARCANE_APNS_ENABLED | Let users receive native push notifications in the Arcane mobile app |
ARCANE_NOTIFICATIONS_INCLUDE_RELEASE_LINKS | Add a link to the image's release notes in image update notifications |
ARCANE_IMAGE_AUTO_PATCH_ENABLED | Automatically patch images whose latest vulnerability scan found fixable OS package vulnerabilities |
ARCANE_IMAGE_AUTO_PATCH_INTERVAL | How often to run scheduled image patching (cron expression) |
ARCANE_IMAGE_PATCH_ALL_PLATFORMS | Patch every platform in a multi-platform image instead of only the platform this server runs on |
ARCANE_IMAGE_PATCH_SUFFIX | Suffix appended to the source tag when patching an image |
ARCANE_IMAGE_PATCH_TIMEOUT_SEC | Timeout for a single image patch operation in seconds |
ARCANE_LIFECYCLE_DEFAULT_RUNNER_IMAGE | Default container image used to run GitOps pre-deploy lifecycle scripts when a sync does not override it |
ARCANE_LIFECYCLE_ENABLED | Allow GitOps syncs to configure pre-deploy lifecycle scripts. Disabled by default because scripts are repo-trusted code that runs on every deploy |
ARCANE_LIFECYCLE_MAX_TIMEOUT_SEC | Maximum allowed timeout for lifecycle scripts in seconds |
ARCANE_TRIVY_CONCURRENT_SCAN_CONTAINERS | Maximum number of concurrent Trivy scan containers for manual and scheduled scans. Minimum 1 |
ARCANE_TRIVY_CONFIG | Trivy configuration file content in YAML format |
ARCANE_TRIVY_CPU_LIMIT | Maximum CPU cores for Trivy scan containers (supports decimals, e.g. 1.5). Set 0 to disable CPU limit |
ARCANE_TRIVY_DB_REGISTRY | Container registry used to pull the Trivy vulnerability database artifacts |
ARCANE_TRIVY_IGNORE | Trivy ignore file content - one vulnerability ID per line |
ARCANE_TRIVY_IGNORE_UNFIXED | Only report vulnerabilities that have a known fix available. Reduces noise from vulnerabilities you cannot act on. |
ARCANE_TRIVY_MEMORY_LIMIT_MB | Maximum memory for Trivy scan containers in MB. Set 0 to disable memory limit |
ARCANE_TRIVY_NETWORK | Docker network mode/network name used for Trivy scan containers. Leave empty to inherit Arcane's network automatically. |
ARCANE_TRIVY_PRIVILEGED | Run Trivy scan containers in privileged mode when required by the host security policy |
ARCANE_TRIVY_RESOURCE_LIMITS_ENABLED | Enable CPU and memory limits for Trivy scan containers |
ARCANE_TRIVY_SECURITY_OPTS | Docker security options applied to Trivy scan containers. Use commas or new lines to separate entries (for example: label=disable) |
ARCANE_TRIVY_SERVER_ENABLED | Scan against a remote Trivy server instead of downloading the vulnerability database locally. Recommended for 32-bit hosts (arm/v7) where the local DB cannot be memory-mapped. |
ARCANE_TRIVY_SERVER_TOKEN | Optional authentication token sent to the remote Trivy server. Leave empty if the server requires no token. Sensitive |
ARCANE_TRIVY_SERVER_URL | URL of the remote Trivy server (e.g. http://trivy.example.com:4954). Used when client/server mode is enabled. |
ARCANE_VULNERABILITY_SCAN_ENABLED | Enable scheduled vulnerability scanning of all Docker images |
ARCANE_VULNERABILITY_SCAN_INTERVAL | How often to run scheduled vulnerability scans (cron expression) Requires: ARCANE_FEATURE_VULNERABILITY_MANAGEMENT_ENABLED=true and ARCANE_VULNERABILITY_SCAN_ENABLED=true to have effect at runtime. |
ARCANE_VULNERABILITY_THREAT_INTEL_ENABLED | Fetch the CISA KEV catalog and FIRST EPSS scores to prioritize exploited vulnerabilities. Disable for air-gapped installs. Requires: ARCANE_FEATURE_VULNERABILITY_MANAGEMENT_ENABLED=true to have effect at runtime. |
ARCANE_VULNERABILITY_UPDATE_GATE_ENABLED | Scan each updated image with Trivy and block the update when it exceeds the vulnerability limits Requires: ARCANE_FEATURE_VULNERABILITY_MANAGEMENT_ENABLED=true to have effect at runtime. |
ARCANE_VULNERABILITY_UPDATE_GATE_MAX_CRITICAL | Highest number of critical vulnerabilities an update may contain (-1 = no limit) Requires: ARCANE_FEATURE_VULNERABILITY_MANAGEMENT_ENABLED=true and ARCANE_VULNERABILITY_UPDATE_GATE_ENABLED=true to have effect at runtime. |
ARCANE_VULNERABILITY_UPDATE_GATE_MAX_HIGH | Highest number of high vulnerabilities an update may contain (-1 = no limit) Requires: ARCANE_FEATURE_VULNERABILITY_MANAGEMENT_ENABLED=true and ARCANE_VULNERABILITY_UPDATE_GATE_ENABLED=true to have effect at runtime. |
ARCANE_VULNERABILITY_UPDATE_GATE_MAX_LOW | Highest number of low vulnerabilities an update may contain (-1 = no limit) Requires: ARCANE_FEATURE_VULNERABILITY_MANAGEMENT_ENABLED=true and ARCANE_VULNERABILITY_UPDATE_GATE_ENABLED=true to have effect at runtime. |
ARCANE_VULNERABILITY_UPDATE_GATE_MAX_MEDIUM | Highest number of medium vulnerabilities an update may contain (-1 = no limit) Requires: ARCANE_FEATURE_VULNERABILITY_MANAGEMENT_ENABLED=true and ARCANE_VULNERABILITY_UPDATE_GATE_ENABLED=true to have effect at runtime. |
ARCANE_DISK_USAGE_PATH | Path used for disk usage calculations |
ARCANE_FOLLOW_PROJECT_SYMLINKS | Treat symlinked child directories inside the projects directory as Docker Compose projects |
ARCANE_GIT_SYNC_MAX_BINARY_SIZE_MB | Maximum size in MB for a single binary file copied during a Git sync. Set 0 to disable the environment cap |
ARCANE_GIT_SYNC_MAX_FILES | Maximum number of repository files copied during a Git sync. Set 0 to disable the environment cap |
ARCANE_GIT_SYNC_MAX_TOTAL_SIZE_MB | Maximum combined size in MB for files copied during a Git sync. Set 0 to disable the environment cap |
ARCANE_MAX_IMAGE_UPLOAD_SIZE | Maximum size in MB for image archive uploads |
ARCANE_PROJECTS_DIRECTORIES | Additional directories scanned recursively for Compose projects |
ARCANE_PROJECTS_DIRECTORY | Configure where project files are stored |
ARCANE_SWARM_STACK_SOURCES_DIRECTORY | Configure where swarm stack source files are stored |
ARCANE_TEMPLATES_DIRECTORY | Configure where local compose template folders are discovered |
ARCANE_UNMANAGED_BACKUP_RETENTION_DAYS | Delete safety backups and backups of deleted volumes or schedules this many days after they stop being managed. Set 0 to keep them indefinitely. |
ARCANE_DEPLOY_WAIT_TIMEOUT | Timeout waiting for services to become healthy or complete during a deploy in seconds |
ARCANE_DOCKER_API_TIMEOUT | Timeout for Docker list operations in seconds |
ARCANE_DOCKER_IMAGE_PULL_TIMEOUT | Timeout for Docker image pulls in seconds |
ARCANE_GIT_OPERATION_TIMEOUT | Timeout for Git clone/fetch operations in seconds |
ARCANE_HTTP_CLIENT_TIMEOUT | Default timeout for HTTP requests in seconds |
ARCANE_PROXY_REQUEST_TIMEOUT | Timeout for proxied requests in seconds |
ARCANE_REGISTRY_TAG_TIMEOUT | Timeout for listing every tag in a repository during version update checks in seconds |
ARCANE_REGISTRY_TIMEOUT | Timeout for container registry operations in seconds |
ARCANE_TRIVY_SCAN_TIMEOUT | Timeout for Trivy image scans in seconds |
ARCANE_AGENT_TUNNEL_STREAM_WINDOW_MB | Receive window per multiplexed stream on this environment's agent tunnel in MiB. The agent sends it to the manager when the tunnel connects and both sides use it. Larger values speed up transfers on high-latency links but each side may hold up to this much data in RAM for every active transfer. Applies on the next tunnel reconnect. Open tunnels keep their window |
ARCANE_HTTP2_RECEIVE_WINDOW_MB | HTTP/2 receive buffer per stream in MiB. Only applies to the Arcane manager's server. Values set on agent environments have no effect. Larger values speed up agent transfers on high-latency links. Any HTTP/2 client can make the manager buffer up to 2x this value per connection. Requires restarting the manager |
ARCANE_AVATAR_MAX_UPLOAD_SIZE_MB | Maximum size in MB for profile picture uploads |
ARCANE_ENABLE_GRAVATAR | Enable Gravatar profile pictures for users |
Agent variables
Section titled “Agent variables”An Arcane Agent needs these three variables. The install command from Add an agent fills them in.
| Variable | Details |
|---|---|
ARCANE_AGENT |
|
ARCANE_MANAGER_API_URL | URL of your Arcane Manager. |
ARCANE_AGENT_TOKEN | An enrollment token ( |
- Missing
ARCANE_MANAGER_API_URLorARCANE_AGENT_TOKENstops the agent at startup. AGENT_MODE=trueorARCANE_AGENT_MODE=truewithoutARCANE_AGENT=truestops startup.- Optional:
ARCANE_AGENT_TRANSPORT. See Remote Agents. - Optional:
ARCANE_AGENT_MTLS_*. See Agent mTLS.
Container runtime user
Section titled “Container runtime user”Set PUID and PGID to make mounted files belong to a specific host user and group.
Without them, Arcane drops to its built-in non-root user (65532:65532) inside a container. Outside a container, it keeps the user it started as.
Arcane treats itself as containerized when any of these is true:
ARCANE_IN_CONTAINER=true(the official images set this).- The
containervariable is non-empty. /.dockerenvor/run/.containerenvexists.
If DOCKER_HOST points at a custom Unix socket, Arcane adds the runtime user to that socket’s group.
Timezone and scheduled jobs
Section titled “Timezone and scheduled jobs”Set TZ to an IANA timezone name so recurring jobs run on your local time:
TZ=America/New_YorkThis covers image update checks, auto-updates, vulnerability scans, scheduled pruning, GitOps sync, and environment health checks. Without TZ, Arcane uses the container’s local time (UTC on the official images). Schedule dialogs show the timezone in use.
Set job intervals and cron expressions in the Settings UI or with settings overrides.
Default admin account
Section titled “Default admin account”On first start with an empty database, Arcane creates an admin named arcane with a random password, writes the password to /app/data/initial-admin-password, and asks for a new password at first sign-in. These variables change that. They are read only when the admin is created, so they never change an existing account.
| Variable | Default | Description |
|---|---|---|
ARCANE_DEFAULT_ADMIN_USERNAME |
arcane |
Username of the admin created on first start. |
ARCANE_DEFAULT_ADMIN_PASSWORD |
Random | Password of that admin. To read it from a file, set ARCANE_DEFAULT_ADMIN_PASSWORD_FILE instead. |
ARCANE_DEFAULT_ADMIN_DISABLED |
false |
Set to true to create no default admin. |
A password you set is not written to that file, and Arcane does not ask you to change it. It must meet the password policy; otherwise Arcane logs a warning and creates no admin until you fix the value and restart.
services: arcane: environment: - ARCANE_DEFAULT_ADMIN_USERNAME=ops-admin - ARCANE_DEFAULT_ADMIN_PASSWORD_FILE=/run/secrets/arcane_admin_password secrets: - arcane_admin_password
secrets: arcane_admin_password: file: ./secrets/arcane_admin_password.txtAdmin API key and observability
Section titled “Admin API key and observability”Set ARCANE_ADMIN_STATIC_API_KEY when automation needs a known API key from first start. At startup, Arcane creates or updates a protected admin API key with this value. The key belongs to the default admin. See the API Reference for examples.
Set the standard OTEL_* exporter variables to export metrics, traces, and logs. See OpenTelemetry.