From 64f4288664d2e1cdd6281ada4f59544e4e6d3433 Mon Sep 17 00:00:00 2001 From: IronicBadger Date: Fri, 27 Jul 2018 18:17:51 +0100 Subject: [PATCH] params update --- readme/airsonic/README.md | 6 +++++- readme/beets/README.md | 6 +++++- readme/plex/README.md | 6 +++++- readme/smokeping/README.md | 6 +++++- roles/generate-docs/templates/README.md.j2 | 6 +++++- 5 files changed, 25 insertions(+), 5 deletions(-) diff --git a/readme/airsonic/README.md b/readme/airsonic/README.md index 2ded7df..df9740f 100644 --- a/readme/airsonic/README.md +++ b/readme/airsonic/README.md @@ -73,7 +73,7 @@ services: ## Parameters -Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. +Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. | Parameter | Function | | :----: | --- | @@ -86,6 +86,10 @@ Container images are configured using parameters passed at runtime (such as thos | `-v /podcasts` | Location of podcasts. | | `-v /media` | Location of other media - optional | + + + + ## User / Group Identifiers When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. diff --git a/readme/beets/README.md b/readme/beets/README.md index af8a2b9..d262dd1 100644 --- a/readme/beets/README.md +++ b/readme/beets/README.md @@ -69,7 +69,7 @@ services: ## Parameters -Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. +Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. | Parameter | Function | | :----: | --- | @@ -80,6 +80,10 @@ Container images are configured using parameters passed at runtime (such as thos | `-v /music` | Music library location | | `-v /downloads` | Non-processed music | + + + + ## User / Group Identifiers When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. diff --git a/readme/plex/README.md b/readme/plex/README.md index 97413c7..5ac5cab 100644 --- a/readme/plex/README.md +++ b/readme/plex/README.md @@ -74,7 +74,7 @@ services: ## Parameters -Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. +Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. | Parameter | Function | | :----: | --- | @@ -88,6 +88,10 @@ Container images are configured using parameters passed at runtime (such as thos | `-v /data/movies` | Media goes here. Add as many as needed e.g. `/data/movies`, `/data/tv`, etc. | | `-v /transcode` | Path for transcoding folder, *optional*. | + + + + ## User / Group Identifiers When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. diff --git a/readme/smokeping/README.md b/readme/smokeping/README.md index dba91aa..3c18223 100644 --- a/readme/smokeping/README.md +++ b/readme/smokeping/README.md @@ -67,7 +67,7 @@ services: ## Parameters -Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. +Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. | Parameter | Function | | :----: | --- | @@ -77,6 +77,10 @@ Container images are configured using parameters passed at runtime (such as thos | `-v /config` | Configure the `Targets` file here | | `-v /data` | Storage location for db and application data (graphs etc) | + + + + ## User / Group Identifiers When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. diff --git a/roles/generate-docs/templates/README.md.j2 b/roles/generate-docs/templates/README.md.j2 index f601e22..c0c10e7 100644 --- a/roles/generate-docs/templates/README.md.j2 +++ b/roles/generate-docs/templates/README.md.j2 @@ -112,7 +112,7 @@ services: ## Parameters -Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. +Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. | Parameter | Function | | :----: | --- | @@ -140,6 +140,10 @@ Container images are configured using parameters passed at runtime (such as thos {% endfor %} {% endif %} + + + + ## User / Group Identifiers When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.