5 Home

LRVT edited this page 2023-02-25 18:54:35 +01:00

Table of Contents

• Welcome to the Compose-Examples wiki!
• How to submit examples

Welcome to the Compose-Examples wiki!

• If you identify a bug or issue in one of the provided Docker Compose examples, please do not hesitate to open a GitHub issue.

How to submit examples

1. Create a new folder with the name of the Docker project inside the examples directory. May use the skeleton example and clone it.
2. Define and adjust your docker-compose.yml file with helpful notes. Each service definition must contain an image and container_name directive. For volume definitions, please see the skeleton example. Mappings must default to /mnt/docker-volumes/<container-name>.
3. Define a README.md and reference the official FOSS project. Provide additional notes if necessary.
4. Also adjust the root README.md file of this GitHub repository and append your newly added project + a short description. If your project does not fit into an existing category, just introduce a new one.
5. Create a pull request on GitHub. Refrain from submitting a PR with too many adjustments. For each newly added example, use one PR.