Merge pull request #248 from linuxserver/version

add version date to proxy confs

.github/workflows/allowed_names.yml

@@ -1,24 +0,0 @@
-name: Check Allowed File Names
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  check-allowed-file-names:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-
-    - name: Check Allowed File Names
-      run: |
-        NOT_SAMPLES=$(find . -not -path '*/\.*' -type f ! \( -name '*.conf.sample' -o -name 'README.md' -o -name 'LICENSE' \))
-        NOT_SAMPLES_COUNT=$(echo "${NOT_SAMPLES}" | wc -w)
-        if (( NOT_SAMPLES_COUNT > 0 )); then
-            echo "The following files are not allowed:"
-            echo "${NOT_SAMPLES}"
-            exit 1
-        fi

.github/workflows/check_samples.yml

@@ -0,0 +1,34 @@
+name: Check Samples
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  check-allowed-file-names:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Check Allowed File Names
+      run: |
+        NOT_SAMPLES=$(find . -not -path '*/\.*' -type f ! \( -name '*.conf.sample' -o -name 'README.md' -o -name 'LICENSE' \))
+        NOT_SAMPLES_COUNT=$(echo "${NOT_SAMPLES}" | wc -w)
+        if (( NOT_SAMPLES_COUNT > 0 )); then
+            echo "The following files are not allowed:"
+            echo "${NOT_SAMPLES}"
+            exit 1
+        fi
+
+    - name: Check Version Date Line Exists
+      run: |
+        VERSION_LINE_MISSING=$(find . -not -path '*/\.*' -type f -name '*.conf.sample' -exec grep -H -c -P '^## Version (?:19|20|21)(?:(?:[13579][26]|[02468][048])\/(?:(?:0[1-9]|1[0-2])\/(?:0[1-9]|1[0-9]|2[0-9])|(?:(?!02)(?:0[1-9]|1[0-2])\/(?:30))|(?:(?:0[13578]|1[02])\/31))|(?:[0-9]{2}\/(?:0[1-9]|1[0-2])\/(?:0[1-9]|1[0-9]|2[0-8])|(?:(?!02)(?:0[1-9]|1[0-2])\/(?:29|30))|(?:(?:0[13578]|1[02])\/31)))$' {} \; | grep 0$ | cut -d':' -f1)
+        VERSION_LINE_MISSING_COUNT=$(echo "${VERSION_LINE_MISSING}" | wc -w)
+        if (( VERSION_LINE_MISSING_COUNT > 0 )); then
+            echo "The following files are missing the version date line:"
+            echo "${VERSION_LINE_MISSING}"
+            exit 1
+        fi

_template.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # REMOVE THIS LINE BEFORE SUBMITTING: The structure of the file (all of the existing lines) should be kept as close as possible to this template.
 # REMOVE THIS LINE BEFORE SUBMITTING: Look through this file for <tags> and replace them. Review other sample files to see how things are done.
 # REMOVE THIS LINE BEFORE SUBMITTING: The comment lines at the top of the file (below this line) should explain any prerequisites for using the proxy such as DNS or app settings.

_template.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # REMOVE THIS LINE BEFORE SUBMITTING: The structure of the file (all of the existing lines) should be kept as close as possible to this template.
 # REMOVE THIS LINE BEFORE SUBMITTING: Look through this file for <tags> and replace them. Review other sample files to see how things are done.
 # REMOVE THIS LINE BEFORE SUBMITTING: The comment lines at the top of the file (below this line) should explain any prerequisites for using the proxy such as DNS or app settings.

adguard.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for adguard and that your adguard container is named adguard
 
 server {

adminer.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # adminer does not require a base url setting, but the container needs to be named adminer
 
 location /adminer {

airsonic.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for airsonic and that your airsonic container is not using a base url
 # add `server.use-forward-headers=true` to `/config/application.properties` to ensure logs contain real source IP
 

airsonic.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # set the CONTEXT_PATH variable to /airsonic in airsonic container.
 
 location ^~ /airsonic {

archisteamfarm.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for archisteamfarm
 
 server {

authelia.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for authelia
 # the default authelia-server and authelia-location confs included with letsencrypt rely on
 # subfolder proxy at "/authelia" and enabling of this proxy conf is not necessary.

bazarr.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for bazarr and that your bazarr container is not using a base url
 
 server {

bazarr.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # first go into bazarr settings, under "General" set the URL Base to /bazarr/ and restart the bazarr container
 
 location /bazarr {

beets.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 #First edit beets.yml and enable the reverse proxy settings, under "web" add "reverse_proxy: true" and restart the beets container.
 #Make sure that your dns has a cname set for beets and that your beets container is not using a base url
 

beets.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 #first edit beets.yml and enable the reverse proxy settings, under "web" add "reverse_proxy: true" and restart the beets container
 
 location /beets {

bitwarden.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for bitwarden and that your bitwarden container is not using a base url
 # make sure your bitwarden container is named "bitwarden"
 # set the environment variable WEBSOCKET_ENABLED=true on your bitwarden container

boinc.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for boinc
 
 server {

boinc.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # boinc does not require a base url setting
 
 location /boinc {

booksonic.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for booksonic and that your booksonic container is not using a base url
 
 server {

booksonic.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # set the CONTEXT_PATH variable to /booksonic in booksonic container.
 
 location ^~ /booksonic {

bookstack.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for bookstack and that your bookstack container is named bookstack
 # Ensure you have the APP_URL Environment Variable set correctly in your Docker Run/Compose or in BookStack Env File (/www/.env)
 # https://github.com/linuxserver/docker-bookstack#docker

calibre-web.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for calibre-web
 
 server {

calibre-web.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # calibre-web does not require a base url setting
 
 location /calibre-web {

calibre.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for calibre
 
 server {

calibre.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # calibre does not require a base url setting
 
 location /calibre {

code-server.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for code-server
 
 server {

codimd.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure you have added the following environmental variables to your run command/compose file
 # CMD_DOMAIN=codimd.server.com
 # CMD_PROTOCOL_USESSL=true

collabora.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for collabora and that your collabora container is named collabora
 
 server {

couchpotato.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for couchpotato and that your couchpotato container is not using a base url
 
 server {

couchpotato.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # first go into couchpotato settings, under "General" set the URL Base to /couchpotato and restart the couchpotato container
 
 location ^~ /couchpotato {

deluge.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for deluge and that your deluge container is not using a base url
 
 server {

deluge.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # deluge does not require a base url setting
 
 location /deluge {

dillinger.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for dillinger
 
 server {

documentserver.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # Make sure that your dns has a cname set for onlyoffice named "documentserver"
 # Make sure that the onlyoffice documentserver container is named "documentserver"
 

dokuwiki.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # First complete the setup by appending install.php to URL.
 # Make sure that your dns has a cname set for dokuwiki
 

domoticz.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # Make sure that your dns has a cname set for domoticz and that your domoticz container is not using a base url
 
 server {

domoticz.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # set the WEBROOT variable to domoticz for the domoticz container.
 
 location ^~ /domoticz/ {

dozzle.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for dozzle and that your dozzle container is named dozzle
 
 server {

dozzle.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # First either add "--base /dozzle" or "-e DOZZLE_BASE=/dozzle" to your docker run command, and restart the Dozzle container
 
 location /dozzle {

drone.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 server {
     listen 443 ssl;
     listen [::]:443 ssl;

duplicati.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for duplicati and that your duplicati container is not using a base url
 
 server {

duplicati.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # duplicati does not require a base url setting. DUPLICATI AUTH WILL NOT WORK WITH THIS CONFIG, use the auth options below
 
 location /duplicati {

emby.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for emby and that your emby container is not using a base url
 # if emby is running in bridge mode and the container is named "emby", the below config should work as is
 # if not, replace the line "set $upstream_app emby;" with "set $upstream_app <containername>;"

emby.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for emby
 # if emby is running in bridge mode and the container is named "emby", the below config should work as is
 # if not, replace the line "set $upstream_app emby;" with "set $upstream_app <containername>;"

embystat.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for embystat
 
 server {

flexget.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for flexget
 
 server {

flood.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for flood and that your flood container is not using a base url
 
 server {

flood.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # flood does not require a base url setting
 
 location /flood {

foldingathome.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for foldingathome
 
 server {

freshrss.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for freshrss
 
 server {

freshrss.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # freshrss does not have a base url setting
 
 location /freshrss {

ghost.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for ghost and that your ghost config is not using a subdirectory.
 
 server {

ghost.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # Make sure you are using a subfolder in your ghost config file. https://ghost.org/docs/concepts/config/#url
 # Note: /ghost/ is by default used for the admin page. See https://ghost.org/docs/concepts/config/#admin-url
 

gitea.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for gitea and the following parameters in /data/gitea/conf/app.ini are edited
 # [server]
 # SSH_DOMAIN       = gitea.server.com

gitea.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # The following parameters in /data/gitea/conf/app.ini should be edited to match your setup
 # [server]
 # SSH_DOMAIN       = example.com:2222

glances.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for glances and that your glances container is not using a base url
 
 server {

glances.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # glances does not require a base url setting
 
 location /glances {

gotify.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for gotify
 
 server {

grafana.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for grafana and that your grafana container is not using a base url
 
 server {

grafana.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # grafana requires environment variables set thus:
 #    environment:
 #      - "GF_SERVER_ROOT_URL=https://my.domain.com/grafana"

grocy.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for grocy
 
 server {

guacamole.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for guacamole and that your guacamole container is not using a base url
 
 server {

guacamole.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # guacamole does not require a base url setting
 
 location /guacamole {

headphones.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for headphones
 
 server {

headphones.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # first stop the headphones container and edit the config.ini for headphones and set http_root to /headphones and then start the headphones container
 
 location ^~ /headphones {

heimdall.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for heimdall
 
 server {

heimdall.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # In order to use this location block you need to edit the default file one folder up and comment out the / location
 
 location / {

homeassistant.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for homeassistant and that your homeassistant container is not using a base url
 
 server {

jackett.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for jackett and that your jackett container is not using a base url
 
 server {

jackett.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # first go into jackett settings, set the URL Base to /jackett and restart the jackett container
 
 location ^~ /jackett {

jellyfin.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for jellyfin
 # if jellyfin is running in bridge mode and the container is named "jellyfin", the below config should work as is
 # if not, replace the line "set $upstream_app jellyfin;" with "set $upstream_app <containername>;"

jellyfin.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for jellyfin
 # if jellyfin is running in bridge mode and the container is named "jellyfin", the below config should work as is
 # if not, replace the line "set $upstream_app jellyfin;" with "set $upstream_app <containername>;"

jenkins.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # First either add '--prefix=/jenkins' or '-e JENKINS_OPTS="--prefix=/jenkins"' to your docker run command, and restart the Jenkins container.
 # Also be sure to add '/jenkins/' to your URL under: Jenkins > Configuration > Manage Jenkins > Jenkins URL
 

kanzi.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for kanzi
 
 server {

kanzi.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # kanzi does not have a base url setting
 
 location /kanzi {

lazylibrarian.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for lazylibrarian
 
 server {

lazylibrarian.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # first go into lazylibrarian settings, under "Interface" set the URL Base to /lazylibrarian and restart the lazylibrarian container
 
 location ^~ /lazylibrarian {

librespeed.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for librespeed
 
 server {

lidarr.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for lidarr and that your lidarr container is not using a base url
 
 server {

lidarr.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # first go into lidarr settings, under "General" set the URL Base to /lidarr and restart the lidarr container
 
 location ^~ /lidarr {

lychee.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for lychee
 
 server {

mailu.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for mailu and that your mailu front container is named front
 
 server {

mailu.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # mailu does not require a base url setting, but the container needs to be named front
 
 # This config have been tested with "TLS_FLAVOR=mail"

matomo.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for matomo and that your matomo container is not using a base url
 
 server {

medusa.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for medusa
 
 server {

medusa.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # first go into medusa settings, under "Interface" set the URL Base to /medusa and restart the medusa container
 
 location ^~ /medusa {

metube.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for metube
 
 server {

metube.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # set the URL_PREFIX environment variable for the metube container to "/metube"
 
 location /metube {

miniflux.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for miniflux
 
 server {

miniflux.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # set the environment variable "BASE_URL" to "https://yourdomain.url/miniflux/", or follow this guide to create a config file for Miniflux: https://miniflux.app/docs/configuration.html
 
 location /miniflux {

monitorr.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for monitorr
 
 server {

monitorr.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # monitorr does not require a base url setting
 
 location /monitorr {

mstream.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for mstream and your container name is mstream and running using http (default)
 
 server {

mylar.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for mylar
 
 server {

mylar.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # first stop the mylar container and edit the config.ini for mylar and set http_root to /mylar and then start the mylar container
 
 location ^~ /mylar {

mytinytodo.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # works with https://github.com/breakall/mytinytodo-docker
 # set the mtt_url to 'https://your.domain.com/todo/' in db/config.php
 

navidrome.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for navidrome and that your navidrome container is not using a base url
 
 server {

netboot.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for netboot
 
 server {

netdata.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for netdata
 
 server {

netdata.subfolder.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # netdata does not require a base url setting
 
 location /netdata {

nextcloud.subdomain.conf.sample

@@ -1,3 +1,4 @@
+## Version 2020/12/09
 # make sure that your dns has a cname set for nextcloud
 # assuming this container is called "swag", edit your nextcloud container's config
 # located at /config/www/nextcloud/config/config.php and add the following lines before the ");":