docker-composer/README.md
2022-12-14 10:48:51 -06:00

1.2 KiB

Docker Composer

This is a simple program to manage docker containers. It works similarly to Umbrel, but it is not limited to Umbrel. It can be used to manage any docker container.

How to use

  • Note: All scrips must be run in the same directory as the .config file.
  • If you want to re-compose your containers on boot, you can run composer.py on boot
  • If you want to re-compose your containers on demand, you can run re_compose.py manually
  • If you just want to do basic management, like stopping, starting, removing docker containers, etc, then use basic-management.py. It's essentially an interactive wrapper for the basics of docker.

Installation

I'll get to this later once this program is actually usable.

Usage

.config parameters:

  • compose-path: The path to the folder containing the folders for each docker container - the folder for each container includes a docker-compose.yml file.
  • exclude-containers: A list of containers to exclude from being managed by the program. This will stop the program from doing anything to those containers.

Dev Notes

  • Maybe later expand this to an interactive docker manager.

Status

  • composer.py and re_compose are finished
  • Haven't started on basic_management.py