diff --git a/templates/.gitkeep b/templates/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/templates/docker-compose.md b/templates/docker-compose.md new file mode 100644 index 0000000..99ac418 --- /dev/null +++ b/templates/docker-compose.md @@ -0,0 +1,53 @@ +# /maintainer/ - /name/ + +This is a [Docker](/wiki/docker.md) container for a /service/ server. +The official container and documentation was made by +[/maintainer/](). +This docker-rebuild is made up by a `docker-compose.yml` file. +In addition to the main container you need to connect a +[/additional containers needed/]() to it. + +## Set-up + +Create the files `rebuild.sh`, `.env` and `docker-compose.yml` at the same +place. +Change the settings according to your needs and run `./rebuild.sh` afterwards. + +## Environment-variables + +Set the following variables with the -e tag. + +| Name | Usage | Default | +| ---------- | ------------- | ------- | +| `/name/` | /description/ | | + +## Ports + +Set the following ports in the `ports:` section. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | --------- | ------------- | +| `/port/` | `/port/` | /TCP/UDP/ | /description/ | + +## Volumes + +Set the following volumes with the -v tag. + +| Outside mount/volume name | Container mount | Description | +| ------------------------- | --------------- | ------------- | +| `/volume name/` | `/mount point/` | /description/ | + +## rebuild.sh + +```sh +``` + +## .env + +```sh +``` + +## docker-compose.yml + +```yml +``` diff --git a/templates/docker.md b/templates/docker.md new file mode 100644 index 0000000..98fdcc8 --- /dev/null +++ b/templates/docker.md @@ -0,0 +1,39 @@ +# /maintainer/ - /name/ + +This is a [Docker](/wiki/docker.md) container for a /service/ server. +The official container and documentation was made by +[/maintainer/](). + +## Set-up + +Create the file `rebuild.sh`. +Change the settings according to your needs and run `./rebuild.sh` afterwards. + +## Environment-variables + +Set the following variables with the -e tag. + +| Name | Usage | Default | +| ---------- | ------------- | ------- | +| `/name/` | /description/ | | + +## Ports + +Set the following ports in the `ports:` section. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | --------- | ------------- | +| `/port/` | `/port/` | /TCP/UDP/ | /description/ | + +## Volumes + +Set the following volumes with the -v tag. + +| Outside mount/volume name | Container mount | Description | +| ------------------------- | --------------- | ------------- | +| `/volume name/` | `/mount point/` | /description/ | + +## rebuild.sh + +```sh +``` diff --git a/templates/program.md b/templates/program.md new file mode 100644 index 0000000..ca589a0 --- /dev/null +++ b/templates/program.md @@ -0,0 +1,13 @@ +# /name/ + +[/name/]() is a /description. + +## Setup + +The /name/ program can be installed [/via GitHub/](). +Alternatively many linux package managers package /name/ in the `/package/` +package. + +## Usage + +/basic description for usage/ diff --git a/wiki/.gitkeep b/wiki/.gitkeep new file mode 100644 index 0000000..e69de29