diff --git a/readme/plex/README.md b/readme/plex/README.md index 07944f1..aaa1cbb 100644 --- a/readme/plex/README.md +++ b/readme/plex/README.md @@ -24,6 +24,8 @@ Find us at: ![plex](http://the-gadgeteer.com/wp-content/uploads/2015/10/plex-logo-e1446990678679.png) +Find the linuxserver Github  repo [here](https://github.com/linuxserver/reponame) for this container. + ## Usage Here are some example snippets to help you get started creating a container. diff --git a/readme/smokeping/README.md b/readme/smokeping/README.md index 1051d96..701632e 100644 --- a/readme/smokeping/README.md +++ b/readme/smokeping/README.md @@ -24,6 +24,8 @@ Find us at: ![smokeping](https://camo.githubusercontent.com/e0694ef783e3fd1d74e6776b28822ced01c7cc17/687474703a2f2f6f73732e6f6574696b65722e63682f736d6f6b6570696e672f696e632f736d6f6b6570696e672d6c6f676f2e706e67) +Find the linuxserver Github  repo [here](https://github.com/linuxserver/docker-smokeping) for this container. + ## Usage Here are some example snippets to help you get started creating a container. @@ -36,7 +38,7 @@ docker create \ -e PUID=1001 \ -e PGID=1001 \ -p 80:80 \ - -v :/config \ + -v :/config \ -v :/data \ linuxserver/smokeping ``` @@ -57,7 +59,7 @@ services: - PUID=1001 - PGID=1001 volumes: - - :/config + - :/config - :/data ports: - 80:80 diff --git a/roles/generate-docs/templates/README.md.j2 b/roles/generate-docs/templates/README.md.j2 index 394c3c9..e3ce6ac 100644 --- a/roles/generate-docs/templates/README.md.j2 +++ b/roles/generate-docs/templates/README.md.j2 @@ -24,6 +24,8 @@ Find us at: ![{{ project_name }}]({{ project_logo }}) +Find the {{ lsio_project_name_short }} Github  repo [here]({{ project_lsio_github_repo_url }}) for this container. + ## Usage Here are some example snippets to help you get started creating a container. diff --git a/vars/_container-vars-blank b/vars/_container-vars-blank new file mode 100644 index 0000000..ccc6c31 --- /dev/null +++ b/vars/_container-vars-blank @@ -0,0 +1,35 @@ +--- + +# project information +project_name: name +project_url: "https://url.com/" +project_logo: "http://www.logo.com/logo.png" +project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) short description goes here." +project_lsio_github_repo_url: "https://github.com/linuxserver/reponame" + +# container parameters +common_param_env_vars_enabled: true #PGID, PUID, etc +param_container_name: "{{ project_name }}" +param_usage_include_net: false +param_net: "host" +param_net_desc: "Shares host networking with container." +param_usage_include_env: false +param_env_vars: + - { env_var: "VERSION", env_value: "latest", desc: "Supported values are LATEST, PLEXPASS or a specific version number." } +param_usage_include_vols: true +param_volumes: + - { vol_path: "/config", vol_host_path: "", desc: "short volume description here please" } +param_usage_include_ports: true +param_ports: + - { external_port: "80", internal_port: "80", port_desc: "short description of ports purpose (HTTP, etc)" } + +optional_block_1: false +optional_block_1_items: + - "```" + - "include optional stuff" + - "```" + +# changelog + +changelogs: + - { date: "09.12.17:", desc: "changes description" } \ No newline at end of file diff --git a/vars/conatiner-airsonic b/vars/conatiner-airsonic new file mode 100644 index 0000000..ccc6c31 --- /dev/null +++ b/vars/conatiner-airsonic @@ -0,0 +1,35 @@ +--- + +# project information +project_name: name +project_url: "https://url.com/" +project_logo: "http://www.logo.com/logo.png" +project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) short description goes here." +project_lsio_github_repo_url: "https://github.com/linuxserver/reponame" + +# container parameters +common_param_env_vars_enabled: true #PGID, PUID, etc +param_container_name: "{{ project_name }}" +param_usage_include_net: false +param_net: "host" +param_net_desc: "Shares host networking with container." +param_usage_include_env: false +param_env_vars: + - { env_var: "VERSION", env_value: "latest", desc: "Supported values are LATEST, PLEXPASS or a specific version number." } +param_usage_include_vols: true +param_volumes: + - { vol_path: "/config", vol_host_path: "", desc: "short volume description here please" } +param_usage_include_ports: true +param_ports: + - { external_port: "80", internal_port: "80", port_desc: "short description of ports purpose (HTTP, etc)" } + +optional_block_1: false +optional_block_1_items: + - "```" + - "include optional stuff" + - "```" + +# changelog + +changelogs: + - { date: "09.12.17:", desc: "changes description" } \ No newline at end of file diff --git a/vars/container-plex b/vars/container-plex index 0b81ee0..2ff2510 100644 --- a/vars/container-plex +++ b/vars/container-plex @@ -5,6 +5,7 @@ project_name: plex project_url: "https://plex.tv/" project_logo: "http://the-gadgeteer.com/wp-content/uploads/2015/10/plex-logo-e1446990678679.png" project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) organizes video, music and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone Plex Media Server." +project_lsio_github_repo_url: "https://github.com/linuxserver/reponame" # container parameters common_param_env_vars_enabled: true #PGID, PUID, etc diff --git a/vars/container-smokeping b/vars/container-smokeping index cca27ba..1553196 100644 --- a/vars/container-smokeping +++ b/vars/container-smokeping @@ -5,6 +5,7 @@ project_name: smokeping project_url: "https://oss.oetiker.ch/smokeping/" project_logo: "https://camo.githubusercontent.com/e0694ef783e3fd1d74e6776b28822ced01c7cc17/687474703a2f2f6f73732e6f6574696b65722e63682f736d6f6b6570696e672f696e632f736d6f6b6570696e672d6c6f676f2e706e67" project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) keeps track of your network latency. For a full example of what this application is capable of visit [UCDavis](http://smokeping.ucdavis.edu/cgi-bin/smokeping.fcgi)." +project_lsio_github_repo_url: "https://github.com/linuxserver/docker-smokeping" # container parameters param_container_name: "{{ project_name }}" @@ -14,7 +15,7 @@ param_usage_include_env: false param_env_vars: [] param_usage_include_vols: true param_volumes: - - { vol_path: "/config", vol_host_path: "", desc: "Configure the `Targets` file here" } + - { vol_path: "/config", vol_host_path: "", desc: "Configure the `Targets` file here" } - { vol_path: "/data", vol_host_path: "", desc: "Storage location for db and application data (graphs etc)" } param_usage_include_ports: true param_ports: