On this page
Containers
Manage Docker containers from Arcane.
To manage Compose services as a group, use Projects instead.
Create a container
Section titled “Create a container”- Open Containers and click Create Container.
- Enter a name and an image. Ports, volumes, environment variables, restart policy, and other fields are optional.
- Click Create.
Browse containers
Section titled “Browse containers”Open Containers in the sidebar. The table shows name, ID, image, and status.
- Long port lists collapse behind a
+Nexpander. - To show only published host mappings, hide exposed-only ports in the view options menu.
- To select a range, select a row checkbox, then Shift-select another. This works on the current page.
Filter by Docker label
Section titled “Filter by Docker label”In the Labels filter, enter a key such as com.example.team (matches any value), or a key and value such as com.example.team=media.
To keep a container out of the default list and dashboard counts, add the com.getarcaneapp.arcane.hidden=true label, or set x-arcane.hidden in Compose. See Hide containers for examples, project-wide defaults, and unhiding.
Start, stop, restart, pause, kill
Section titled “Start, stop, restart, pause, kill”| Action | What it does |
|---|---|
| Start / Stop / Restart | Changes the running state. |
| Pause / Unpause | Suspends and resumes all processes in the container. Needs containers:pause. |
| Kill | Sends a signal to the container’s main process. Needs containers:kill. |
| Redeploy | Pulls the latest image and recreates the container in place, with the same name, mounts, labels, networks, and restart policy. |
On Podman, Quadlet containers show a Quadlet badge. Start, stop, and restart go to their systemd unit. Arcane won’t edit, redeploy, or remove them. See Quadlets.
Edit a container
Section titled “Edit a container”- Open a container’s detail page or row menu and choose Edit.
- Change the image, ports, mounts, variables, restart policy, networks, resource limits, or Linux capabilities. Network options include static IPv4 addresses and aliases.
- Apply and confirm. Arcane recreates the container, so it gets a new container ID.
- Editing needs
containers:update. Changing network connections also needsnetworks:connect/networks:disconnect. - Existing mount options are kept.
- The new image is pulled only if it’s missing locally.
- If recreation fails, Arcane restores the original. Auto-remove containers can’t be restored.
Convert a container to a Compose project
Section titled “Convert a container to a Compose project”This feature is experimental.
- Click the version number at the bottom of the sidebar and switch on Experimental Features. This needs
settings:update. - On a standalone container’s detail page or row menu, or in bulk, choose Convert to Compose. This needs
projects:create. - On the new-project page, check the generated bind mounts, networks, and environment values. Edit as needed.
- Click Create Project.
The original containers keep running. Stop them before you deploy to avoid name and port conflicts.
To delete them instead, select Remove original container(s) after creation. This needs containers:delete. They’re deleted when the project is created, before deployment, and it can’t be undone.
Commit a container to an image
Section titled “Commit a container to an image”- On a container’s detail page, click Commit. This needs
images:commit. - Optional: set repository and tag, comment, author, and whether Docker skips its default pause.
- Confirm. The image appears on Images.
Inspect a container
Section titled “Inspect a container”Click a container’s name or Inspect. The detail view has tabs for configuration, network settings, mounts, and logs.
- Overview volume and network counts open their tabs.
- Network details show assigned IPv4 and IPv6 addresses.
- Containers in an Arcane-managed Compose project get a Compose tab. It shows the root Compose file, or the included file when the service comes from a Compose
include. It’s read-only for Git-synced projects. - Project containers link to their project.
- Sensitive environment values are masked on the Configuration and Inspect tabs. Show reveals them all; on Configuration, Reveal value shows one. A variable is sensitive when a
_-separated part of its name is a word such asPASSWORD,SECRET,TOKEN,KEY, orAUTH, or its value is a URL with credentials (contains://and@). Names ending in_FILE,_PATH, or_DIRare never masked.
Updates
Section titled “Updates”The Overview tab’s Auto Update toggle turns automatic installation on or off. Checks continue either way. For labels, and for stopping checks too, see Per-container labels.
When a newer image exists, the header shows an Update available badge and an Update action. Updating needs containers:autoupdate.
Restart unhealthy containers automatically
Section titled “Restart unhealthy containers automatically”Auto Heal restarts running containers whose Docker healthcheck reports unhealthy. Containers without a healthcheck are never touched.
- Open Settings → Automations and pick the agent.
- Under Monitoring, turn on Auto-Heal. It’s off by default.
- Optional: change its schedule. The default checks every 5 minutes (
*/5 * * * *).
| Setting | Default | What it does |
|---|---|---|
| Max Restarts | 5 | Restarts allowed per container within the restart window. After that, Arcane skips the container. |
| Restart Window (minutes) | 30 | How far back restarts are counted. |
| Excluded Containers | None | Containers Auto Heal never restarts. |
Both numbers must be at least 1. Auto Heal also skips Arcane’s own container, Arcane’s helper containers, and Podman Quadlet containers, whose systemd Restart= policy handles recovery.
Each restart is logged as a container restart event and sends an Auto-Heal Restart notification.
Open a shell
Section titled “Open a shell”- Open a running container’s detail view.
- Open the Shell tab. This needs
containers:exec. - Pick
sh,bash,ash,zsh, or enter a custom path.
Your browser remembers the choice per Compose service (or container name), so it survives recreation. Without a saved choice, Arcane uses the agent’s Default Shell (Settings → Docker), which is /bin/sh by default.
View logs
Section titled “View logs”Open the container’s Logs tab.
- Search filters lines. The line-count menu picks how far back to load, from 50 lines to All logs.
- JSON and logfmt logs render as structured rows. Multiline messages, such as stack traces, stay together.
- Standard error lines carry a marker.
- Small CPU and memory monitors show alongside.
Open Display to toggle Auto-scroll, Timestamps, Raw output (original line text instead of parsed rows), and Auto-start (stream when the tab opens). Project logs also offer Stream labels, which show the service name on each line.
Download logs
Section titled “Download logs”Click the download icon. You get a plain-text .log file with timestamps and all stdout and stderr Docker still keeps.
- The download ignores the viewer’s filters and line limit.
- Logs already removed by Docker’s log rotation aren’t included.
Remove a container
Section titled “Remove a container”- Click the trash icon on the container row.
- For a running container, check Force, or stop it first.
- Confirm.