Skip to content

ianFar96/dcompose-workbench

Repository files navigation

DCompose Workbench

Desktop application to manage your docker-compose.yml files easily
Report Bug · Request Feature

DCompose Workbench screenshot

DCompose Workbench is a desktop app made to manage your docker-compose.yml files in a visual and organized way.

Getting Started

Installation

To install DCompose Workbench you just need to head to the Releases page and download the most recent one.

Note that the app is not signed for macOS, so a warning of some sort may appear when installing or opening. To bypass this you can check out this guide

Usage

To start using the app you need to create a Scene. A Scene is nothing more than a folder with a docker-compose.yml file in it, located at the app's config folder ${HOME}/.dcompose-workbench. If you wish, you can edit the whole docker-compose.yml file by using the "Open on VS Code" action in the top right corner menu. This makes it easier if you want to copy/paste already made docker compose files into the app.

Features

  • Create/edit/delete service
  • Start/stop all or a single service
  • Import/detach another scene (leveraging the include key)
  • Follow service logs
  • Follow service status (hover on the icon above the service)
  • Import/copy assets so the service can use them as volumes of env
  • Create/edit/delete dependencies between services (leveraging the depends_on key)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgments

MUI Design System
React Flow
Decomposition icons created by Umeicon - Flaticon