Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tuurlijk/docker-local

Docker compose development environment
https://github.com/tuurlijk/docker-local

compose development docker local

Last synced: about 1 month ago
JSON representation

Docker compose development environment

Host: GitHub
URL: https://github.com/tuurlijk/docker-local
Owner: Tuurlijk
Created: 2019-03-31T06:24:00.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2023-12-06T08:23:26.000Z (about 1 year ago)
Last Synced: 2024-12-23T02:43:10.102Z (about 1 month ago)
Topics: compose, development, docker, local
Language: Shell
Size: 201 KB
Stars: 6
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: Readme.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

# docker compose setup for local development
This development environment uses as much default docker containers as possible.

* Default [nginx](https://hub.docker.com/r/fholzer/nginx-brotli) container - Nginx container with brotli support
* Default [mariadb](https://hub.docker.com/_/mariadb) container - serves the database
* Default [mailhog](https://hub.docker.com/r/mailhog/mailhog) container - catches all outgoing mail and displays it
* Default [docker-hoster](https://hub.docker.com/r/dvdarias/docker-hoster) container - makes the containers accessible by name
* Default [busybox](https://hub.docker.com/_/busybox) container - used for initialization
* Default [blackfire](https://hub.docker.com/r/blackfire/blackfire) container - used for profiling your site
* Default [ngrok](https://hub.docker.com/r/wernight/ngrok) container - used to share your local site with the world
* Default [dozzle](https://hub.docker.com/r/amir20/dozzle) container - used to inspect the logs in browser
* Slightly changed php container (added graphicsmagick, rsync and some php modules) - serves up php

Disclaimer: This was developed and tested on Linux. OSX has some limitations when it comes to easy access to docker hosts by hostname: [Docker Known limitations, use cases, and workarounds](https://docs.docker.com/docker-for-mac/networking/#known-limitations-use-cases-and-workarounds)

Pull requests are welcome ;-)

## Installation

```bash
mkdir project && cd project
git clone https://github.com/Tuurlijk/docker-local.git .docker
ln -s .docker/.env .env
```

### Make sure the containers can read and write your files
The different container processes run under different user ids. The containers must be able to read, and some must be able to write host files mounted as volumes inside the container. The default user and group id's the processes are set to run as are 1000 and 1000. If your uid and gid are not `1000`, set the `UID` and `GID` env vars in the `.env` file.

You can see your uid and gid by doing `id -u` and `id -g`.

### Set the project name in .env

Set up a project name in the `.env` file.
```bash
# Project name
COMPOSE_PROJECT_NAME=my_great_project
```

### Start the environment

Adjust other env vars if needed. When you are done, you can start the environment with:
```bash
docker-compose -f .docker/docker-compose.yml up
```

For ease of use you can create an alias:
```bash
alias dc="docker-compose -f .docker/docker-compose.yml"
```

### The service user

The services in the `web` and `php*` containers run under user **docker**. If you want to log in to the php container as that user you can do:

```bash
dev exec -u docker php /bin/bash

# If you are logging is as your host user, you can do:
dev exec -u $UID php /bin/bash

# Or even leave out the user part all together:
dev exec php /bin/bash
```

You can create an alias, so you don't have to type the user out all the time.
```bash
alias de="dev -u $UID exec"
```

### Aliases

Bonus aliases:
```bash
# Colorful messages
e_header() { echo -e "\n\033[1m$@\033[0m"; }
e_success() { echo -e " \033[1;32m✔\033[0m $@"; }
e_error() { echo -e " \033[1;31m✖\033[0m $@"; }

# Docker
alias d=docker
alias dp="docker ps"
alias dc="docker-compose -f .docker/docker-compose.yml"
alias dev="docker-compose -f .docker/docker-compose.yml"
alias down='f(){ dev rm -fsv $@; unset -f f; }; f'
alias up='f(){ dev up -d $@ && dev logs -f before_script after_script; unset -f f; }; f'
alias on=up
alias off=down
alias re='f(){ dev rm -fsv $@ && dev build $@ && dev up -d $@ && dev logs -f before_script after_script; unset -f f; }; f'
alias offon=re
alias ds="dev exec php bash -l"
alias de="dev exec"
alias cf='e_header "Running typo3cms cache:flush"; ds -c "./public/bin/typo3cms cache:flush"; e_success Done'
alias ct='e_header "Clearing ./public/typo3temp/*"; ds -c "echo removing \`find ./public/typo3temp/ -type f | wc -l\` files; rm -rf ./public/typo3temp/*"; e_success Done'
```

## SSL support
To generate the certificates and make the system trust them, we use [the fantastic *mkcert* tool](https://github.com/FiloSottile/mkcert).

The provided certificate has wildcards for:
* *.dev.local
* *.blackfire.local
* *.black.local
* *.fire.local
* *.bf.local
* *.xdebug.local
* *.debug.local
* *.xdbg.local
* *.mail.local
* *.logs.local

The certificate was generated from the `web/ssl` folder using:

```bash
mkcert -cert-file public.crt -key-file private.rsa "dev.local" "*.dev.local" "*.xdebug.local" "*.xdbg.local" "*.blackfire.local" "*.bf.local" "*.black.local" "*.fire.local" "*.debug.local" "*.mail.local" "*.mailhog.local" "*.logs.local"
```

## Configuration
Each container may use configuration files from the `.docker` folder.

The environment file `/.env` defines some important variables. Check yout platform documentation so you know what version of PHP and Mariadb you need. For TYPO3 you can find the requirements here: https://get.typo3.org/version

### COMPOSE_PROJECT_NAME
The project name is used in the domain names of the http containers:
* [prefix.dev.local](https://prefix.dev.local) - default PHP
* [prefix.xdebug.local](https://prefix.xdebug.local) / [prefix.debug.local](https://prefix.debug.local) / [prefix.xdbg.local](https://prefix.xdbg.local) - Xdebug enabled PHP
* [prefix.blackfire.local](https://prefix.blackfire.local) / [prefix.bf.local](https://prefix.bf.local) / [prefix.fire.local](https://prefix.fire.local) / [prefix.black.local](https://prefix.black.local) - Blackfire enabled PHP
* [prefix.mail.local](https://prefix.mail.local) - Mailhog
* [prefix.logs.local](https://prefix.logs.local) - Dozzle

All environments are started within their own subnet. They can reach each other by the *service name* or *container_name* specified in `.docker/docker-compose.yml`. So the `php` machine can reference the `redis` machine by using hostname **redis** or **container_name: ${COMPOSE_PROJECT_NAME}_web**. So if your project name is **babel** the `php` machine can reach the `redis` machine by using **babel_redis** as hostname.

### PHP versions
There are different PHP versions available. The default is PHP 7.4

#### PHP_VERSION
One of: `5.6`, `7.1`, `7.2`, `7.3`, `7.4`, `8.0`, `8.1`

### Database version
[One of the mariadb versions](https://hub.docker.com/_/mariadb). The default is 10.2

#### DATABASE_VERSION
One of teh tags on https://hub.docker.com/_/mariadb

### mysql database credentials

#### MYSQL_DATABASE
The name of the database that mysql will import the dump into

#### MYSQL_USER
The name of the mysql user

#### MYSQL_PASSWORD
The password of the mysql user

#### MYSQL_ROOT_PASSWORD
The password of the mysql root user

### Ngrok
Expose a local web server to the internet. Share your local development environment with others

#### NGROK_AUTH
Your token from https://dashboard.ngrok.com/auth