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

add additional details to documentation

Browse Source
This commit is contained in:
Basti SK 2025-03-27 19:33:28 +01:00
parent 37c405074f
commit 653f2afd24
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Readme.md
View File

@ -1,13 +1,33 @@
# 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! 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). **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! Please 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).
## About volumes
- You will find that most files reference volumes as paths. This is because I find it easier to backup and handle volumes if they are located either next to the `docker-compose.yml` file or at a specific directory on the host.
- Please note, that sometimes it can be necessary to change the permissions of these directories to match the user under which the container is executed!
## Prerequisites ## Prerequisites
- 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/). - 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/). - Additionally `docker-compose` is needed. See how to install it [here](https://docs.docker.com/compose/install/).
If you are using [OpenSUSE](https://en.opensuse.org/Docker), you can use these commands to installl the needed tools.
```bash
# install packages
sudo zypper install docker docker-compose docker-compose-switch
# add docker-daemon to start automatically on boot
sudo systemctl enable docker
# start the docker-daemon
sudo systemctl restart docker
# check that docker-daemon is running
sudo docker run --rm hello-world
```
## 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.
- bookstack | [docker-compose.yml](./bookstack/docker-compose.yml) | [Link to project](https://www.bookstackapp.com/) - bookstack | [docker-compose.yml](./bookstack/docker-compose.yml) | [Link to project](https://www.bookstackapp.com/)