Merge branch 'master' into feature/minIO-to-mock-s3

.github/linters/.hadolint.yaml

@@ -1,3 +1,4 @@
+---
 ignored:
   - DL3022
   - DL3008

.github/linters/.markdown-lint.yml

@@ -1,3 +1,4 @@
+---
 # Hard wrap to 120, not 80
 MD013:
   line_length: 120
@@ -10,3 +11,6 @@ MD025: false
 
 # Allow no new lines between lists (Changelog)
 MD032: false
+
+# Allow base-urls (http) for links (Readme)
+MD034: false

README.md

@@ -16,40 +16,63 @@ language and other tools it may need, as the databases and other services are
 standardized in this project. Since most cloud providers provide managed versions
 of these services, you likely would not use a docker version of them in production.
 
-## Docker
+# Docker
 
-### Required: data source services
+## Data Source Services
 
 ```bash
 git clone [email protected]:sourcetoad/DevopsToolKit.git devop-tools
 ./devop-tools/docker/data-source-services/network-creation.sh
 cd ./devop-tools/docker/data-source-services && docker-compose up --build -d
 ```
 
-#### Specific Setup - Windows
+### Windows
 * Kill, and optionally disable, the `World Wide Web Publishing Service`
 * Run `set COMPOSE_CONVERT_WINDOWS_PATHS=1` in your CMD or PowerShell terminal
 * Optionally, [read](https://github.com/docker/compose/issues/4303#issuecomment-379563170) this bug report.
 #### MinIO Setup - Local S3 Buckets
  * [Setting up MinIO for local development](docs/minio/README.md)
 
-### Optional: Data Source Tools
+---
+
+## Data Source Tools
 * Optionally included is the following tools:
   * phpMyAdmin
-* `cd ./devop-tools/docker/data-source-tools && docker-compose up --build -d`
+  * Mailpit
+
+```bash
+cd ./devop-tools/docker/data-source-tools && docker-compose up --build -d
+```
 
-## phpMyAdmin
-If the optional tools are launched, you can find phpMyAdmin at: localhost:8080
+### phpMyAdmin
+_For managing MySQL/MariaDB databases visually._
+
+* Viewable at: http://localhost:8080
 * It supports the following databases...
   * mariadb106 (lts)
   * mariadb1011 (lts)
 
+### Mailpit
+_For mimicking an email inbox (ala mailtrap) for local usage._
+
+* Viewable at: http://localhost:8025
+* Configurable in projects via `.env`
+  * `MAIL_MAILER=smtp`
+  * `MAIL_HOST=sourcetoad_mailpit`
+  * `MAIL_PORT=1025`
+  * `MAIL_USERNAME=null`
+  * `MAIL_PASSWORD=null`
+  * `MAIL_ENCRYPTION=null`
+
+---
+
 ## Scripts
 Inside the `scripts` folder you will find one-off scripts to help with tasks.
 
 * `db_migrate.sh` - Helps migrate databases between versions of mysql.
 
 ## Docs
+* [Hop](docs/hop/README.md)
 * [Setting up Nginx-Proxy](docs/nginx-proxy/README.md)
 * [Setting up PHP Testing in PhpStorm](docs/phpstorm-docker/README.md)
 * [Leveraging Yii2 Shell](docs/yii2/yii-shell.md)

docker/data-source-services/docker-compose.yml

@@ -2,6 +2,7 @@
 # Everything ahead of the last two digits are standard for the given service
 #
 # Network name is st-{service name}-{service MAJOR.MINOR}
+---
 version: '3.8'
 services:
   nginxproxy:
@@ -15,7 +16,7 @@ services:
       - /var/run/docker.sock:/tmp/docker.sock:ro
       - ./proxy_increase.conf:/etc/nginx/proxy.conf
     networks:
-     - st-internal
+      - st-internal
   mariadb1011:
     image: mariadb:10.11
     container_name: sourcetoad_mariadb1011
@@ -55,6 +56,6 @@ services:
     networks:
       - st-internal
 networks:
-    st-internal:
-        external: true
-        name: st-internal
+  st-internal:
+    external: true
+    name: st-internal

docker/data-source-tools/docker-compose.yml

@@ -1,5 +1,18 @@
+---
 version: '3.8'
 services:
+  mailpit:
+    image: axllent/mailpit:latest
+    container_name: sourcetoad_mailpit
+    ports:
+      - "8025:8025"
+      - "1025:1025"
+    networks:
+      - st-internal
+    environment:
+      MP_MAX_MESSAGES: 5000
+      MP_SMTP_AUTH_ACCEPT_ANY: 1
+      MP_SMTP_AUTH_ALLOW_INSECURE: 1
   phpmyadmin:
     image: phpmyadmin/phpmyadmin:latest
     container_name: sourcetoad_phpmyadmin
@@ -12,6 +25,6 @@ services:
       PMA_USER: root
       PMA_PASSWORD: root
 networks:
-    st-internal:
-        external: true
-        name: st-internal
+  st-internal:
+    external: true
+    name: st-internal