dockge README

The project's README from github.com/louislam/dockge. As one markdown file: README.md.

Dockge

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

GitHub Repo stars Docker Pulls Docker Image Version (latest semver) GitHub last commit (branch)

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

⭐ Features

🔧 How to Install

Requirements:

Basic

# 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

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 and paste your compose from the following:

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

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

Screenshots

Motivations

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

🗣️ Community and Contribution

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

Create a Pull Request

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

"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

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

dockge (louislam/dockge)

Searching Database…

24.6K ·GitHub
Dockge
What is this?Dockge is a self-hosted, reactive web manager for Docker Compose stacks: from a browser you create, edit, start, stop, restart and delete compose.yaml stacks, update images and watch progress in real time.
Is this a desktop app, or does it live on my server?It's a self-hosted web app: Dockge runs on your Linux server and you manage everything from a browser — by default the UI is on port 5001.
How do I get it running?Deploy the ready-made docker compose file from the README: the web UI is served on port 5001 and stacks live in /opt/stacks by default. You need Docker 20+ or Podman (with podman-docker if you're on Podman).
Can I run it on Windows or a Mac?Linux only for now: Ubuntu, Debian/Raspbian Bullseye+, CentOS, Fedora and ArchLinux. Windows isn't supported yet and macOS isn't listed. Builds exist for armv7, arm64 and amd64, so a Raspberry Pi works.
What can I actually do from the web UI?Create, edit, start, stop, restart and delete stacks, update Docker images, edit compose.yaml in an interactive editor, and work in an interactive web terminal. Since 1.4.0, agents let you manage stacks on different Docker hosts from one interface, and docker run commands can be converted into compose.yaml.
Why did the author build this when Portainer exists?He used Portainer but wasn't satisfied with stack management: deploys sometimes kept spinning for minutes with no progress and error messages were unclear. It was also a playground for ES Module + TypeScript development.
Where does the name 'Dockge' come from?It's a coinage the author hoped would sound like 'Dodge', inspired by Twitch emotes like sadge, bedge or wokege that all end in -ge. Many people read it as 'Dockage', which he finds acceptable too.
Can I manage a single container without a compose.yaml?No — Dockge tries to use docker compose for everything. For single containers it suggests Portainer or the plain Docker CLI instead.
What are similar projects?uptime-kuma, portainer, linux-dash, netboot.xyz, azerioid-stack-manager, labtether, k3s, dokku
Which topics is it in?socket-io, selfhosted, webapp, single-page-app, homelab, express, responsive, arm64, deployment, raspberry-pi, containers, vite
Creator
louislam
Size
1.2 MB
Stars
24.6K
Updated
CommitApr 19Release1.5.0Mar 30
Age
2y
Commits · 90 Days