bastisk/Compose-Library
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

format Readme.md

Browse Source
This commit is contained in:
Basti SK 2025-03-27 19:24:24 +01:00
parent 52489241d7
commit 37c405074f
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Readme.md
View File

@ -1,10 +1,12 @@
# Docker-Compose Library # Docker-Compose Library
A collection of docker-compose files for different open-source projects. 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 ## 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 ## List of compose files
The following compose files can be found in this repository. 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/) - 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/) - offen | [docker-compose.yml](./bookstack/docker-compose.yml) | [Link to project](https://www.offen.dev/)
## Reverse Proxy ## 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/) - 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/)