Skip to content

Commit

Permalink
doc: add usage instructions for docker compose snippets
Browse files Browse the repository at this point in the history
  • Loading branch information
brianmcgee committed Mar 31, 2020
1 parent dfc2b52 commit 0a85635
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,26 @@ direnv: export +BASE_DOMAIN +ENV_FILE +NODE_VERSION +POSTGRES_DB +POSTGRES_PASSW

## Usage

This repository is designed to help in two main areas:

* configuring services via docker compose for frontend or API development

* executing every day commands such as yarn or npm in a fashion consistent with the docker compose setup or in a
standalone fashion without requiring the installation of the aforementioned tools

### Docker Compose

Included within the `docker/compose` directory are a series of snippets which can be copied into the `docker-compose.yml` file of any
target repository. Currently there are examples for:

* [Traefik](https://containo.us/traefik/)
* [PostgreSQL](https://www.postgresql.org/)
* [MariaDB](https://mariadb.org/)
* [Mailhog](https://github.com/mailhog/MailHog)
* [Gatsby](https://www.gatsbyjs.org/)
* [Angular](https://angular.io/)
* General Node-based API development

When copying the snippets be sure to observe the different sections such as `network`, `volumes` and `services` and be sure
to merge each individually into your `docker-compose.yml` file.

10 changes: 10 additions & 0 deletions compose/traefik.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
version: '3.7'

########################################################################################################################
#
# Traefik Reverse Proxy
#
# This snippet relies upon the example config within /traefik/traefik.yml. You must ensure when copying this to your
# docker-compose.yml file that the path specified in the volume mount below is correct.
#
#
########################################################################################################################

networks:

net:
Expand Down

0 comments on commit 0a85635

Please sign in to comment.