Markdown style fixes
This commit is contained in:
@@ -60,5 +60,6 @@ The following variables could be set an environment varaiables using the .env fi
|
|||||||
| DRAWIO_PORT | 8080 | Default port. |
|
| DRAWIO_PORT | 8080 | Default port. |
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
* [Docker Hub](https://hub.docker.com/r/jgraph/drawio)
|
* [Docker Hub](https://hub.docker.com/r/jgraph/drawio)
|
||||||
* [GitHub](https://github.com/jgraph/drawio)
|
* [GitHub](https://github.com/jgraph/drawio)
|
||||||
|
|||||||
+2
-1
@@ -21,7 +21,7 @@ Self hosted vehicle and expense management system. Like Clarkson, but better.
|
|||||||
* Open Portainer with the correct environment.
|
* Open Portainer with the correct environment.
|
||||||
* Under Stacks click the button + Add stack.
|
* Under Stacks click the button + Add stack.
|
||||||
* Give your stack a name (i.e.: hammond).
|
* Give your stack a name (i.e.: hammond).
|
||||||
* Paste the contents of docker-compose.yml under Web editor.
|
* Paste the contents of compose.yml under Web editor.
|
||||||
* Paste the contents of .env under Environment variables.
|
* Paste the contents of .env under Environment variables.
|
||||||
* Click Advanced mode to be able to paste.
|
* Click Advanced mode to be able to paste.
|
||||||
* Change the environment variables as you see fit.
|
* Change the environment variables as you see fit.
|
||||||
@@ -43,5 +43,6 @@ The following variables could be set as an environment varaiables using the .env
|
|||||||
| HAMMOND_PORT | 3000 | Default port. |
|
| HAMMOND_PORT | 3000 | Default port. |
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
* [Docker Hub](https://hub.docker.com/r/akhilrex/hammond)
|
* [Docker Hub](https://hub.docker.com/r/akhilrex/hammond)
|
||||||
* [GitHub](https://github.com/akhilrex/hammond)
|
* [GitHub](https://github.com/akhilrex/hammond)
|
||||||
|
|||||||
@@ -29,6 +29,7 @@ The following variables could be set as an environment varaiables using the .env
|
|||||||
| PLEX_CLAIM | | |
|
| PLEX_CLAIM | | |
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
* [Website](https://www.plex.tv/)
|
* [Website](https://www.plex.tv/)
|
||||||
* [Docker Hub](https://hub.docker.com/r/plexinc/pms-docker/)
|
* [Docker Hub](https://hub.docker.com/r/plexinc/pms-docker/)
|
||||||
* [GitHub](https://github.com/plexinc)
|
* [GitHub](https://github.com/plexinc)
|
||||||
|
|||||||
@@ -44,5 +44,6 @@ The following variables could be set an environment varaiables using the .env fi
|
|||||||
| PORTAINER_PORT | 9000 | Default port. |
|
| PORTAINER_PORT | 9000 | Default port. |
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
* [Docker Hub](https://hub.docker.com/r/portainer/portainer-ce)
|
* [Docker Hub](https://hub.docker.com/r/portainer/portainer-ce)
|
||||||
* [GitHub](https://github.com/portainer/portainer)
|
* [GitHub](https://github.com/portainer/portainer)
|
||||||
|
|||||||
@@ -9,14 +9,16 @@ Each compose file should contain as much variables as possible so in the event o
|
|||||||
Parts with an asterisk (*) should be always present.
|
Parts with an asterisk (*) should be always present.
|
||||||
|
|
||||||
### container_name*
|
### container_name*
|
||||||
```
|
|
||||||
|
```yaml
|
||||||
container_name: ${APP_CONTAINER_NAME:-App}
|
container_name: ${APP_CONTAINER_NAME:-App}
|
||||||
```
|
```
|
||||||
|
|
||||||
### hostname
|
### hostname
|
||||||
|
|
||||||
Should only be added if the desired hostname is different form the service name.
|
Should only be added if the desired hostname is different form the service name.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
hostname: app
|
hostname: app
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -24,7 +26,7 @@ Should only be added if the desired hostname is different form the service name.
|
|||||||
|
|
||||||
Docker Hub is always the prefered location to use for images. If there is no image hosted there, or the current image is not maintained, services like ghcr.io might be used as well but alway as a second choice.
|
Docker Hub is always the prefered location to use for images. If there is no image hosted there, or the current image is not maintained, services like ghcr.io might be used as well but alway as a second choice.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
image: publisher/app:${APP_TAG:-latest}
|
image: publisher/app:${APP_TAG:-latest}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -32,7 +34,7 @@ The latest tag is the preferred tag.
|
|||||||
|
|
||||||
### user
|
### user
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
user: ${UID:-1024}:${GID:-101}
|
user: ${UID:-1024}:${GID:-101}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -44,36 +46,39 @@ If there is no way to set the owner of the files to be created by the container
|
|||||||
|
|
||||||
Unless-stopped is the preferred restart policy.
|
Unless-stopped is the preferred restart policy.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
restart: ${RESTART:-unless-stopped}
|
restart: ${RESTART:-unless-stopped}
|
||||||
```
|
```
|
||||||
|
|
||||||
### network_mode
|
### network_mode
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
network_mode: host
|
network_mode: host
|
||||||
```
|
```
|
||||||
|
|
||||||
If there is no reason to set the network mode to something other than bridge then ommit the use of this part.
|
If there is no reason to set the network mode to something other than bridge then ommit the use of this part.
|
||||||
Bridge (nothing set) is always the preferred way but there are containers that don't need any way in and can make use of the following.
|
Bridge (nothing set) is always the preferred way but there are containers that don't need any way in and can make use of the following.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
network_mode: none
|
network_mode: none
|
||||||
```
|
```
|
||||||
|
|
||||||
### healthcheck
|
### healthcheck
|
||||||
|
|
||||||
If the image does not contain a health check already then implement one of the following options.
|
If the image does not contain a health check already then implement one of the following options.
|
||||||
|
|
||||||
Always try to use an image specific healthcheck, if available.
|
Always try to use an image specific healthcheck, if available.
|
||||||
|
|
||||||
Use curl
|
Use curl
|
||||||
```
|
|
||||||
|
```yaml
|
||||||
healthcheck:
|
healthcheck:
|
||||||
test: curl -f http://localhost:80/ || exit 1
|
test: curl -f http://localhost:80/ || exit 1
|
||||||
```
|
```
|
||||||
|
|
||||||
Use wget
|
Use wget
|
||||||
```
|
|
||||||
|
```yaml
|
||||||
healthcheck:
|
healthcheck:
|
||||||
test: wget --no-verbose --tries=1 --spider http://localhost:80/
|
test: wget --no-verbose --tries=1 --spider http://localhost:80/
|
||||||
```
|
```
|
||||||
@@ -82,7 +87,7 @@ If none of the options is available then ommit the use of a health check.
|
|||||||
|
|
||||||
### environment
|
### environment
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
environment:
|
environment:
|
||||||
UID: ${UID:-1024}
|
UID: ${UID:-1024}
|
||||||
GID: ${GID:-101}
|
GID: ${GID:-101}
|
||||||
@@ -92,7 +97,7 @@ If none of the options is available then ommit the use of a health check.
|
|||||||
|
|
||||||
UID (User ID), GID (Group ID) and TZ (TimeZone) should always use these variable names, see example below. This is so that if there is a change in one of them it will be the new value in all services in the stack (if there is more than 1).
|
UID (User ID), GID (Group ID) and TZ (TimeZone) should always use these variable names, see example below. This is so that if there is a change in one of them it will be the new value in all services in the stack (if there is more than 1).
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
environment:
|
environment:
|
||||||
APP_UID: ${UID:-1024}
|
APP_UID: ${UID:-1024}
|
||||||
APP_GID: ${GID:-101}
|
APP_GID: ${GID:-101}
|
||||||
@@ -101,7 +106,7 @@ UID (User ID), GID (Group ID) and TZ (TimeZone) should always use these variable
|
|||||||
|
|
||||||
Other environment variables should always be prefixed by the name of the application. An abbreviation to a application name should be replaced by the full name. See example below.
|
Other environment variables should always be prefixed by the name of the application. An abbreviation to a application name should be replaced by the full name. See example below.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
environment:
|
environment:
|
||||||
VARIABLE1: ${APP_VARIABLE1:-variable1}
|
VARIABLE1: ${APP_VARIABLE1:-variable1}
|
||||||
APP_VARIABLE2: ${APP_VARIABLE2:-variable2}
|
APP_VARIABLE2: ${APP_VARIABLE2:-variable2}
|
||||||
@@ -109,14 +114,15 @@ Other environment variables should always be prefixed by the name of the applica
|
|||||||
```
|
```
|
||||||
|
|
||||||
### ports
|
### ports
|
||||||
```
|
|
||||||
|
```yaml
|
||||||
ports:
|
ports:
|
||||||
- ${APP_PORT:-80}:80
|
- ${APP_PORT:-80}:80
|
||||||
```
|
```
|
||||||
|
|
||||||
If there is only one port available use the variable name as in the example above. If there are multiple ports try to use a short desription for all of them. See the example below.
|
If there is only one port available use the variable name as in the example above. If there are multiple ports try to use a short desription for all of them. See the example below.
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
ports:
|
ports:
|
||||||
- ${APP_PORT_HTTP:-80}:80
|
- ${APP_PORT_HTTP:-80}:80
|
||||||
- ${APP_PORT_SSH:-22}:22
|
- ${APP_PORT_SSH:-22}:22
|
||||||
@@ -124,7 +130,7 @@ If there is only one port available use the variable name as in the example abov
|
|||||||
|
|
||||||
### volumes
|
### volumes
|
||||||
|
|
||||||
```
|
```yaml
|
||||||
volumes:
|
volumes:
|
||||||
- /${SYNOLOGY_VOLUME:-volume1}/docker/${STACK_NAME:-stack}/${APP_CONTAINER_NAME:-App}/config:/config
|
- /${SYNOLOGY_VOLUME:-volume1}/docker/${STACK_NAME:-stack}/${APP_CONTAINER_NAME:-App}/config:/config
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user