Eliminate the word should for will and need.
This commit is contained in:
15
README.md
15
README.md
@@ -1,18 +1,22 @@
|
||||
# My Docker Setup
|
||||
|
||||
Scripting my way into the Docker world. I was unable to find a good tutorial on
|
||||
using and managing containers so this is what made sense to me based on practice
|
||||
with `docker-compose`. Also has some usages of `Dockerfile` to build some apps.
|
||||
|
||||
## Disclaimer
|
||||
|
||||
Currently the project only focuses on `apt` based operating systems, and is
|
||||
being used in production by the latest Debian release.
|
||||
|
||||
## Other README's
|
||||
|
||||
Each `Config/PROJECT/` folder also contains its own README file with specific
|
||||
information to running that sub project. This file's job is to cover the general
|
||||
Docker installation. The others then contain details on their program setup.
|
||||
|
||||
## How To Use
|
||||
|
||||
Most of these commands benefit from being root. Something like a `sudo su -` if
|
||||
you feel comfortable with it. Otherwise be aware that using sudo may cause file
|
||||
permission conflicts when interacting with the configuration files and folders.
|
||||
@@ -70,17 +74,20 @@ Cross your fingers and hope to succeed!
|
||||
## Folders
|
||||
|
||||
### Config
|
||||
Compose projects are set up here. Each folder should have a `docker-compose.yml`
|
||||
file set up unless it is for utility such as DynamicDNS, which is used in CRON.
|
||||
|
||||
Compose projects are set up here. Each folder needs `docker-compose.yml` and `.env`
|
||||
files set up unless it is for utility such as DynamicDNS, which is used in CRON.
|
||||
|
||||
### 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
|
||||
will be easier to remember than `/var/lib/docker/volumes` when it comes time
|
||||
for migrations. Hopefully all that'd be needed is to rsync `/opt/Docker` and run
|
||||
`install.sh` and then `start.sh` on the new server. You are welcome to use a
|
||||
directory other than `/opt/Docker`, this project is location agnostic.
|
||||
|
||||
### bin
|
||||
|
||||
Scripts to help make life easier. Some are pretty basic, but others do nice
|
||||
things like handle the container IDs.
|
||||
- `create.sh`
|
||||
@@ -94,4 +101,4 @@ things like handle the container IDs.
|
||||
- Start, stop, update, rebuild, etc all compose containers.
|
||||
- `uninstall.sh`
|
||||
- If something goes wrong and you'd like to start from scratch without
|
||||
provisioning a new server then this should do the job.
|
||||
provisioning a new server then this will do the job.
|
||||
|
||||
Reference in New Issue
Block a user