Merge pull request #3 from soffchen/claude/optimize-docker-image-size

Addressing PR comments

Author: soffchen

Dockerfile

@@ -1,21 +1,40 @@
 FROM alpine:edge
 
-RUN echo "http://dl-cdn.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories
-RUN apk update
-RUN apk add --no-cache xvfb x11vnc fluxbox supervisor xterm bash chromium firefox xrdp wqy-zenhei novnc websockify
-
-RUN ln -s /usr/share/novnc/vnc_lite.html /usr/share/novnc/index.html
+# Add testing repository and update
+RUN echo "http://dl-cdn.alpinelinux.org/alpine/edge/testing" >> /etc/apk/repositories && \
+    apk update && \
+    # Install minimal required packages
+    apk add --no-cache \
+        xvfb \
+        x11vnc \
+        fluxbox \
+        supervisor \
+        firefox \
+        xrdp \
+        novnc \
+        websockify && \
+    # Clean up
+    rm -rf /var/cache/apk/* /tmp/* && \
+    # Create noVNC symlink
+    ln -s /usr/share/novnc/vnc_lite.html /usr/share/novnc/index.html
 
+# Copy configuration files
 ADD supervisord.conf /etc/supervisord.conf
 ADD xrdp.ini /etc/xrdp/xrdp.ini
 ADD menu /root/.fluxbox/menu
 ADD entry.sh /entry.sh
 
 RUN chmod +x /entry.sh
 
-ENV DISPLAY :0
+# Environment variables
+ENV DISPLAY=:0
 ENV RESOLUTION=1024x768
+ENV ENABLE_VNC=true
+ENV ENABLE_RDP=true
+ENV ENABLE_NOVNC=true
+ENV AUTOSTART_FIREFOX=true
 
-EXPOSE 5901 6901
+# Expose ports: VNC (5901), noVNC (6901), RDP (3389)
+EXPOSE 5901 6901 3389
 
-ENTRYPOINT ["/bin/bash", "-c", "/entry.sh"]
+ENTRYPOINT ["/entry.sh"]

README.md

@@ -1,38 +1,64 @@
-# Alpine docker container image with "headless" VNC/RDP environments
+# Tiny Remote Desktop
 
-Installed with the following components:
+Alpine-based Docker container with "headless" VNC/RDP remote desktop environments.
 
-* Desktop environment [**Fluxbox**](http://fluxbox.org)
-* xrdp server (default RDP port `3389`)
-* vnc server (default VNC port `5901`)
-* [**noVNC**](https://github.com/novnc/noVNC) - HTML5 VNC client (default http port `6901`)
-* Browsers:
-  * Chromium
-  * Firefox
-  
+## Features
 
-## Current provided OS & UI sessions:
+* Desktop environment: [**Fluxbox**](http://fluxbox.org) (lightweight)
+* VNC server: **x11vnc** (port `5901`)
+* RDP server: **xrdp** (port `3389`)
+* Web VNC: [**noVNC**](https://github.com/novnc/noVNC) - HTML5 VNC client (port `6901`)
+* Browser: **Firefox**
+* **Configurable**: Enable/disable services via environment variables
+* **Auto-start**: Firefox can auto-launch on startup
 
-* `soff/tiny-remote-desktop`: __Alpine with `Fluxbox` UI session__
+## Image Size Optimization
 
+### Current Size: ~300-350MB
 
-## Usage
+The image has been optimized by removing unnecessary packages:
+- ❌ **Chromium** (~200MB) - Removed to reduce size
+- ❌ **xterm** - Removed (not essential)
+- ❌ **bash** - Using Alpine's built-in `sh`
+- ❌ **wqy-zenhei** (Chinese fonts) - Removed
 
-- Run command with mapping to local port `5901` (vnc protocol) and `6901` (vnc web access):
+### Further Size Reduction
 
-      docker run -d -p 5901:5901 -p 6901:6901 soff/tiny-remote-desktop
+If you need an even smaller image:
 
-- Run command with mapping to local port `3389` (rdp protocol):
+1. **Remove Firefox** (~100MB saved):
+   ```dockerfile
+   # Remove 'firefox' from line 12 in Dockerfile
+   # Set AUTOSTART_FIREFOX=false
+   # Final size: ~200-250MB
+   ```
 
-      docker run -d -p 3389:3389 soff/tiny-remote-desktop
+2. **Remove noVNC** (~10-20MB saved):
+   ```dockerfile
+   # Remove 'novnc' and 'websockify' from Dockerfile
+   # Set ENABLE_NOVNC=false
+   ```
 
-- Run command with mapping to local port `5901` (vnc protocol) and `6901` (vnc web access) with access password:
+3. **VNC-only setup** (~150-200MB):
+   ```dockerfile
+   # Keep only: xvfb, x11vnc, fluxbox, supervisor
+   # Remove: firefox, xrdp, novnc, websockify
+   ```
 
-      docker run -d -p 5901:5901 -p 6901:6901 -e VNC_PASSWORD="vncpassword" soff/tiny-remote-desktop
+## VNC vs RDP - Which is Faster?
 
-- Run command with mapping to local port `5901` (vnc protocol) and `6901` (vnc web access) with specific resolution:
+### VNC (Recommended) ✅
+- **Faster** for local/LAN connections
+- Lower latency and overhead
+- Direct connection without additional layers
+- **Best choice for this setup**
 
-      docker run -d -p 5901:5901 -p 6901:6901 -e RESOLUTION=1600x1200 soff/tiny-remote-desktop
+### RDP
+- Better for slow/WAN connections (better compression)
+- In this setup, RDP wraps VNC (adds overhead)
+- Use VNC directly for better performance
+
+**Verdict**: **VNC is faster** - RDP just adds an extra layer in this configuration.
 
 ## Automated Builds
 
@@ -51,7 +77,139 @@ To enable automated builds, the following secrets must be configured in the repo
 - `DOCKERHUB_USERNAME`: Your Docker Hub username
 - `DOCKERHUB_TOKEN`: Your Docker Hub access token (create one at https://hub.docker.com/settings/security)
 
-## Hints
-
-### 1) No start menu?
-Just right click on desktop, the start menu will pop up.
+## Configuration
+
+### Environment Variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `RESOLUTION` | `1024x768` | Screen resolution |
+| `VNC_PASSWORD` | (none) | VNC password (optional) |
+| `ENABLE_VNC` | `true` | Enable VNC server |
+| `ENABLE_RDP` | `true` | Enable RDP server |
+| `ENABLE_NOVNC` | `true` | Enable web-based VNC |
+| `AUTOSTART_FIREFOX` | `true` | Auto-start Firefox |
+
+### Ports
+
+| Port | Protocol | Description |
+|------|----------|-------------|
+| 5901 | VNC | Direct VNC access |
+| 6901 | HTTP | noVNC web interface |
+| 3389 | RDP | Remote Desktop Protocol |
+
+## Usage Examples
+
+### Default Setup (All Services)
+```bash
+docker run -d \
+  -p 5901:5901 \
+  -p 6901:6901 \
+  -p 3389:3389 \
+  --name remote-desktop \
+  soff/tiny-remote-desktop
+```
+
+Access via:
+- VNC client: `localhost:5901`
+- Web browser: `http://localhost:6901`
+- RDP client: `localhost:3389`
+
+### VNC-Only (Fastest, Smallest)
+```bash
+docker run -d \
+  -p 5901:5901 \
+  -e ENABLE_RDP=false \
+  -e ENABLE_NOVNC=false \
+  --name remote-desktop \
+  soff/tiny-remote-desktop
+```
+
+### RDP-Only
+```bash
+docker run -d \
+  -p 3389:3389 \
+  -e ENABLE_VNC=false \
+  -e ENABLE_NOVNC=false \
+  --name remote-desktop \
+  soff/tiny-remote-desktop
+```
+
+### With VNC Password
+```bash
+docker run -d \
+  -p 5901:5901 \
+  -p 6901:6901 \
+  -e VNC_PASSWORD="vncpassword" \
+  --name remote-desktop \
+  soff/tiny-remote-desktop
+```
+
+### Custom Resolution
+```bash
+docker run -d \
+  -p 5901:5901 \
+  -p 6901:6901 \
+  -e RESOLUTION=1920x1080 \
+  --name remote-desktop \
+  soff/tiny-remote-desktop
+```
+
+### Without Firefox Auto-Start
+```bash
+docker run -d \
+  -p 5901:5901 \
+  -e AUTOSTART_FIREFOX=false \
+  --name remote-desktop \
+  soff/tiny-remote-desktop
+```
+
+## Troubleshooting
+
+### "Another user already login with this id" Error
+
+**Fixed!** This error has been resolved by:
+- Adding `-forever` flag to x11vnc
+- Proper service startup priorities
+- Correct DISPLAY environment configuration
+
+If you still see this error:
+1. Ensure only one container instance is running
+2. Restart the container: `docker restart <container_name>`
+3. Check logs: `docker logs <container_name>`
+
+### RDP Auto-Login
+
+When connecting via RDP:
+- Username: `root` (pre-filled)
+- Password: (leave empty, press Enter)
+- Session: `Xvnc` (pre-selected)
+- Just click **OK** or press Enter
+
+For completely password-free access, use VNC directly (port 5901).
+
+### Firefox Auto-Start
+
+Firefox auto-starts when `AUTOSTART_FIREFOX=true` (default).
+
+If Firefox doesn't start:
+1. Check logs: `docker logs <container_name>`
+2. Start manually from Fluxbox menu (right-click desktop)
+3. Verify startup script exists:
+   ```bash
+   docker exec <container_name> cat /root/.fluxbox/startup
+   ```
+
+### No Start Menu?
+
+Right-click anywhere on the desktop to open the Fluxbox menu.
+
+## Building
+
+```bash
+docker build -t tiny-remote-desktop .
+```
+
+## License
+
+This project does not yet include a formal license file. All rights are reserved by the maintainer unless otherwise stated. Please contact the maintainer for usage permissions.

entry.sh

@@ -1,7 +1,45 @@
 #!/bin/sh
 
+# Configure VNC password if provided (idempotent using -rfbauth)
 if [ "$VNC_PASSWORD" ]; then
-    sed -i "s/^\(command.*x11vnc.*\)$/\1 -passwd '$VNC_PASSWORD'/" /etc/supervisord.conf
+    VNC_PASSFILE="/root/.vncpass"
+    x11vnc -storepasswd "$VNC_PASSWORD" "$VNC_PASSFILE"
+    chmod 600 "$VNC_PASSFILE"
+    # Make the change idempotent: remove any existing -passwd, -rfbauth, or -nopw args on the x11vnc command
+    sed -i \
+        -e '/command.*x11vnc/ s/ -passwd [^ ]*//g' \
+        -e '/command.*x11vnc/ s/ -rfbauth [^ ]*//g' \
+        -e '/command.*x11vnc/ s/ -nopw//g' \
+        /etc/supervisord.conf
+    # Append the auth file option to the x11vnc command
+    sed -i "s|^\(command.*x11vnc.*\)$|\1 -rfbauth ${VNC_PASSFILE}|" /etc/supervisord.conf
 fi
 
-/usr/bin/supervisord
+# Ensure noVNC is not enabled when VNC is disabled
+if [ "$ENABLE_NOVNC" = "true" ] && [ "$ENABLE_VNC" != "true" ]; then
+    echo "Warning: ENABLE_NOVNC=true requires ENABLE_VNC=true; disabling noVNC."
+    ENABLE_NOVNC="false"
+fi
+
+# Disable services based on environment variables
+if [ "$ENABLE_VNC" != "true" ]; then
+    sed -i '/\[program:x11vnc\]/,/^$/d' /etc/supervisord.conf
+fi
+
+if [ "$ENABLE_RDP" != "true" ]; then
+    sed -i '/\[program:xrdp\]/,/^$/d' /etc/supervisord.conf
+fi
+
+if [ "$ENABLE_NOVNC" != "true" ]; then
+    sed -i '/\[program:novnc\]/,/^$/d' /etc/supervisord.conf
+fi
+
+# Configure Firefox autostart
+if [ "$AUTOSTART_FIREFOX" = "true" ]; then
+    mkdir -p /root/.fluxbox
+    echo "firefox &" > /root/.fluxbox/startup
+    echo "exec fluxbox" >> /root/.fluxbox/startup
+    chmod +x /root/.fluxbox/startup
+fi
+
+exec /usr/bin/supervisord

menu

@@ -16,14 +16,9 @@
 #     session.menuFile: ~/.fluxbox/my-menu
 [begin] (Fluxbox-1.3.7)
 [encoding] {UTF-8}
-      [exec] (Xterm) {xterm}
-      [exec] (Chromium) {chromium-browser --no-sandbox}
       [exec] (Firefox) {firefox}
-[submenu] (Editors)
-      [exec]   (vi) {xterm -e vi}
-[end]
 [submenu] (System Tools)
-      [exec]   (top) {xterm -e top}
+      [nop]    (top (no terminal available))
 [end]
 [submenu] (Fluxbox menu)
       [config] (Configure)

supervisord.conf

@@ -2,32 +2,28 @@
 nodaemon=true
 
 [program:X11]
-command=/usr/bin/Xvfb :0 -screen 0 %(ENV_RESOLUTION)sx24
+command=/usr/bin/Xvfb %(ENV_DISPLAY)s -screen 0 %(ENV_RESOLUTION)sx24
 autorestart=true
+priority=10
 
 [program:x11vnc]
-command=/usr/bin/x11vnc -xkb -noxrecord -noxfixes -noxdamage -display :0 -nopw -wait 5 -shared -permitfiletransfer -tightfilexfer -rfbport 5901
+command=/usr/bin/x11vnc -xkb -noxrecord -noxfixes -noxdamage -display %(ENV_DISPLAY)s -forever -wait 5 -shared -permitfiletransfer -tightfilexfer -rfbport 5901
 autorestart=true
+priority=20
 
 [program:novnc]
 command=/usr/bin/novnc_server --vnc localhost:5901 --listen 6901
 autorestart=true
+priority=30
 
 [program:fluxbox]
 command=/usr/bin/fluxbox
 autorestart=true
-
-[program:xterm]
-command=/usr/bin/xterm
-autorestart=false
-startretries = 1
+priority=40
+environment=DISPLAY="%(ENV_DISPLAY)s"
 
 [program:xrdp]
-command=/usr/sbin/xrdp
+command=/usr/sbin/xrdp -n
 autorestart=true
-startretries = 1
-
-[program:chromium]
-command=/usr/bin/chromium-browser --no-sandbox
-autorestart=false
-startretries = 1
+startretries=3
+priority=50