This repository was archived by the owner on May 15, 2025. It is now read-only.
fix(kasmvnc): optimize KasmVNC deployment script #329
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # Exit on error, undefined variables, and pipe failures | ||
| set -euo pipefail | ||
|
|
||
| # Function to check if vncserver is already installed | ||
| check_installed() { | ||
|
|
@@ -14,166 +15,221 @@ check_installed() { | |
|
|
||
| # Function to download a file using wget, curl, or busybox as a fallback | ||
| download_file() { | ||
| local url="$1" | ||
| local output="$2" | ||
| local download_tool | ||
|
|
||
| if command -v curl &> /dev/null; then | ||
| # shellcheck disable=SC2034 | ||
| download_tool=(curl -fsSL) | ||
| elif command -v wget &> /dev/null; then | ||
| # shellcheck disable=SC2034 | ||
| download_tool=(wget -q -O-) | ||
| elif command -v busybox &> /dev/null; then | ||
| # shellcheck disable=SC2034 | ||
| download_tool=(busybox wget -O-) | ||
| else | ||
| echo "ERROR: No download tool available (curl, wget, or busybox required)" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # shellcheck disable=SC2288 | ||
| "$${download_tool[@]}" "$url" > "$output" || { | ||
| echo "ERROR: Failed to download $url" | ||
| exit 1 | ||
| } | ||
| } | ||
|
|
||
| # Function to install kasmvncserver for debian-based distros | ||
| install_deb() { | ||
| local url=$1 | ||
| local kasmdeb="/tmp/kasmvncserver.deb" | ||
|
|
||
| download_file "$url" "$kasmdeb" | ||
|
|
||
| CACHE_DIR="/var/lib/apt/lists/partial" | ||
| # Check if the directory exists and was modified in the last 60 minutes | ||
| if [[ ! -d "$CACHE_DIR" ]] || ! find "$CACHE_DIR" -mmin -60 -print -quit &> /dev/null; then | ||
| echo "Stale package cache, updating..." | ||
| # Update package cache with a 300-second timeout for dpkg lock | ||
| sudo apt-get -o DPkg::Lock::Timeout=300 -qq update | ||
| fi | ||
|
|
||
| DEBIAN_FRONTEND=noninteractive sudo apt-get -o DPkg::Lock::Timeout=300 install --yes -qq --no-install-recommends --no-install-suggests "$kasmdeb" | ||
| rm "$kasmdeb" | ||
| } | ||
|
|
||
| # Function to install kasmvncserver for rpm-based distros | ||
| install_rpm() { | ||
| local url=$1 | ||
| local kasmrpm="/tmp/kasmvncserver.rpm" | ||
| local package_manager | ||
|
|
||
| if command -v dnf &> /dev/null; then | ||
| # shellcheck disable=SC2034 | ||
| package_manager=(dnf localinstall -y) | ||
| elif command -v zypper &> /dev/null; then | ||
| # shellcheck disable=SC2034 | ||
| package_manager=(zypper install -y) | ||
| elif command -v yum &> /dev/null; then | ||
| # shellcheck disable=SC2034 | ||
| package_manager=(yum localinstall -y) | ||
| elif command -v rpm &> /dev/null; then | ||
| # Do we need to manually handle missing dependencies? | ||
| # shellcheck disable=SC2034 | ||
| package_manager=(rpm -i) | ||
| else | ||
| echo "ERROR: No supported package manager available (dnf, zypper, yum, or rpm required)" | ||
| exit 1 | ||
| fi | ||
|
|
||
| download_file "$url" "$kasmrpm" | ||
|
|
||
| # shellcheck disable=SC2288 | ||
| sudo "$${package_manager[@]}" "$kasmrpm" || { | ||
| echo "ERROR: Failed to install $kasmrpm" | ||
| exit 1 | ||
| } | ||
|
|
||
| rm "$kasmrpm" | ||
| } | ||
|
|
||
| # Function to install kasmvncserver for Alpine Linux | ||
| install_alpine() { | ||
| local url=$1 | ||
| local kasmtgz="/tmp/kasmvncserver.tgz" | ||
|
|
||
| download_file "$url" "$kasmtgz" | ||
|
|
||
| tar -xzf "$kasmtgz" -C /usr/local/bin/ | ||
| rm "$kasmtgz" | ||
| } | ||
|
|
||
| # Detect system information | ||
| if [[ ! -f /etc/os-release ]]; then | ||
djarbz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| echo "ERROR: Cannot detect OS: /etc/os-release not found" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # shellcheck disable=SC1091 | ||
| source /etc/os-release | ||
| distro="$ID" | ||
| distro_version="$VERSION_ID" | ||
| codename="$VERSION_CODENAME" | ||
| arch="$(uname -m)" | ||
| if [[ "$ID" == "ol" ]]; then | ||
| distro="oracle" | ||
| distro_version="$${distro_version%%.*}" | ||
| elif [[ "$ID" == "fedora" ]]; then | ||
| distro_version="$(grep -oP '\(\K[\w ]+' /etc/fedora-release | tr '[:upper:]' '[:lower:]' | tr -d ' ')" | ||
| fi | ||
|
|
||
| echo "Detected Distribution: $distro" | ||
| echo "Detected Version: $distro_version" | ||
| echo "Detected Codename: $codename" | ||
| echo "Detected Architecture: $arch" | ||
|
|
||
| # Map arch to package arch | ||
| case "$arch" in | ||
| x86_64) | ||
| if [[ "$distro" =~ ^(ubuntu|debian|kali)$ ]]; then | ||
| arch="amd64" | ||
| fi | ||
| ;; | ||
| aarch64) | ||
| if [[ "$distro" =~ ^(ubuntu|debian|kali)$ ]]; then | ||
| arch="arm64" | ||
| fi | ||
| ;; | ||
| arm64) | ||
| : # This is effectively a noop | ||
| ;; | ||
| *) | ||
| echo "ERROR: Unsupported architecture: $arch" | ||
| exit 1 | ||
| ;; | ||
| esac | ||
|
|
||
| # Check if vncserver is installed, and install if not | ||
| if ! check_installed; then | ||
| # Check for NOPASSWD sudo (required) | ||
| if ! command -v sudo &> /dev/null || ! sudo -n true 2> /dev/null; then | ||
| echo "ERROR: sudo NOPASSWD access required!" | ||
| exit 1 | ||
| fi | ||
|
|
||
| base_url="https://github.com/kasmtech/KasmVNC/releases/download/v${KASM_VERSION}" | ||
|
|
||
| echo "Installing KASM version: ${KASM_VERSION}" | ||
| case $distro in | ||
| ubuntu | debian | kali) | ||
| bin_name="kasmvncserver_$${codename}_${KASM_VERSION}_$${arch}.deb" | ||
| install_deb "$base_url/$bin_name" | ||
| ;; | ||
| oracle | fedora | opensuse) | ||
| bin_name="kasmvncserver_$${distro}_$${distro_version}_${KASM_VERSION}_$${arch}.rpm" | ||
djarbz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| install_rpm "$base_url/$bin_name" | ||
|
There was a problem hiding this comment. We probably need both I'm not sure if this is a script meant for installing the kasmvnc built package or something else, but this at least gives hints for the expectation per distro: https://github.com/kasmtech/KasmVNC/blob/3a8517d7dc461eaccc7ed8e3d3b155e233426fc8/builder/scripts/common.sh#L22-L29 There was a problem hiding this comment. Perhaps in the Priority:
|
||
| ;; | ||
| alpine) | ||
| bin_name="kasmvnc.alpine_$${distro_version//./}_$${arch}.tgz" | ||
| install_alpine "$base_url/$bin_name" | ||
| ;; | ||
| *) | ||
| echo "Unsupported distribution: $distro" | ||
| exit 1 | ||
| ;; | ||
| esac | ||
| else | ||
| echo "vncserver already installed. Skipping installation." | ||
| fi | ||
|
|
||
| if command -v sudo &> /dev/null && sudo -n true 2> /dev/null; then | ||
| kasm_config_file="/etc/kasmvnc/kasmvnc.yaml" | ||
|
There was a problem hiding this comment. Do we need There was a problem hiding this comment. I have not run into the need for it. |
||
| SUDO=sudo | ||
| else | ||
| kasm_config_file="$HOME/.vnc/kasmvnc.yaml" | ||
| SUDO= | ||
|
|
||
| echo "WARNING: Sudo access not available, using user config dir!" | ||
|
|
||
| if [[ -f "$kasm_config_file" ]]; then | ||
| echo "WARNING: Custom user KasmVNC config exists, not overwriting!" | ||
| echo "WARNING: Ensure that you manually configure the appropriate settings." | ||
| kasm_config_file="/dev/stderr" | ||
djarbz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| else | ||
| echo "WARNING: This may prevent custom user KasmVNC settings from applying!" | ||
| mkdir -p "$HOME/.vnc" | ||
| fi | ||
| fi | ||
|
|
||
| echo "Writing KasmVNC config to $kasm_config_file" | ||
| $SUDO tee "$kasm_config_file" > /dev/null << EOF | ||
| network: | ||
| protocol: http | ||
| websocket_port: ${PORT} | ||
| ssl: | ||
| require_ssl: false | ||
| pem_certificate: | ||
| pem_key: | ||
| udp: | ||
| public_ip: 127.0.0.1 | ||
| EOF | ||
|
|
||
| # This password is not used since we start the server without auth. | ||
| # The server is protected via the Coder session token / tunnel | ||
| # and does not listen publicly | ||
| echo -e "password\npassword\n" | vncpasswd -wo -u "$USER" | ||
|
|
||
| # Start the server | ||
| printf "🚀 Starting KasmVNC server...\n" | ||
| vncserver -select-de "${DESKTOP_ENVIRONMENT}" -disableBasicAuth > /tmp/kasmvncserver.log 2>&1 & | ||
| pid=$! | ||
|
|
||
| # Wait for server to start | ||
| sleep 5 | ||
| grep -v '^[[:space:]]*$' /tmp/kasmvncserver.log | tail -n 10 | ||
| if ps -p $pid | grep -q "^$pid"; then | ||
| echo "ERROR: Failed to start KasmVNC server. Check full logs at /tmp/kasmvncserver.log" | ||
| exit 1 | ||
| fi | ||
| printf "🚀 KasmVNC server started successfully!\n" | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.