From 37c405074f5327869f6b34e915857b8c23e2a77c Mon Sep 17 00:00:00 2001 From: Basti SK Date: Thu, 27 Mar 2025 19:24:24 +0100 Subject: [PATCH] format Readme.md --- Readme.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/Readme.md b/Readme.md index eb125bd..8dacc5a 100644 --- a/Readme.md +++ b/Readme.md @@ -1,10 +1,12 @@ # Docker-Compose Library A collection of docker-compose files for different open-source projects. -Disclaimer: most files are to be understood as "getting started" level. Make sure to think about security whenever you expose some service to the Internet! + +**Disclaimer**: most files are to be understood as "getting started" level. Make sure to think about security whenever you expose some service to the Internet! Check out the projects using the links below for any updates and best practices (most projects have their own guide on how to create a docker-compose file for hosting them). ## Prerequisites -To run these files you must install docker on your host. Detailed information on how to install docker on your operating system can be found [here](https://docs.docker.com/engine/install/). Additionally `docker-compose` is needed. See how to install it [here](https://docs.docker.com/compose/install/). +- To run these files you must install the `Docker` engine on your host. Detailed information on how to install Docker on your operating system can be found [here](https://docs.docker.com/engine/install/). +- Additionally `docker-compose` is needed. See how to install it [here](https://docs.docker.com/compose/install/). ## List of compose files The following compose files can be found in this repository. @@ -20,7 +22,9 @@ The following compose files can be found in this repository. - nextcloud | [docker-compose.yml](./bookstack/docker-compose.yml) | [Link to project](https://nextcloud.com/) - offen | [docker-compose.yml](./bookstack/docker-compose.yml) | [Link to project](https://www.offen.dev/) -## Reverse Proxy -Most docker-compose files are created with having a reverse-proxy infront of them to do SSL termination and subdomain binding. In each directory you will find a `nginx.conf` file for NGINX to use. Please note that this file is not including SSL certificates. To provide SSL automatically I recommend using [certbot](https://certbot.eff.org/) +## Proxy +- Most docker-compose files are created with having a reverse-proxy infront of them to do SSL termination and subdomain binding. +- In each directory you will find a `nginx.conf` file for NGINX to use. Please note that this file is not including SSL certificates. +- To provide SSL automatically I recommend using [certbot](https://certbot.eff.org/)