docker-composer/README.md

37 lines
1.6 KiB
Markdown
Raw Normal View History

2022-12-11 22:15:32 -06:00
# 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
2022-12-14 13:32:40 -06:00
- **Note:** All scrips must be run in the same directory as the `docker-composer.conf` file.
2022-12-13 19:45:38 -06:00
- If you want to re-compose your containers on boot, you can run `composer.py` on boot
2022-12-14 10:48:51 -06:00
- If you want to re-compose your containers on demand, you can run `re_compose.py` manually
2022-12-11 22:15:32 -06:00
- 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.
2022-12-14 13:32:40 -06:00
You can use `docker-data/` to test the program, or can put your own data there. `docker-composer.conf` is already set up to use that directory!
2022-12-11 22:15:32 -06:00
## Usage
2022-12-14 13:32:40 -06:00
`docker-composer.conf` parameters:
2022-12-11 22:15:32 -06:00
- `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.
2022-12-14 13:32:40 -06:00
Notes:
- The folders *must* have the same name as their respective docker containers
2022-12-14 13:46:06 -06:00
- Remember to run the script as a user that can access `docker `
2022-12-14 13:32:40 -06:00
2022-12-11 22:15:32 -06:00
## Dev Notes
- Maybe later expand this to an interactive docker manager.
2022-12-14 10:48:51 -06:00
## Status
- `composer.py` and `re_compose` are finished
2022-12-14 15:48:19 -06:00
- Haven't started on `basic_management.py`
This is a test