Repository: louislam/dockge

Stars: 22883

README.md Copy Chapter

<div align="center" width="100%">
<img src="./frontend/public/icon.svg" width="128" alt="" />
</div>

Dockge

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

   

<img src="https://github.com/louislam/dockge/assets/1336778/26a583e1-ecb1-4a8d-aedf-76157d714ad7" width="900" alt="" />

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

⭐ Features Copy Chapter

- 🧑‍💼 Manage your compose.yaml files
- Create/Edit/Start/Stop/Restart/Delete
- Update Docker Images
- ⌨️ Interactive Editor for compose.yaml
- 🦦 Interactive Web Terminal
- 🕷️ (1.4.0 🆕) Multiple agents support - You can manage multiple stacks from different Docker hosts in one single interface
- 🏪 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

<img src="https://github.com/louislam/dockge/assets/1336778/cc071864-592e-4909-b73a-343a57494002" width=300 />

- 🚄 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


🔧 How to Install Copy Chapter

Requirements:
- Docker 20+ / Podman
- (Podman only) podman-docker (Debian: apt install podman-docker)
- OS:
- Major Linux distros that can run Docker/Podman such as:
- ✅ Ubuntu
- ✅ Debian (Bullseye or newer)
- ✅ Raspbian (Bullseye or newer)
- ✅ CentOS
- ✅ Fedora
- ✅ ArchLinux
- ❌ Debian/Raspbian Buster or lower is not supported
- ❌ Windows (Will be supported later)
- Arch: armv7, arm64, amd64 (a.k.a x86_64)

Basic Copy Section

- 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 Copy Section

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

Also, once compose is generated/downloaded, add the PUID and PGID section below to your compose environment: section to set stack ownership, otherwise default is root

# Both PUID and PGID must be set for it to do anything
      - PUID=1000 # Set the stack file/dir ownership to this user
      - PGID=1000 # Set the stack file/dir ownership to this group

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

-OR- Copy Section

If you want to store your stacks in another directory, you can change the DOCKGE_STACKS_DIR environment variable and volumes.

compose:

services:
  dockge:
    image: louislam/dockge:1
    restart: unless-stopped
    ports:
      # Host Port:Container Port
      - 5001:5001
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./data:/app/data
        
      # If you want to use private registries, you need to share the auth file with Dockge:
      # - /root/.docker/:/root/.docker
      # Stacks Directory
      # Your stacks directory in the host (The paths inside container must be the same as the host)
      # ⚠️ If you did it wrong, your data could end up be written into a wrong path.
      # ✔️ CORRECT EXAMPLE: - /my-stacks:/my-stacks (Both paths match)
      # ❌ WRONG EXAMPLE: - /docker:/my-stacks (Both paths do not match)
      - /opt/stacks:/opt/stacks
    environment:
      # Tell Dockge where your stacks directory is
      - DOCKGE_STACKS_DIR=/opt/stacks
      # Both PUID and PGID must be set for it to do anything
      - PUID=1000 # Set the stack file/dir ownership to this user
      - PGID=1000 # Set the stack file/dir ownership to this group

How to Update Copy Chapter

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

Screenshots Copy Chapter





Motivations Copy Chapter

- 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

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

🗣️ Community and Contribution Copy Chapter

Bug Report Copy Section

Ask for Help / Discussions Copy Section

Translation Copy Section

Create a Pull Request Copy Section

Be sure to read the guide, as we don't accept all types of pull requests and don't want to waste your time.

FAQ Copy Chapter

#### "Dockge"?

"Dockge" is a coinage word which is created by myself. I originally hoped it sounds like Dodge, but apparently many people called it Dockage, it is also acceptable.

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

#### Is Dockge a Portainer replacement?

Yes or no. Portainer provides a lot of Docker features. While Dockge is currently only focusing on docker-compose with a better user interface and better user experience.

If you want to manage your container with docker-compose only, the answer may be yes.

If you still need to manage something like docker networks, single containers, the answer may be no.

#### Can I install both Dockge and Portainer?

Yes, you can.

Others Copy Chapter

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