Skip to content
github-actions[bot] edited this page Oct 4, 2026 · 10 revisions

Cockpit Compose — User Guide

Cockpit Compose is a web-based UI for managing Docker Compose stacks, built as a plugin for Cockpit. It runs inside your browser and communicates directly with Docker or Podman on your server — no extra daemons or agents required.

What you can do

  • See everything at a glance — every stack with live status, CPU and memory; search, filter, and four layouts.
  • Control stacks — Up, Down, Restart, Pause, Pull, Scale, Kill, or start/stop a single service. Select several stacks to act on all of them, and send long actions to the background.
  • Create and import — from scratch or a Git URL, or adopt stacks already on disk.
  • Edit — compose files (including override files) with validation, diff view and snapshots, plus .env files.
  • Inspect — live logs, events, processes, containers, images, volumes and networks.
  • Get inside — open a shell, run one-off commands or Compose jobs, with suggestions from your history.
  • Clean up and protect — prune per stack or host-wide, back up and restore stacks.
  • Pick your runtime — Docker or Podman, rootless or rootful; switch when more than one is available.

Pages

Page What it covers
Stacks Dashboard The main screen — stack list, status indicators, stats, and action buttons
Managing Stacks Up, Start, Stop, Down, Restart, Pause / Unpause, Kill
Bulk Actions Select multiple stacks and run one action across all of them
Background Tasks Send long-running actions to the background and track them in a floating panel
Viewing Logs Streaming logs with service filter and search
Editing Configuration YAML editor, multi-file tabs, diff view, snapshots, env file editor
Stack Info Containers, images, volumes, and networks
Pulling Images Pull latest images with a warning about breaking changes
Events Live Docker event stream
Process Viewer Running processes inside containers (docker compose top)
Shell Access Interactive terminal inside a service container
Running Commands Run one-off commands with docker compose run
Prune Resources Remove unused images, containers, volumes, and networks
Scaling Services Adjust replica counts for individual services
Creating Stacks Create a new stack from Git, a template, or manually
Importing Stacks Scan a directory to find and manage offline stacks
Backup and Restore Archive a stack to a .bak.tar.gz file and restore it
Podman Compatibility Podman support, and switching between rootless and rootful sockets
Troubleshooting Fixes for common installation and runtime problems

Interface conventions

Status colors are used consistently throughout the UI:

Color Meaning
Green Running / healthy
Orange Partially running (some services stopped)
Grey Stopped
Blue Paused
Red Error

Confirmation dialogs appear before any destructive action (Down, Kill, Prune, Delete). Read them carefully — some actions cannot be undone.

Buttons are disabled while an operation is in progress. A spinner appears next to the stack row or inside the modal to indicate work is happening.

Getting help

  • Click Help in the footer to open this wiki.
  • Check Troubleshooting for common installation and runtime problems.
  • Click Feedback / Report bug in the footer to open a GitHub issue.

Clone this wiki locally