mirror
/
Compose-Examples
kopia lustrzana https://github.com/Haxxnet/Compose-Examples
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Updated Home (markdown)

master
LRVT 2023-02-25 18:54:35 +01:00
rodzic 9422da5455
commit 51d6dca3d2
1 zmienionych plików z 4 dodań i 17 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

21
Home.md

@ -1,24 +1,11 @@
# 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.
* If you cannot find a wanted FOSS project in the current list, please open a GitHub issue by mentioning your request
* If you have a working compose file for a now yet presented FOSS project, please free free to share!
## Guidelines for PRs
If you want to share your working `docker-compose.yml` file to the project, please adhere to the following principle:
1. All compose files are named `docker-compose.yml`.
2. All volume definitions shall remain to bind mounts.
3. All volume bind mount paths should default to `/mnt/docker-volumes/<container-name>/` to stay persitent.
4. All examples should contain a `README.md` with a reference to the official FOSS project (e.g. GitHub page or homepage).
5. Provide helpful steps, tricks, notes in the required `README.md` of a FOSS project example.
6. May also adjust the root `README.md` file and append your newly added project + a description.
## How to submit examples
1. Create a new folder with the name of the FOSS project inside the [examples](https://github.com/Haxxnet/Compose-Examples/tree/main/examples) dir
2. Define your `docker-compose.yml` file with helpful notes. Adhere to the above principles!
1. Create a new folder with the name of the Docker project inside the [examples](https://github.com/Haxxnet/Compose-Examples/tree/main/examples) directory. May use the [skeleton example](https://github.com/Haxxnet/Compose-Examples/blob/main/0_skeleton/docker-compose.yml) 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](https://github.com/Haxxnet/Compose-Examples/blob/main/0_skeleton/docker-compose.yml). 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. May also adjust the root `README.md` file and append your newly added project + a description.
4. Create a pull request on GitHub.
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.
4. Create a pull request on GitHub. Refrain from submitting a PR with too many adjustments. For each newly added example, use one PR.