Skip to content

Docker Widget

Lists all Docker containers on the host with their name, image, status, and uptime. Containers can be started, stopped, restarted, and unpaused directly from the dashboard.

Requirements

  • Docker must be running on the host
  • The server process needs access to the Docker socket

Docker socket access

Docker Compose (recommended):

yaml
volumes:
  - /var/run/docker.sock:/var/run/docker.sock

Note: Container controls (start/stop/restart/unpause) require write access to the socket. If you mount the socket read-only (:ro), the widget will display container status but controls will fail.

Manual / development:

Ensure the user running the server is in the docker group:

bash
sudo usermod -aG docker $USER

Container controls

Each container card shows action buttons based on its current state:

Container stateAvailable actions
RunningStop, Restart
PausedUnpause, Stop
Exited / Created / DeadStart, Restart

Buttons are disabled while an action is in progress. After a successful action the widget refreshes automatically.

Configuration

No API key required. The Docker socket path defaults to /var/run/docker.sock and can be overridden with the DOCKER_SOCKET environment variable.

KeyTypeDefaultDescription
hideHeaderbooleanfalseHide the widget title bar
defaultCollapsedbooleanfalseStart collapsed

Troubleshooting

No containers shown

  • Check the Docker socket is mounted and the path is correct
  • Verify the server has permission: ls -la /var/run/docker.sock
  • Look for connection errors in the server logs

Controls not working

  • Ensure the socket is mounted without :ro
  • Check the server logs for Docker API errors

Personal Homepage Dashboard