Modify README, add to .gitignore.

This commit is contained in:
Hyperling 2022-08-06 08:18:06 -05:00
parent 86dad8c717
commit f93ce5a51e
2 changed files with 15 additions and 2 deletions

3
.gitignore vendored
View File

@ -1,2 +1,5 @@
# Ignore everything in Volumes, it is large and private data. # Ignore everything in Volumes, it is large and private data.
Volumes/* Volumes/*
# Ignore backed up config files.
*.yml.*

View File

@ -5,11 +5,21 @@ Was unable to find a good tutorial on using and managing containers so this is w
## How To Use ## How To Use
`git clone https://github.com/hyperling/docker /opt/Docker` `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. 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. 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. 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. 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/. 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.