dockge/README.md

Dockge

A fancy, easy-to-use and reactive self-hosted docker compose.yaml stack-oriented manager.

View Video: https://youtu.be/AWAlOQeNpgU?t=48

⭐ Features

• Manage compose.yaml
  • Create/Edit/Start/Stop/Restart/Delete
  • Update Docker Images
• Interactive Editor for compose.yaml
• Interactive Web Terminal
• Reactive
  • Everything is just responsive. Progress (Pull/Up/Down) and terminal output are in real-time
• Easy-to-use & fancy UI
  • If you love Uptime Kuma's UI/UX, you will love this one too
• Convert docker run ... commands into compose.yaml
• File based structure
  • Dockge won't kidnap your compose files, they are stored on your drive as usual. You can interact with them using normal docker compose commands

🔧 How to Install

Requirements:

• Docker CE 20+ is recommended / Podman
• (Docker only) Docker Compose Plugin
• (Podman only) podman-docker (Debian: apt install podman-docker)
• OS:
  • As long as you can run Docker CE / Podman, it should be fine, but:
  • Debian/Raspbian Buster or lower is not supported, please upgrade to Bullseye or higher
• Arch: armv7, arm64, amd64 (a.k.a x86_64)

Basic

• Default Stacks Directory: /opt/stacks
• Default Port: 5001

# Create directories that store your stacks and stores Dockge's stack
mkdir -p /opt/stacks /opt/dockge
cd /opt/dockge

# Download the compose.yaml
curl https://raw.githubusercontent.com/louislam/dockge/master/compose.yaml --output compose.yaml

# Start the server
docker compose up -d

# If you are using docker-compose V1 or Podman
# docker-compose up -d

Dockge is now running on http://localhost:5001

Advanced

If you want to store your stacks in another directory, you can generate your compose.yaml file by using the following URL with custom query strings.

# Download your compose.yaml
curl "https://dockge.kuma.pet/compose.yaml?port=5001&stacksPath=/opt/stacks" --output compose.yaml

• port=5001
• stacksPath=/opt/stacks

Interactive compose.yaml generator is available on: https://dockge.kuma.pet

You can also view compose.yaml here: https://github.com/louislam/dockge/blob/master/compose.yaml

How to Update

cd /opt/dockge
docker compose pull && docker compose up -d

Screenshots

Motivations

• I have been using Portainer for some time, but for the stack management, I am sometimes not satisfied with it. For example, sometimes when I try to deploy a stack, the loading icon keeps spinning for a few minutes without progress. And sometimes error messages are not clear.
• Try to develop with ES Module + TypeScript (Originally, I planned to use Deno or Bun.js, but they don't have support for arm64, so I stepped back to Node.js)

If you love this project, please consider giving it a ⭐.

🗣️

Bug Report

https://github.com/louislam/dockge/issues

Ask for Help / Discussions

https://github.com/louislam/dockge/discussions

Translation

If you want to translate Dockge into your language, please read Translation Guide

FAQ

"Dockge"?

"Dockge" is a coinage word which is created by myself. I hope it sounds like Dodge.

The naming idea came from Twitch emotes like sadge, bedge or wokege. They all end in -ge.

Can I manage a single container without compose.yaml?

The main objective of Dockge is to try to use the docker compose.yaml for everything. If you want to manage a single container, you can just use Portainer or Docker CLI.

Can I manage existing stacks?

Yes, you can. However, you need to move your compose file into the stacks directory:

1. Stop your stack
2. Move your compose file into /opt/stacks/<stackName>/compose.yaml
3. In Dockge, click the " Scan Stacks Folder" button in the top-right corner's dropdown menu
4. Now you should see your stack in the list

More Ideas?

• Stats
• File manager
• App store for yaml templates
• Get app icons
• Switch Docker context
• Support Dockerfile and build
• Support Docker swarm

Others

Dockge is built on top of Compose V2. compose.yaml also known as docker-compose.yml.