Effortlessly Manage Docker Compose Projects with Dockge

Dockge is a refined and easy-to-use container management tool designed specifically for Docker Compose projects. This open-source software not only converts Docker commands into docker-compose.yaml files but also automatically generates compose.yaml configuration files based on web forms, significantly improving the efficiency and convenience for developers and Linux operations personnel.

Environment Requirements

• Docker version >= 20 or use Podman
• Supported operating systems include: Ubuntu/Debian/Raspbian/CentOS/Fedora/ArchLinux
• Supported architectures include: armv7, arm64, amd64

Installing Dockge

Before installing Dockge, ensure your operating system and Docker version meet the installation requirements. Then, we use Docker Compose for installation. The content of docker-compose.yaml is as follows:

version: "3.8"
services:
  dockge:
    image: louislam/dockge:1
    restart: unless-stopped
    ports:
      - 5001:5001
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./data:/app/data
      - /opt/stacks:/opt/stacks
    environment:
      - DOCKGE_STACKS_DIR=/opt/stacks

• ./data: Dockge data storage directory; an absolute path is recommended.

Note the /opt/stacks directory. If your container docker-compose.yaml file structure is as follows:

/opt/stacks/
├── app1/
│   └── docker-compose.yaml
├── app2/
│   └── docker-compose.yaml
├── app3/
│   └── docker-compose.yaml

Dockge will scan all docker-compose.yaml files under /opt/stacks/ and display the app1, app2, and app3 containers in the web interface.

Using Dockge

After installing Dockge, access it via http://IP:5001. The first time you access it, you will be prompted to set up an account and password.

Once inside the Dockge backend, you will see a clear and reasonable layout. The left side lists containers, the middle offers container operation options, and the right side displays the content of the docker-compose.yaml file.

Dockge can also convert Docker commands into Compose yaml files.

Additionally, if you have deployed Dockge on multiple servers, you can configure a proxy on one Dockge service to centrally manage Dockge services from a single location. However, after enabling the proxy, containers from all servers will be displayed on the left side of the interface, which may make it difficult to distinguish them when the number of containers is large.

Important Considerations

After using Dockge for some time, xiaoz found that while the tool brings convenience, there are potential risks that could lead to data loss if not handled carefully. Here are some important considerations:

Avoid Using Relative Paths

When using Dockge, it is recommended to use absolute paths for mounting data directories rather than relative paths. Relative paths may lead to uncertainty about the actual mount location, which could result in data loss. Always using absolute paths is the safer approach!

Be Cautious When Deleting Containers via Dockge

When you delete a container via Dockge, it will delete all data under the /opt/stacks/app1 directory, including .yaml and .env files. Therefore, if you wish to retain these files, avoid deleting containers through Dockge and try not to mount data in the /opt/stacks directory. In this regard, Dockge has room for improvement and should consider providing relevant prompts or preventing the automatic deletion of these important data.

Conclusion

In summary, Dockge greatly simplifies the management of Docker Compose projects and provides an effective way to operate and manage containers. Although its functionality is powerful, data security must be noted during use. It is hoped that future versions will be further optimized to better meet the technical needs of the community and enhance user experience.

Dockge project address: https://github.com/louislam/dockge