Added debug mode

Author: jaydrogers

README.md

@@ -58,12 +58,13 @@ All variables are documented here:
 :-----:|:-----:|:-----:
 PUID|User ID the SSH user should run as.|9999
 PGID|Group ID the SSH user should run as.|9999
+DEBUG\_MODE|Display a bunch of helpful content for debugging.|false
 SSH\_USER|Username for the SSH user that other users will connect into as.|tunnel
 SSH\_GROUP|Group name used for our SSH user.|tunnelgroup
-SSH\_USER\_HOME|Home location of the SSH user.|/home/`$SSH_USER`
+SSH\_USER\_HOME|Home location of the SSH user.|/home/$SSH\_USER
 SSH\_PORT|Listening port for SSH server (on container only. You'll still need to publish this port).|2222
 SSH\_HOST\_KEY\_DIR|Location of where the SSH host keys should be stored.|/etc/ssh/ssh\_host\_keys/
-AUTHORIZED\_KEYS|🚨 <b>Required to be set</b> (if there isn't a `$SSH_USER_HOME/.ssh/authorized_keys` file provided). [See below]| 
+AUTHORIZED\_KEYS|🚨 <b>Required to be set by you.</b> Content of your authorized keys file (see below)| 
 ALLOWED\_IPS|🚨 <b>Required to be set by you.</b> Content of allowed IP addresses (see below)| 
 
 

src/Dockerfile

@@ -19,6 +19,7 @@ ENV DEBIAN_FRONTEND=noninteractive \
     SSH_GROUP="tunnelgroup" \
     SSH_PORT="2222" \
     SSH_HOST_KEY_DIR="/etc/ssh/ssh_host_keys" \
+    DEBUG_MODE="false" \
     LC_ALL="en_US.UTF-8" \
     LANG="en_US.UTF-8" \
     LANGUAGE="en_US.UTF-8"

src/etc/s6-overlay/scripts/generate-ssh-keys

@@ -1,5 +1,9 @@
 #!/command/with-contenv bash
 
+if [ $DEBUG_MODE == true ]; then
+    set -x
+fi
+
 # Check if SSH host keys are missing
 if [ ! -f $SSH_HOST_KEY_DIR/ssh_host_* ]; then
   echo "🏃‍♂️ Generating SSH keys for you..."

src/etc/s6-overlay/scripts/prep-ssh-server

@@ -1,4 +1,7 @@
 #!/command/with-contenv bash
+if [ $DEBUG_MODE == true ]; then
+    set -x
+fi
 
 SSH_USER_HOME="${SSH_USER_HOME:-"/home/$SSH_USER"}"
 
@@ -25,6 +28,14 @@ echo "🤖 Setting SSHD configuration..."
   echo "HostKey ${SSH_HOST_KEY_DIR}/ssh_host_ed25519_key"
 } > /etc/ssh/sshd_config.d/custom.conf
 
+if [ $DEBUG_MODE == true ]; then
+  echo "🔥🔥🔥 Putting SSH server into Debug Mode..."
+  {
+      echo "SyslogFacility AUTHPRIV"
+      echo "LogLevel DEBUG"
+  } >> /etc/ssh/sshd_config.d/custom.conf
+fi
+
 # Make the SSH directory 
 mkdir -p $SSH_USER_HOME/.ssh/
 

src/etc/s6-overlay/scripts/runas-user

@@ -1,5 +1,9 @@
 #!/command/with-contenv bash
 
+if [ $DEBUG_MODE == true ]; then
+    set -x
+fi
+
 SSH_USER_HOME="${SSH_USER_HOME:-"/home/$SSH_USER"}"
 
 # Create our SSH user