Merge pull request #7 from jens-maus/optimizations

Add more fine-tuned service autostart and command options behaviour

Author: MRColorR

README.md

@@ -14,7 +14,7 @@ This Docker image encapsulates a lightweight, VNC-accessible web browsing enviro
 
 - **VNC-Ready**: Ready for use with any VNC client or through a web browser using noVNC, offering a user-friendly interface.
 - **Lightweight**: Built on Alpine Linux and Debian Slim, ensuring minimal resource usage.
-- **Customizable**: Set VNC password, initial website URL, auto-start settings for the browser and xterm via environment variables.
+- **Customizable**: Set VNC password, initial website URL, auto-start settings, etc. via environment variables to build custom environments (e.g. webkiosk)
 - **Accessible**: Access the VNC server directly or through a browser using noVNC.
 
 ## Available images 📦
@@ -54,6 +54,16 @@ You can customize the settings of the Docker container by passing environment va
 - Setting the resolution: `VNC_RESOLUTION="1280x720"`
 - Enabling/disabling auto-start for the browser: `AUTO_START_BROWSER=true` or `AUTO_START_BROWSER=false`
 - Enabling/disabling auto-start for xterm: `AUTO_START_XTERM=true` or `AUTO_START_XTERM=false`
+- Enabling/disabling auto-start for window manager (fluxbox): `AUTO_START_WM=true` or `AUTO_START_WM=false`
+- Enabling/disabling auto-start for x11vnc: `AUTO_START_X11VNC=true` or `AUTO_START_X11VNC=false`
+- Enabling/disabling auto-start for xvfb: `AUTO_START_XVFB=true` or `AUTO_START_XVFB=false`
+- Enabling/disabling auto-start for noVNC (websockify): `AUTO_START_NOVNC=true` or `AUTO_START_NOVNC=false`
+- Adding command options for browser: `BROWSER_OPTIONS="--start-fullscreen --kiosk --incognito --noerrdialogs --no-first-run --disk-cache-dir=/dev/null"`
+- Adding command options for x11vnc: `X11VNC_OPTIONS="-nocursor"`
+- Adding command options for xvfb: `XVFB_OPTIONS="-nocursor"`
+- Adding command options for window manager (fluxbox): `WM_OPTIONS="-rc /app/fluxbox.conf"`
+- Adding command options for noVNC (websockify): `NOVNC_OPTIONS="--heartbeat=10"`
+- Adding command options for xterm: `XTERM_OPTIONS="-leftbar"`
 
 ### Available Variables ⚙️
 - `VNC_SCREEN` (default: `0`): Screen number for VNC.
@@ -68,8 +78,18 @@ You can customize the settings of the Docker container by passing environment va
 - `CUSTOMIZE` (default: `false`): Toggle for running custom scripts.
 - `AUTO_START_BROWSER` (default: `true`): Automatically start the browser.
 - `AUTO_START_XTERM` (default: `true`): Automatically start xterm.
+- `AUTO_START_WM` (default: `true`): Automatically start window manager (fluxbox).
+- `AUTO_START_X11VNC` (default: `true`): Automatically start x11vnc.
+- `AUTO_START_XVFB` (default: `true`): Automatically start xvfb.
+- `AUTO_START_NOVNC` (default: `true`): Automatically start noVNC (websockify).
 - `CUSTOM_ENTRYPOINTS_DIR` (default: `/app/custom_entrypoints_scripts`): Directory for custom entry point scripts.
 - `DEBIAN_FRONTEND` (default: `noninteractive`): Frontend setting for Debian-based installations.
+- `BROWSER_OPTIONS` (default: ``): Additional command options to provide to browser start.
+- `X11VNC_OPTIONS` (default: ``): Additional command options to provide to x11vnc start.
+- `XVFB_OPTIONS` (default: ``): Additional command options to provide to xvfb start.
+- `WM_OPTIONS` (default: ``): Additional command options to provide to windows manager (fluxbox) start.
+- `NOVNC_OPTIONS` (default: ``): Additional command options to provide to noVNC (websockify) start.
+- `XTERM_OPTIONS` (default: ``): Additional command options to provide to xterm start.
 
 - Example:
 ```sh

alpine.dockerfile

@@ -15,6 +15,16 @@ ARG DEF_CUSTOMIZE=false
 ARG DEF_CUSTOM_ENTRYPOINTS_DIR=/app/custom_entrypoints_scripts
 ARG DEF_AUTO_START_BROWSER=true
 ARG DEF_AUTO_START_XTERM=true
+ARG DEF_AUTO_START_WM=true
+ARG DEF_AUTO_START_X11VNC=true
+ARG DEF_AUTO_START_XVFB=true
+ARG DEF_AUTO_START_NOVNC=true
+ARG DEF_BROWSER_OPTIONS=
+ARG DEF_X11VNC_OPTIONS=
+ARG DEF_XVFB_OPTIONS=
+ARG DEF_WM_OPTIONS=
+ARG DEF_NOVNC_OPTIONS=
+ARG DEF_XTERM_OPTIONS=
 
 # Set environment variables with default values
 ENV DISPLAY=:${DEF_VNC_DISPLAY}.${DEF_VNC_SCREEN} \
@@ -30,7 +40,17 @@ ENV DISPLAY=:${DEF_VNC_DISPLAY}.${DEF_VNC_SCREEN} \
     CUSTOMIZE=${DEF_CUSTOMIZE} \
     CUSTOM_ENTRYPOINTS_DIR=${DEF_CUSTOM_ENTRYPOINTS_DIR} \
     AUTO_START_BROWSER=${DEF_AUTO_START_BROWSER} \
-    AUTO_START_XTERM=${DEF_AUTO_START_XTERM} 
+    AUTO_START_XTERM=${DEF_AUTO_START_XTERM} \
+    AUTO_START_WM=${DEF_AUTO_START_WM} \
+    AUTO_START_X11VNC=${DEF_AUTO_START_X11VNC} \
+    AUTO_START_XVFB=${DEF_AUTO_START_XVFB} \
+    AUTO_START_NOVNC=${DEF_AUTO_START_NOVNC} \
+    BROWSER_OPTIONS=${DEF_BROWSER_OPTIONS} \
+    X11VNC_OPTIONS=${DEF_X11VNC_OPTIONS} \
+    XVFB_OPTIONS=${DEF_XVFB_OPTIONS} \
+    WM_OPTIONS=${DEF_WM_OPTIONS} \
+    NOVNC_OPTIONS=${DEF_NOVNC_OPTIONS} \
+    XTERM_OPTIONS=${DEF_XTERM_OPTIONS}
 
 # Install necessary packages and setup noVNC
 RUN echo "http://dl-cdn.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories && \

base_entrypoint.sh

@@ -1,9 +1,9 @@
 #!/usr/bin/env bash
 set -e
 
-# Store the password
-if [ "$VNC_PASSWORD" ]; then
-    sed -i "s/^\(command.*x11vnc.*\)$/\1 -passwd '$VNC_PASSWORD'/" /app/conf.d/x11vnc.conf
+# Add password to x11vnc options
+if [ -n "${VNC_PASSWORD}" ]; then
+    X11VNC_OPTIONS="${X11VNC_OPTIONS} -passwd '${VNC_PASSWORD}'"
 fi
 
 # Print current VNC info

browser_conf/chromium.conf

@@ -1,5 +1,5 @@
 [program:chromium]
-command=/usr/bin/chromium --no-sandbox --disable-dev-shm-usage %(ENV_STARTING_WEBSITE_URL)s
+command=/usr/bin/chromium --no-sandbox --disable-dev-shm-usage %(ENV_BROWSER_OPTIONS)s %(ENV_STARTING_WEBSITE_URL)s
 autostart=%(ENV_AUTO_START_BROWSER)s
 autorestart=true
 stdout_logfile=/var/log/chromium.log

browser_conf/firefox.conf

@@ -1,5 +1,5 @@
 [program:firefox]
-command=/usr/bin/firefox %(ENV_STARTING_WEBSITE_URL)s
+command=/usr/bin/firefox %(ENV_BROWSER_OPTIONS)s %(ENV_STARTING_WEBSITE_URL)s
 autostart=%(ENV_AUTO_START_BROWSER)s
 autorestart=true
 stdout_logfile=/var/log/firefox.log

conf.d/fluxbox.conf

@@ -1,6 +1,6 @@
 [program:fluxbox]
-command=fluxbox
-autostart=true
+command=fluxbox %(ENV_WM_OPTIONS)s
+autostart=%(ENV_AUTO_START_WM)s
 autorestart=true
 # stdout_logfile=/var/log/fluxbox.log
-# stderr_logfile=/var/log/fluxbox.err.log
+# stderr_logfile=/var/log/fluxbox.err.log

conf.d/websockify.conf

@@ -1,6 +1,6 @@
 [program:websockify]
-command=websockify --web=/usr/share/novnc/ %(ENV_NOVNC_WEBSOCKIFY_PORT)s localhost:%(ENV_VNC_PORT)s
-autostart=true
+command=websockify --web=/usr/share/novnc/ %(ENV_NOVNC_OPTIONS)s %(ENV_NOVNC_WEBSOCKIFY_PORT)s localhost:%(ENV_VNC_PORT)s
+autostart=%(ENV_AUTO_START_NOVNC)s
 autorestart=true
 # stdout_logfile=/var/log/websockify.log
-# stderr_logfile=/var/log/websockify.err.log
+# stderr_logfile=/var/log/websockify.err.log

conf.d/x11vnc.conf

@@ -1,6 +1,6 @@
 [program:x11vnc]
-command=x11vnc -display :%(ENV_VNC_DISPLAY)s.%(ENV_VNC_SCREEN)s -forever -usepw -shared -rfbport %(ENV_VNC_PORT)s
-autostart=true
+command=x11vnc -display :%(ENV_VNC_DISPLAY)s.%(ENV_VNC_SCREEN)s -forever -usepw -shared -rfbport %(ENV_VNC_PORT)s %(ENV_X11VNC_OPTIONS)s
+autostart=%(ENV_AUTO_START_X11VNC)s
 autorestart=true
 # stdout_logfile=/var/log/x11vnc.log
-# stderr_logfile=/var/log/x11vnc.err.log
+# stderr_logfile=/var/log/x11vnc.err.log

conf.d/xterm.conf

@@ -1,5 +1,5 @@
 [program:xterm]
-command=/usr/bin/xterm
+command=/usr/bin/xterm %(ENV_XTERM_OPTIONS)s
 autostart=%(ENV_AUTO_START_XTERM)s
 autorestart=true
 stdout_logfile=/var/log/xterm.log

conf.d/xvfb.conf

@@ -1,6 +1,6 @@
 [program:xvfb]
-command=Xvfb :%(ENV_VNC_DISPLAY)s -screen %(ENV_VNC_SCREEN)s %(ENV_VNC_RESOLUTION)sx24 -listen tcp -ac
-autostart=true
+command=Xvfb :%(ENV_VNC_DISPLAY)s -screen %(ENV_VNC_SCREEN)s %(ENV_VNC_RESOLUTION)sx24 -listen tcp -ac %(ENV_XVFB_OPTIONS)s
+autostart=%(ENV_AUTO_START_XVFB)s
 autorestart=true
 # stdout_logfile=/var/log/xvfb.log
-# stderr_logfile=/var/log/xvfb.err.log
+# stderr_logfile=/var/log/xvfb.err.log