rod.wright/OpenKiosk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity

cleanups

Browse Source
This commit is contained in:
Rod Wright
2026-02-26 11:28:16 -05:00
parent 41e389fac9
commit fb023135f2
3 changed files with 488 additions and 361 deletions
Download Patch File Download Diff File Expand all files Collapse all files

402
kiosk-setup.sh
View File

@@ -2,7 +2,7 @@
# kiosk-setup.sh
# OpenKiosk Browser Terminal Setup
# Copyright (C) 2024 Rod Wright
# Copyright (C) 2026 Rod Wright
# SPDX-License-Identifier: GPL-2.0
@@ -41,71 +41,25 @@ function disable_unattended_upgrades() {
done
}
# -------------- Begin execution --------------
privilege_check
echo ""
echo " Welcome to $APP_NAME $APP_VERSION installation"
echo ""
echo ""
echo "This script will configure a Debian based system to be a kiosk browser terminal."
echo ""
echo ""
continueok=false
while ! $continueok
do
read -p "Would you like to continue with OpenKiosk setup [Y/n]: " -r continueok
if [[ $continueok == "n" || $continueok == "N" ]]
function update_os() {
# Make sure OS is up to date
echo "Updating Operating System..."
sleep 5
if apt-get update && apt-get dist-upgrade -y
then
exit 1
elif [[ $continueok == "y" || $continueok == "Y" || $continueok == "" ]]
then
continueok=true
echo "Continuing with OpenKiosk setup."
else
continueok=false
echo "Please answer Y (default) or N."
fi
done
echo ""
echo "Preparing for installation. Please wait..."
disable_unattended_upgrades
# Determine OS Release version
echo -n "OS information: "
echo ""
cat /etc/os-release
echo ""
sleep 5
# Copy in the needed files
echo "Copying files..."
chmod +x usr/local/bin/*
cp -Rvf etc/* /etc/
cp -vf usr/local/bin/* /usr/local/bin
cp -vf lib/systemd/system/getty@tty1.service /lib/systemd/system
rm /lib/systemd/system/ctrl-alt-del.target
ln -s /dev/null /lib/systemd/system/ctrl-alt-del.target
echo "...done."
# Make sure OS is up to date
echo "Updating Operating System..."
sleep 5
if apt-get update && apt-get dist-upgrade -y
then
echo "...done."
echo ""
else
else
echo "A problem was encountered during installation."
echo "the command that failed was:"
echo " apt-get update && apt-get dist-upgrade -y"
abort_exit
fi
fi
}
# Remove snap if installed
if snap list >/dev/null 2>&1; then
function remove_snap() {
# Remove snap if installed
if snap list >/dev/null 2>&1; then
echo "Removing snap..."
snap remove lxd
snap remove core20
@@ -121,19 +75,10 @@ if snap list >/dev/null 2>&1; then
rm -rf /var/snap
rm -rf /var/lib/snapd
echo "...done."
fi
fi
}
# Install packages
echo ""
echo ""
echo "Installing required kiosk packages..."
sleep 5
echo ""
# If we are on a Raspberry Pi 5, we'll need to install this for the
# xorg server to start
if cat /proc/cpuinfo|grep -q "Raspberry Pi 5" >/dev/null 2>&1
then
function install_rpi5_gl() {
echo "Installing gl driver for Raspberry Pi 5..."
if apt-get install -y gldriver-test
then
@@ -145,26 +90,30 @@ then
echo " apt-get install -y gldriver-test"
abort_exit
fi
fi
}
# Install X server
echo "Installing X server..."
if apt-get install -y --no-install-recommends xorg openbox xterm xpdf
then
function install_x_server() {
# Install X server
echo "Installing X server..."
if apt-get install -y --no-install-recommends xorg openbox xterm xpdf
then
echo "...done."
systemctl enable getty@tty1.service
echo ""
else
else
echo "A problem was encountered during installation."
echo "the command that failed was:"
echo " apt-get install -y --no-install-recommends xorg openbox"
abort_exit
fi
fi
}
# Try to install chromium-browser package, but if that fails, add
# repository and install chromium package
while ! apt-get install -y chromium
do
function install_chromium() {
# Try to install chromium-browser package, but if that fails, add
# repository and install chromium package
echo "Installing chromium..."
while ! apt-get install -y chromium
do
if add-apt-repository ppa:xtradeb/apps -y
then
echo "added chromium repository"
@@ -172,22 +121,25 @@ do
else
echo "A problem was encountered during installation."
echo "the command that failed was:"
echo " apt-get install -y gldriver-test"
echo " add-apt-repository ppa:xtradeb/apps -y"
abort_exit
fi
apt-get update
done
done
echo "...done."
}
# Check for webmin installation and prompt for install
echo ""
echo "Checking for webmin installation..."
echo ""
if dpkg -l|grep webmin >/dev/null 2>&1
then
function install_webmin() {
# Check for webmin installation and prompt for install
echo ""
echo "Checking for webmin installation..."
echo ""
if dpkg -l|grep webmin >/dev/null 2>&1
then
echo ""
echo "webmin is installed. Continuing."
echo ""
else
else
echo "webmin doesn't seem to be installed."
echo "It is an optional package that enables system administration"
echo "using a friendly GUI. It is highly recommended, especially for"
@@ -237,7 +189,7 @@ else
echo "using self-signed certs. This is not necessarily a problem, but"
echo "your browser will complain. You can tell the browser to accept the"
echo "self signed certificates and the traffic will still be encrypted,"
echo "however you may be vulnerable to man-in-the-middle attacks. You can"
echo "but you may be vulnerable to man-in-the-middle attacks. You can"
echo "get free valid certificates through LetsEncrypt."
echo "See http://letsencrypt.org for more information."
echo ""
@@ -249,20 +201,21 @@ else
sleep 3
fi
fi
fi
}
# Prompt whether to install print server
echo ""
echo "Checking for cups print server and driver installation..."
echo ""
if dpkg -l|grep cups-common >/dev/null 2>&1 && \
test -f "/usr/share/cups/drv/brlaser.drv" >/dev/null 2>&1
then
function install_cups() {
# Prompt whether to install print server
echo ""
echo "Checking for cups print server and driver installation..."
echo ""
if dpkg -l|grep cups-common >/dev/null 2>&1
then
echo ""
echo "cups is installed. Continuing."
echo ""
else
echo "The cups print server or driver doesn't seem to be installed."
else
echo "The cups print server doesn't seem to be installed."
echo "If this will be an interactive kiosk and you would like to"
echo "be able to print from it, cups will need to be installed."
read -p "Install it now? [Y/n]: " -r reqinstall
@@ -275,10 +228,8 @@ else
echo ""
sleep 3
echo "Installing cups print server and drivers..."
apt-get install -y cups libcups2-dev cmake
cd brlaser-master && cmake . && make && make install && cd ..
chmod -R a+w brlaser-master
usermod -G lpadmin $(who am i|cut -d" " -f1)
apt-get install -y cups
usermod -G lpadmin $(who|cut -d" " -f1)
myhn=`hostname`
echo ""
echo ""
@@ -299,34 +250,38 @@ else
echo ""
sleep 3
fi
fi
fi
}
# Install user config
echo ""
echo "Creating kiosk user..."
cloneuser.sh `who am i | awk '{print $1}'` kioskuser
mkdir -p /home/kioskuser/.config/openbox
cp -Rv home/kioskuser /home/
cp home/kioskuser/.profile /home/kioskuser
cp home/kioskuser/.config/openbox/rc.xml /home/kioskuser/.config/openbox
chown -R kioskuser:kioskuser /home/kioskuser/.config /home/kioskuser/.profile
echo "...done."
echo ""
function create_standalone_user() {
# Install standalone kiosk user config
echo ""
echo "Creating kiosk user..."
cloneuser.sh `who am i | awk '{print $1}'` kioskuser
mkdir -p /home/kioskuser/.config/openbox
cp -Rv home/kioskuser /home/
cp home/kioskuser/.profile /home/kioskuser
cp home/kioskuser/.config/openbox/rc.xml /home/kioskuser/.config/openbox
chown -R kioskuser:kioskuser /home/kioskuser/.config /home/kioskuser/.profile
echo "...done."
echo ""
}
# Prompt for URL and kiosk type
echo ""
echo "This web browser based kiosk will need to know the site you would"
echo "like to load. This can be a normal website or a file to be displayed"
echo "in the browser, but must be available as a web URL (http://something)."
echo ""
echo "Note that in kiosk mode, your normal navigation buttons and mouse"
echo "right-click menus are not available, so you will have no way to go"
echo "back or forward in a page unless the page itself provides that"
echo "capability."
url_ok=false
server_url="file:/home/kioskuser/openkiosk_welcome.html"
while ! $url_ok
do
function set_kiosk_url() {
# Prompt for URL
echo ""
echo "This web browser based kiosk will need to know the site you would"
echo "like to load. This can be a normal website or a file to be displayed"
echo "in the browser, but must be available as a web URL (http://something)."
echo ""
echo "Note that in kiosk mode, your normal navigation buttons and mouse"
echo "right-click menus are not available, so you will have no way to go"
echo "back or forward in a page unless the page itself provides that"
echo "capability."
url_ok=false
server_url="file:/home/kioskuser/openkiosk_welcome.html"
while ! $url_ok
do
echo ""
echo "Please enter complete URL. Valid formats are:"
echo "\"http://somesite.com/somepage\""
@@ -365,18 +320,22 @@ do
url_ok=true
fi
fi
done
sed -i 's,'TGT_URL=.*','TGT_URL="\"$server_url\""',' /etc/openkiosk.conf
echo ""
type_choice="none"
while [ "$type_choice" = "none" ]
do
done
sed -i 's,'TGT_URL=.*','TGT_URL="\"$server_url\""',' /etc/openkiosk.conf
}
function set_kiosk_type() {
# Prompt for kiosk type
echo ""
type_choice=false
while !$type_choice
do
echo "Will this kiosk be an interactive kiosk or a display-only kiosk?"
echo -n "[I]nteractive or [D]isplay-only? [I] :"
read kiosk_type
echo ""
if [[ $kiosk_type == "D" || $kiosk_type == "d" ]]
then
case "$kiosk_type" in
"d" | "D")
echo "Configuring for display-only kiosk."
echo "How often would you like to check for changes to the page being"
echo "displayed? Specify the number of seconds. Enter 0 to disable"
@@ -389,23 +348,162 @@ do
echo "Disabling screen blanking."
sed -i 's,'INHIBIT_BLANK=.*','INHIBIT_BLANK="\"1\""',' /etc/openkiosk.conf
type_choice="D"
elif [[ $kiosk_type == "I" || $kiosk_type = "i" || $kiosk_type == "" ]]
then
;;
"i" | "I" | "")
echo "Configuring for interactive kiosk."
type_choice="I"
else
;;
*)
echo "Please enter I for interactive or D for display-only."
fi
done
;;
esac
done
}
# -------------- Begin execution --------------
privilege_check
echo ""
echo "Kiosk configuration is now complete. "
echo " Welcome to $APP_NAME $APP_VERSION installation"
echo ""
echo "The system must be rebooted for the configuration to take effect."
echo ""
read -p "Would you like to reboot now? [Y/n]: " -r rebootok
if [[ $rebootok == "Y" || $rebootok == "y" || $rebootok == "" ]]
then
reboot
else
echo "This script will configure a Debian based system to be a kiosk browser terminal."
echo ""
echo ""
continueok=false
while ! $continueok
do
read -p "Would you like to continue with OpenKiosk setup [Y/n]: " -r continueok
case "$continueok in
"n" | "N")
echo "Cancelling setup."
clean_exit
fi
;;
"y" | "Y" | "")
continueok=true
echo "Continuing with OpenKiosk setup."
;;
*)
continueok=false
echo "Please answer Y (default) or N."
;;
esac
done
echo ""
echo "OpenKiosk can be set up as a standalone kiosk or a workstation kiosk."
echo ""
echo "A standalone kiosk will boot up to a display only or an interactive"
echo "kiosk that requires no login. This is useful for a system that is to"
echo "be used interactively by multiple people or will be in a public place"
echo "displaying automatically updating information non-interactively "
echo "(digital signage)."
echo ""
echo "A workstation kiosk is one that can be used on a normal workstation by"
echo "users who log in normally and would like to be able to run a kiosk style"
echo "browser or pdf viewer in a full screen or windowed configuration only"
echo "on demand."
echo ""
echo "Which configuration would you like?"
kconfig=false
while ! $kconfig
do
read -p "Would you like a [S]tandalone or a [W]orkstation configuration? [S/W]?: " -r kconfig
case "$kconfig" in
"s" | "S")
echo "Continuing with standalone configuration."
kconfig="standalone"
;;
"w" | "W")
echo "Continuing with workstation configuration."
kconfig="workstation"
;;
"c" | "C")
echo "Cancelling installation."
clean_exit
;;
*)
echo "Please enter S or W, or enter C to cancel installation."
kconfig=false
;;
esac
done
echo ""
echo "Preparing for $kconfig installation. Please wait..."
disable_unattended_upgrades
# Determine OS Release version
echo -n "OS information: "
echo ""
cat /etc/os-release
echo ""
sleep 5
chmod +x usr/local/bin/*
case "$kconfig in
"standalone")
# Copy in the needed files
echo "Copying files..."
cp -vf usr/local/bin/* /usr/local/bin
cp -Rvf etc/* /etc/
cp -vf lib/systemd/system/getty@tty1.service /lib/systemd/system
rm /lib/systemd/system/ctrl-alt-del.target
ln -s /dev/null /lib/systemd/system/ctrl-alt-del.target
echo "...done."
echo ""
update_os
remove_snap
# If we are on a Raspberry Pi 5, we'll need to install this for the
# xorg server to start
if cat /proc/cpuinfo|grep -q "Raspberry Pi 5" >/dev/null 2>&1
then
install_rpi5_gl
fi
install_x_server
install_chromium
install_webmin
install_cups
create_standalone_user
set_kiosk_url
set_kiosk_type
echo ""
echo "Kiosk configuration is now complete. "
echo ""
echo "The system must be rebooted for the configuration to take effect."
echo ""
read -p "Would you like to reboot now? [Y/n]: " -r rebootok
case "$rebootok" in
"y" | "Y" | "")
reboot
;;
*)
clean_exit
;;
esac
;;
"workstation")
# Copy in the needed files
echo "Copying files..."
cp -vf usr/local/bin/* /usr/local/bin
cp -vf etc/openkiosk.conf /etc/
install_chromium
install_cups
set_kiosk_url
set_kiosk_type
echo ""
echo "Kiosk configuration is now complete. "
echo ""
clean_exit
;;
*)
echo "Unknown configuration type. Aborting."
abort_exit
;;
esac

2
usr/local/bin/kiosk_cleanup
View File

@@ -1,7 +1,7 @@
#!/bin/bash
# kiosk_cleanup
rm -rf /home/kioskuser/.{config,cache}/chromium/
rm -rf $HOME/.{config,cache}/chromium/
rm -rf /dev/shm/target.pdf
pkill xmessage

81
usr/local/bin/kiosk_startkiosk
View File

@@ -1,10 +1,30 @@
#!/bin/bash
# kiosk_startkiosk
source /etc/openkiosk.conf
if [[ "$EUID" == "0" || $(who|cut -d" " -f1) == "kioskuser" ]]
then
conf_file="/etc/openkiosk.conf"
run_type="standalone"
else
if [[ ! -e "$HOME/.config/openkiosk/openkiosk.conf" ]]
then
mkdir -p $HOME/.config/openkiosk
cp /etc/openkiosk.conf $HOME/.config/openkiosk/
fi
conf_file="$HOME/.config/openkiosk/openkiosk.conf"
run_type="workstation"
fi
if [[ ! -e "$conf_file" ]]
then
echo "Couldn't find config file. Exiting."
exit 1
fi
source $conf_file
function set_commands() {
source /etc/openkiosk.conf
source $conf_file
if [[ $TGT_URL == "test" ]]
then
# Enter test mode
@@ -16,29 +36,29 @@ function set_commands() {
elif echo "$TGT_URL" | grep -q '\.pdf$'
then
# The URL is a pdf file
APP_CMD="viewpdf.sh $TGT_URL"
APP_CMD="kiosk_viewpdf $TGT_URL"
ALIVE_STRING="xpdf"
KILL_CMD="pkill xpdf"
CLEANUP_CMD="kiosk_cleanup.sh"
CLEANUP_CMD="kiosk_cleanup"
debuglog "URL is a pdf file. Command is $PDF_APP_CMD"
else
# Assume the URL returns HTML
APP_CMD="viewhtml.sh $TGT_URL"
APP_CMD="kiosk_viewhtml $TGT_URL"
ALIVE_STRING="chromium"
KILL_CMD="pkill chromium"
CLEANUP_CMD="kiosk_cleanup.sh"
CLEANUP_CMD="kiosk_cleanup"
debuglog "URL is an HTML file. Command is $HTML_APP_CMD"
fi
}
function check_conf() {
debuglog "Checking configuration file for changes."
new_conf_md5=`md5sum /etc/openkiosk.conf|cut -d " " -f1`
new_conf_md5=$(md5sum $conf_file|cut -d " " -f1)
debuglog "New config file checksum: $new_conf_md5"
curr_conf_md5=`cat /dev/shm/curr_conf_md5.txt`
curr_conf_md5=$(cat /dev/shm/curr_conf_md5.txt)
debuglog "Current config file checksum: $curr_conf_md5"
diff <(echo $new_conf_md5) <(echo $curr_conf_md5) >/dev/null 2>&1
if [ "$?" -eq "1" ]
if [[ "$?" == "1" ]]
then
debuglog "Config file has changed!"
echo $new_conf_md5 > /dev/shm/curr_conf_md5.txt
@@ -59,19 +79,19 @@ function check_url() {
fi
if echo "$TGT_URL"|grep -q '^http'
then
new_url_md5=`wget -q -o /dev/null -O - $TGT_URL|md5sum|cut -d " " -f1`
new_url_md5=$(wget -q -o /dev/null -O - $TGT_URL|md5sum|cut -d " " -f1)
elif echo "$TGT_URL"|grep -q '^file'
then
filepath=$(echo "$TGT_URL"|cut -d":" -f2-)
new_url_md5=`md5sum $filepath|cut -d " " -f1`
new_url_md5=$(md5sum $filepath|cut -d " " -f1)
else
new_url_md5=""
fi
debuglog "New URL checksum: $new_url_md5"
curr_url_md5=`cat /dev/shm/curr_url_md5.txt`
curr_url_md5=$(cat /dev/shm/curr_url_md5.txt)
debuglog "Current URL checksum: $curr_url_md5"
diff <(echo $new_url_md5) <(echo $curr_url_md5) >/dev/null 2>&1
if [ "$?" -eq "1" ]
if [[ "$?" == "1" ]]
then
debuglog "URL has changed!"
echo $new_url_md5>/dev/shm/curr_url_md5.txt
@@ -85,18 +105,24 @@ function check_url() {
}
function debuglog() {
if [ "$DEBUG" -eq "1" ]
if [[ "$DEBUG" == "1" ]]
then
if [ ! -e "/home/kioskuser/startkiosk.log" ]
if [[ "$run_type" == "standalone" ]]
then
echo "startkiosk log started : "`date +%Y-%m-%d %H:%M:%S` > /home/kioskuser/startkiosk.log
logfile_path="/var/log/startkiosk.log"
else
logfile_path="$HOME/startkiosk.log"
fi
echo `date +%H:%M:%S` "$1">>/home/kioskuser/startkiosk.log
if [[ ! -e "$logfile_path" ]]
then
echo "startkiosk log started : "$(date +%Y-%m-%d %H:%M:%S) > $logfile_path
fi
echo $(date +%H:%M:%S) "$1">>$logfile_path
fi
}
function set_blank_params() {
if [ "$INHIBIT_BLANK" -eq "1" ]
if [[ "$INHIBIT_BLANK" == "1" ]]
then
xset s off
xset -dpms
@@ -108,20 +134,23 @@ function set_blank_params() {
}
function set_rot_params() {
output_name=`xrandr --listactivemonitors|grep 0:|rev|cut -d " " -f1|rev`
output_name=$(xrandr --listactivemonitors|grep 0:|rev|cut -d " " -f1|rev)
xrandr --output $output_name --rotate "normal"
sleep 1
xrandr --output $output_name --rotate $ROTATION
}
set_commands
openbox-session &
if [[ "$run_type" == "standalone" ]]
then
openbox-session &
fi
sleep 1
set_blank_params
pkill xpdf
pkill chromium
pkill xterm
kiosk_cleanup.sh
kiosk_cleanup
# start application
@@ -130,16 +159,16 @@ sleep 3
if echo "$TGT_URL"|grep -q '^http'
then
new_url_md5=`wget -q -o /dev/null -O - $TGT_URL|md5sum|cut -d " " -f1`
new_url_md5=$(wget -q -o /dev/null -O - $TGT_URL|md5sum|cut -d " " -f1)
elif echo "$TGT_URL"|grep -q '^file'
then
filepath=$(echo "$TGT_URL"|cut -d":" -f2-)
new_url_md5=`md5sum $filepath|cut -d " " -f1`
new_url_md5=$(md5sum $filepath|cut -d " " -f1)
else
new_url_md5=""
fi
echo $new_url_md5>/dev/shm/curr_url_md5.txt
new_conf_md5=`md5sum /etc/openkiosk.conf|cut -d " " -f1`
new_conf_md5=$(md5sum $conf_file|cut -d " " -f1)
echo $new_conf_md5 > /dev/shm/curr_conf_md5.txt
while true
@@ -148,7 +177,7 @@ do
debuglog "Monitoring for URL and config file changes..."
# Pull in changes in the configuration file
debuglog "Reading config file"
source /etc/openkiosk.conf
source $conf_file
if ! pgrep $ALIVE_STRING
then
@@ -157,7 +186,7 @@ then
$APP_CMD &
fi
if [ "$POLL_INTERVAL" -eq "0" ]
if [[ "$POLL_INTERVAL" == "0" ]]
then
sleep 1
debuglog "Polling not enabled"