From f93ce5a51e8caf363145a918a124f79b58045ca5 Mon Sep 17 00:00:00 2001 From: Hyperling Date: Sat, 6 Aug 2022 08:18:06 -0500 Subject: [PATCH] Modify README, add to .gitignore. --- .gitignore | 3 +++ README.md | 14 ++++++++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 8ae55c0..ce3ecfe 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,5 @@ # Ignore everything in Volumes, it is large and private data. Volumes/* + +# Ignore backed up config files. +*.yml.* diff --git a/README.md b/README.md index 90fb0cb..16f8334 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,21 @@ Was unable to find a good tutorial on using and managing containers so this is w ## How To Use `git clone https://github.com/hyperling/docker /opt/Docker` -## Config +## Folders + +### Config Compose projects are set up here. Each folder should have a docker-compose.yml file set up. -## Volumes +### Volumes The data of the files go here if the Config is done correctly. I think this should be easier to remember than /var/lib/docker/volumes when it comes time for migrations. Hopefully all that's needed is to rsync /opt/Docker and run start.sh on the new server. That's my opinion though, if someone else uses this then they can use /var/. + +### bin +Scripts to help make life easier. Some are pretty basic, but others do nice things like handle the container IDs. +* install.sh : Install dependencies on an server with apt. +* create.sh : Create a new folder with the needed yml file. +* start.sh : Start all compose containers. +* stop.sh : Stop all compose containers. +* get_logs.sh : Create log files rather than using `docker log` command or searching for /var/whatever.