Merge pull request #6 from linuxserver/password

Password protection

Dockerfile

@@ -17,19 +17,19 @@ RUN \
 	php7-pdo_sqlite \
 	php7-tokenizer \
 	tar && \
- mkdir -p /app/heimdall && \
+ echo "**** install heimdall ****" && \
- VERSION="$(curl -sX GET https://api.github.com/repos/linuxserver/Heimdall/releases/latest | grep 'tag_name' | cut -d\" -f4)" && \
+ HEIM_VER="$(curl -sX GET https://api.github.com/repos/linuxserver/Heimdall/releases/latest | grep 'tag_name' | cut -d\" -f4)" && \
- echo "**Installing Heimdall ${VERSION}**" && \
+ mkdir -p \
+	/var/www/localhost/heimdall && \
  curl -o \
-  /tmp/heimdall.tar.gz -L \
+ /tmp/heimdall.tar.gz -L \
-  "https://github.com/linuxserver/Heimdall/archive/${VERSION}.tar.gz" && \
+	"https://github.com/linuxserver/Heimdall/archive/${HEIM_VER}.tar.gz" && \
  tar xf \
-  /tmp/heimdall.tar.gz -C \
+ /tmp/heimdall.tar.gz -C \
-  /tmp && \
+	/var/www/localhost/heimdall --strip-components=1 && \
- cp -R /tmp/Heimdall-*/* /app/heimdall/ && \
  echo "** cleanup **" && \
  rm -rf \
-  /tmp/*
+ /tmp/*
 
 # add local files
 COPY root/ /

README.md

@@ -13,7 +13,7 @@ The [LinuxServer.io][linuxserverurl] team brings you another container release f
 * [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
 
 # linuxserver/heimdall
-[![](https://images.microbadger.com/badges/version/linuxserver/nginx.svg)](https://microbadger.com/images/linuxserver/nginx "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/nginx.svg)](https://microbadger.com/images/linuxserver/nginx "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/nginx.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/nginx.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-nginx)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-nginx/)
+[![](https://images.microbadger.com/badges/version/linuxserver/heimdall.svg)](https://microbadger.com/images/linuxserver/heimdall "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/heimdall.svg)](https://microbadger.com/images/linuxserver/heimdall "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/heimdall.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/heimdall.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-heimdall)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-heimdall/)
 
 Heimdall is a way to organise all those links to your most used web sites and web applications in a simple way.
 
@@ -21,7 +21,7 @@ Simplicity is the key to Heimdall.
 
 Why not use it as your browser start page? It even has the ability to include a search bar using either Google, Bing or DuckDuckGo.
 
-[![nginx](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/nginx-banner.png)][appurl]
+[![heimdall](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/heimdall-banner.png)][appurl]
 
 ## Usage
 
@@ -49,7 +49,6 @@ http://192.168.x.x:8080 would show you what's running INSIDE the container on po
 * `-e PGID` for GroupID - see below for explanation
 * `-e PUID` for UserID - see below for explanation
 * `-e TZ` - timezone ie. `America/New_York`
-* `-e BASEURL` - _optional_ - you can set a base url through this variable to serve the app at http://SERVERIP:PORT/BASEURL
 
 It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it heimdall /bin/bash`.
 
@@ -68,6 +67,10 @@ In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as bel
 
 Access the web gui at http://SERVERIP:PORT
 
+## Adding password protection
+
+This image now supports password protection through htpasswd. Run the following command on your host to generate the htpasswd file `docker exec -it heimdall htpasswd -c /config/nginx/.htpasswd <username>`. Replace <username> with a username of your choice and you will be asked to enter a password. New installs will automatically pick it up and implement password protected access. Existing users updating their image can delete their site config at `/config/nginx/site-confs/default` and restart the container after updating the image. A new site config with htpasswd support will be created in its place.
+
 ## Info
 
 * To monitor the logs of the container in realtime `docker logs -f heimdall`.
@@ -83,4 +86,5 @@ Access the web gui at http://SERVERIP:PORT
 
 ## Versions
 
-+ **XX.02.18:** Intial Release.
++ **06.03.18:** Use password protection if htpasswd is set. Existing users can delete their default site config at /config/nginx/site-confs/default and restart the container, a new default site config with htpasswd support will be created in its place
++ **12.02.18:** Initial Release.

root/defaults/default

@@ -1,9 +1,11 @@
+## Version 2018/03/06 - Changelog: https://github.com/linuxserver/docker-heimdall/commits/master/root/defaults/default
+
 server {
 	listen 80 default_server;
 
 	listen 443 ssl;
 
-	root /app/root;
+	root /var/www/localhost/heimdall/public;
 	index index.php index.html index.htm;
 
 	server_name _;
@@ -12,10 +14,21 @@ server {
 	ssl_certificate_key /config/keys/cert.key;
 
 	client_max_body_size 0;
+	
+        error_page 599 = @noauth;
 
-	location / {
+        location / {
-		try_files $uri $uri/ /index.php?$args;
+                if (!-f /config/nginx/.htpasswd) {
-	}
+                        return 599;
+                }
+                auth_basic "Restricted";
+                auth_basic_user_file /config/nginx/.htpasswd;
+                try_files $uri $uri/ /index.php?$args;
+        }
+
+        location @noauth {
+                try_files $uri $uri/ /index.php?$args;
+        }
 
 	location ~ \.php$ {
 		fastcgi_split_path_info ^(.+\.php)(/.+)$;

root/etc/cont-init.d/50-config

@@ -4,27 +4,20 @@
 mkdir -p \
   /config/www/{backgrounds,icons}
 
-# set base url if needed
-rm -rf /app/root
-if [ -z "$BASEURL" ]; then
-  echo "No base url set. You can access the app at http://SERVERIP:PORT"
-  ln -s ./heimdall/public /app/root
-else
-  echo "Setting base url. You can access the app at http://SERVERIP:PORT/$BASEURL"
-  mkdir -p /app/root
-  ln -s ../heimdall/public /app/root/"$BASEURL"
-fi
-
 # symlink user config
-rm -rf \
+
-  /app/heimdall/storage/app/public/backgrounds \
+symlinks=( \
-  /app/heimdall/storage/app/public/icons \
+/var/www/localhost/heimdall/storage/app/public/backgrounds \
-  /app/heimdall/database/app.sqlite
+/var/www/localhost/heimdall/storage/app/public/icons \
-ln -s /config/www/backgrounds /app/heimdall/storage/app/public/backgrounds
+/var/www/localhost/heimdall/database/app.sqlite )
-ln -s /config/www/icons /app/heimdall/storage/app/public/icons
+
-ln -s /config/www/app.sqlite /app/heimdall/database/app.sqlite
+for i in "${symlinks[@]}"
+do
+[[ -e "$i" && ! -L "$i" ]] && rm -rf "$i"
+[[ ! -L "$i" ]] && ln -s /config/www/"$(basename "$i")" "$i"
+done
 
 # permissions
 chown -R abc:abc \
 	/config \
-	/app
+	/var/www/localhost/heimdall