Do more docs fixing and version bumping. Bork bork bork.

freenas · Mar 17, 2017 · e32e5c9 · e32e5c9
1 parent 947ade3
commit e32e5c9
Show file tree

Hide file tree

Showing 23 changed files with 79 additions and 32 deletions.
diff --git a/baseimage/Dockerfile b/baseimage/Dockerfile
@@ -1,5 +1,5 @@
 FROM phusion/baseimage:latest
 LABEL org.freenas.interactive="true" \
+      org.freenas.version="2" \
       org.freenas.command="/bin/sh" \
-      org.freenas.version="1" \
       org.freenas.upgradeable="false"
diff --git a/baseimage/README.md b/baseimage/README.md
@@ -1,4 +1,6 @@
-Simple Linux "baseimage" container.  This is an Interactive container, meaning
+# Baseimage Linux
+
+This is a simple Linux "baseimage" container. It is an Interactive container, meaning
 that the Console UI / CLI will talk directly to the command specified (and
 can be connected / disconnected repeatedly without killing the container).
 The command argument also MUST be specified - this is generally /bin/sh or

diff --git a/debian/Dockerfile b/debian/Dockerfile
@@ -1,6 +1,6 @@
 FROM debian:latest
 LABEL org.freenas.interactive="true" \
       org.freenas.command="/bin/sh" \
-      org.freenas.version="1" \
+      org.freenas.version="2" \
       org.freenas.upgradeable="false"
 
diff --git a/debian/README.md b/debian/README.md
@@ -1,4 +1,6 @@
-Simple Debian Linux container.  This is an Interactive container, meaning
+# Debian Linux
+
+This is a simple Debian Linux container. It is an Interactive container, meaning
 that the Console UI / CLI will talk directly to the command specified (and
 can be connected / disconnected repeatedly without killing the container).
 The command argument also MUST be specified - this is generally /bin/sh or

diff --git a/duckdns/README.md b/duckdns/README.md
@@ -1,3 +1,5 @@
+# Duck DNS - Free DNS service
+
 Duck DNS is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. The service is completely free, and doesn't require reactivation or forum posts to maintain its existence.
 
 Setting up the application
@@ -6,8 +8,10 @@ First, go to duckdns site, register your subdomain and retrieve your token
 Then run the docker create command above with your subdomain(s) and token
 It will update your IP with the DuckDNS service every 5 minutes
 
--e PGID for GroupID - see below for explanation
--e PUID for UserID - see below for explanation
--e SUBDOMAINS for subdomains - multiple subdomains allowed, comma separated, no spaces
--e TOKEN for DuckDNS token
--e TZ for timezone information, eg Europe/London
+# Settings
+
+PGID for GroupID - see below for explanation
+PUID for UserID - see below for explanation
+SUBDOMAINS for subdomains - multiple subdomains allowed, comma separated, no spaces
+TOKEN for DuckDNS token
+TZ for timezone information, eg Europe/London
diff --git a/emby-beta/README.md b/emby-beta/README.md
@@ -0,0 +1,32 @@
+# Beta version of emby server
+
+Emby Server is a home media server built on top of other popular open source
+technologies such as Service Stack, jQuery, jQuery mobile, and Mono.
+
+It features a REST-based API with built-in documention to facilitate client
+development. We also have client libraries for our API to enable rapid
+development.
+
+# Environment Variables:
+
+You can adjust some of the default settings set for container/application by
+passing any or all of the following environment variable:  
+
+| ENV VAR      | Definition                                                                     |
+| ------------ | ------------------------------------------------------------------------------ |
+| APP_USER     | Name of user the service will run as.\[4\]                                     |
+| APP_UID      | UID assigned to APP_USER upon creation, or will query APP_USER's ID.\[3\]      |
+| APP_GID      | GID assigned to APP_USER upon creation, or will query APP_USER's GID.\[3\]     |
+| APP_CONFIG   | Location where application will store settings and database on host.\[1\]      |
+| APP_GCONFIG  | Location where application will store settings and database within guest.\[4\] |
+| UMASK        | umask assigned to service, default set to 002.\[4\]                            |
+| EDGE         | Update the containerized service, default set to 0(Off).\[4\]                  |
+
+\[1\]: Variable is applicable only during install.  
+\[2\]: Variable is applicable during install, when invoking installed wrapper script or systemd service.  
+\[3\]: Variable is applicable only when invoking docker run directly.  
+\[4\]: Variable is applicable in all scenarios.  
+
+# Volumes:
+
+* `/config`  - Folder for configuration and settings.
diff --git a/gentoo/Dockerfile b/gentoo/Dockerfile
@@ -1,6 +1,6 @@
 FROM vguardiola/gentoo:latest
 LABEL org.freenas.interactive="true" \
+      org.freenas.version="2" \
       org.freenas.command="/bin/sh" \
-      org.freenas.version="1" \
       org.freenas.upgradeable="false"
 
diff --git a/gentoo/README.md b/gentoo/README.md
@@ -1,4 +1,6 @@
-Simple Gentoo Linux container.  This is an Interactive container, meaning
+# Gentoo Linux
+
+This is a simple Gentoo Linux container. It is an Interactive container, meaning
 that the Console UI / CLI will talk directly to the command specified (and
 can be connected / disconnected repeatedly without killing the container).
 The command argument also MUST be specified - this is generally /bin/sh or

diff --git a/grafana/Dockerfile b/grafana/Dockerfile
@@ -1,5 +1,5 @@
 FROM grafana/grafana:latest
-LABEL org.freenas.version="1"                           \
+LABEL org.freenas.version="2"                           \
       org.freenas.web-ui-protocol="http"                \
       org.freenas.expose-ports-at-host="true"           \
       org.freenas.web-ui-port=3000                      \

diff --git a/grafana/README.md b/grafana/README.md
@@ -1,4 +1,6 @@
-A Grafana server (system statistics monitoring visualization toolkit). Base container is grafana/grafana with FreeNAS metadata added. All variables in conf/grafana.ini can be overriden using environment variables.
+# A Grafana server (system statistics monitoring visualization toolkit).
+
+Base container is grafana/grafana with FreeNAS metadata added. All variables in conf/grafana.ini can be overriden using environment variables.
 
 ### How to setup Grafana to receive data from FreeNAS' Graphite sender
 
@@ -28,4 +30,4 @@ alt="Creating a New Dashboard" width="240" height="180" border="10" /></a>
 
 ### ENV Variables
 * GF_INSTALL_PLUGINS 
- * Set this variable to a CSV list of Grafana plugins to install, this will pass each plugin name to `grafana-cli plugins install`. For example `grafana-clock-panel,grafana-simple-json-datasource,grafana-piechart-panel`. 
+ * Set this variable to a CSV list of Grafana plugins to install, this will pass each plugin name to `grafana-cli plugins install`. For example `grafana-clock-panel,grafana-simple-json-datasource,grafana-piechart-panel`. 
diff --git a/graphite-statsd/Dockerfile b/graphite-statsd/Dockerfile
@@ -1,5 +1,5 @@
 FROM hopsoft/graphite-statsd:latest
-LABEL org.freenas.version=1                             \
+LABEL org.freenas.version="2"                           \
       org.freenas.web-ui-protocol="http"                \
       org.freenas.expose-ports-at-host="true"           \
       org.freenas.web-ui-port=5080                      \

diff --git a/graphite-statsd/README.md b/graphite-statsd/README.md
@@ -1,4 +1,6 @@
-A Graphite server w/ statsd. Base container is hopsoft/graphite-statsd with FreeNAS metadata added. 
+# A Graphite server w/ statsd.
+
+Base container is hopsoft/graphite-statsd with FreeNAS metadata added. 
 
 ## Login instructions:
 

diff --git a/headphones/Dockerfile b/headphones/Dockerfile
@@ -1,6 +1,6 @@
 FROM linuxserver/headphones:latest
 LABEL org.freenas.interactive="false" \
-      org.freenas.version="1" \
+      org.freenas.version="2" \
       org.freenas.upgradeable="true" \
       org.freenas.expose-ports-at-host="true" \
       org.freenas.autostart="true" \

diff --git a/htpcmanager/Dockerfile b/htpcmanager/Dockerfile
@@ -1,6 +1,6 @@
 FROM linuxserver/htpcmanager:latest
 LABEL org.freenas.interactive="false" \
-      org.freenas.version="1" \
+      org.freenas.version="2" \
       org.freenas.upgradeable="true" \
       org.freenas.expose-ports-at-host="true" \
       org.freenas.autostart="true" \

diff --git a/htpcmanager/README.md b/htpcmanager/README.md
@@ -1,8 +1,8 @@
-Htpcmanager, a front end for many htpc related applications.
-
 [appurl]: https://github.com/Hellowlol/HTPC-Manager
 [![htpcmanager](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/htpcmanager-icon.png)][appurl]
 
+# Htpcmanager, a front end for many htpc related applications.
+
 ## Parameters
 
 * `8085` - the port(s)

diff --git a/jdownloader/Dockerfile b/jdownloader/Dockerfile
@@ -1,6 +1,6 @@
 FROM dbarton/jdownloader
 LABEL org.freenas.interactive="false"				\
-      org.freenas.version="1"					\
+      org.freenas.version="2"					\
       org.freenas.upgradeable="true"				\
       org.freenas.expose-ports-at-host="true"			\
       org.freenas.autostart="true"				\

diff --git a/jdownloader/README.md b/jdownloader/README.md
@@ -1,6 +1,6 @@
-Jdownloader Headlessmode
+# Jdownloader Headlessmode
 
- image for [JDownloader](http://www.jdownloader.org/) - the open-source download manager.
+Docker image for [JDownloader](http://www.jdownloader.org/) - the open-source download manager.
 
 The Docker image currently supports:
 

diff --git a/kodi-server/README.md b/kodi-server/README.md
@@ -1,6 +1,6 @@
 # docker-kodi-server
 
-This will allow you to
+This container will allow you to:
 * serve files through the XBMC UPnP Library to your UPnP client/players (such as Xbmc or Chromecast).
 * Web access every time , or use with some tools like [htpc-manager](http://htpc.io/)
 * Trigger library scan When you want or from sickbeard/sickrage/couchpotato/...

diff --git a/nextcloud/Dockerfile b/nextcloud/Dockerfile
@@ -1,6 +1,6 @@
 FROM nextcloud:latest
 LABEL org.freenas.interactive="false" \
-      org.freenas.version="1" \
+      org.freenas.version="2" \
       org.freenas.upgradeable="true" \
       org.freenas.expose-ports-at-host="true" \
       org.freenas.autostart="true" \

diff --git a/radarr/Dockerfile b/radarr/Dockerfile
@@ -1,6 +1,6 @@
 FROM linuxserver/radarr:latest
 LABEL org.freenas.interactive="false"                                   \
-      org.freenas.version="1"                                           \
+      org.freenas.version="2"                                           \
       org.freenas.upgradeable="true"                                    \
       org.freenas.expose-ports-at-host="true"                           \
       org.freenas.autostart="true"                                      \
@@ -38,4 +38,4 @@ LABEL org.freenas.interactive="false"                                   \
               \"descr\": \"UserID\",                                    \
               \"optional\": true                                        \
          }                                                              \
-      ]"
+      ]"
diff --git a/radarr/README.md b/radarr/README.md
@@ -1,3 +1,3 @@
-Radarr - A fork of Sonarr to work with movies Ã la Couchpotato. 
+# Radarr - A fork of Sonarr to work with movies ala Couchpotato. 
 
-Access the webui at <your-ip>:7878
+Access the webui at <your-ip>:7878
diff --git a/subsonic/Dockerfile b/subsonic/Dockerfile
@@ -1,6 +1,6 @@
 FROM akegata/subsonic:latest
 LABEL org.freenas.interactive="false" \
-      org.freenas.version="1" \
+      org.freenas.version="2" \
       org.freenas.upgradeable="true" \
       org.freenas.expose-ports-at-host="true" \
       org.freenas.autostart="true" \

diff --git a/subsonic/README.md b/subsonic/README.md
@@ -1,5 +1,6 @@
-## Description
-A Dockerfile for [Subsonic](http://www.subsonic.org/) version 5.0.
+# A complete, personal media streamer
+
+This is a Dockerfile for [Subsonic](http://www.subsonic.org/) version 5.0.
 
 ## Ports