env-docker/README.md

# 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.

Install the project dependencies.
```
apt install git bash
```

Clone the project. You may choose anywhere, but `/opt/Docker` is recommended.
```
git clone https://git.hyperling.com/me/env-docker /opt/Docker
```

Load the environment variables from wherever you chose to put the project.
```
source /opt/Docker/source.env
```

Install docker to the system using the official repos.
```
install.sh
```

Copy default configuration for usage by management script.
For example, to enable Nextcloud:
```
cd $DOCKER_HOME/Config/Nextcloud
cp docker-compose.standard.yml docker-compose.yml
cp env.standard .env
```

Be sure to edit the environment file to update any passwords or preferences.
```
vi $DOCKER_HOME/Config/Nextcloud/.env
```

If you have a new configuration to add, create an area for the new product.
```
create.sh PROJECT_NAME
```

Edit the project's details.
```
vi $DOCKER_HOME/Config/PROJECT_NAME/docker-compose.yml
```

Start all of the configured docker projects.
```
manage.sh -u
```

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.

### 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'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`
    - Create a new folder with the needed yml file.
- `get_logs.sh`
    - Create log files rather than using the `docker log` command or
    searching in /var/whatever.
- `install.sh`
    - Install dependencies on a new server with apt.
- `manage.sh`
    - 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.