Welcome to the Basic Kiosk Installer! This project consists of some basic scripts to help you display one or multiple websites Kiosk style on Debian-based distros. It's simple, it's basic, and it works (most of the time).
What you need
- Sign in to your Debian machine using SSH and kiosk user
ssh kiosk@your.debian.host
- Sign into your root account using
su
- Clone the repository to the root's home directory
cd ~
git clone https://git.teleco.ch/crt/basic-kiosk.git/
- Run the lazy installer
bash basic-kiosk/lazy-installer.sh
- Sign in to your Debian machine using SSH and kiosk user
ssh kiosk@your.debian.host
- Sign into your root account using
su
- Install the basics:
apt update && apt upgrade -y && apt install sudo dialog git htop tmux screen screenfetch -y
- Add sbin to bash paths for root
echo 'export PATH=$PATH:/sbin:/usr/sbin' | tee -a ~/.bashrc ~/.profile > /dev/null && bash
- Add kiosk user to sudo group
bash
usermod -aG sudo kiosk
exit
exit
exit
- Sign back in via SSH
ssh kiosk@your.debian.host
- Add sbin to bash paths for kiosk user
echo 'export PATH=$PATH:/sbin:/usr/sbin' | tee -a ~/.bashrc ~/.profile > /dev/null && bash
- Download the kiosk and go to its folder
git clone https://git.teleco.ch/crt/basic-kiosk.git/ && cd basic-kiosk
- Run the installer
When you run the installer script, you will be presented with a series of dialog boxes that guide you through the installation process. Here is what you should expect:
- Select Distribution: Choose your Linux distribution (Debian or Raspberry Pi OS Lite).
- Package Installation: The script will install necessary packages for your selected distribution and ask for the sudo password.
- Configure .xinitrc: The script will configure the
.xinitrc file for the kiosk user and make it executable.
- Configure start.sh: You will be prompted to enter the display scaling factor and choose the kiosk type (simple website or multiple tabs). You will also be asked to enter the URLs for the websites.
- Configure VNC Password: You will be prompted to enter the VNC password. This is so you can access your kiosk via VNC on Port 5901 to check on it.
- Configure Automatic Login: The script will configure automatic login for the kiosk user.
- Edit .bashrc: The script will edit the
.bashrc file to start the X session automatically.
After all that's done, reboot the kiosk and all should work maybe or maybe not. You go figure that out
(I am so professional for adding this omg)
-
installer.sh: The main installer script that guides you through the installation process using a dialog TUI. It installs necessary packages, configures .xinitrc, start.sh, VNC password, automatic login, and edits .bashrc.
-
configure.sh: A script to configure individual settings without reinstalling the kiosk. It allows you to change the display scaling, kiosk type, websites, and VNC password.
-
lazy-installer.sh: A script for users who prefer an even simpler setup. It checks if the script is run as root, installs basic packages to run installer.sh, creates the kiosk user if it doesn't exist, moves files where they should be, and runs the installer as the kiosk user.
You can run the installer.sh script in automatic mode with no user interaction (other than the sudo prompt lol). This requires specifying the distribution, scaling factor, VNC password, and at least one URL.
bash installer.sh --auto <distro> <scaling_factor> <vnc_password> <url1> [<url2> ... <urlN>]
bash installer.sh --auto debian 1 myvncpassword "https://www.example.com"
bash installer.sh --auto raspberry 2 myvncpassword "https://www.example1.com" "https://www.example2.com"
You can run the configure.sh script in automatic mode to configure the kiosk settings without user interaction. This requires specifying the scaling factor and at least one URL.
bash configure.sh --auto <scaling_factor> <url1> [<url2> ... <urlN>]
bash configure.sh --auto 1 "https://www.example.com"
bash configure.sh --auto 2 "https://www.example1.com" "https://www.example2.com"
If you want to change the time that it takes to switch between tabs, edit the start.sh file in the kiosk user's home directory by changing the line that says
to however many seconds it should wait before switching tabs.
If you
You can contribute if you want…
…but I doubt anyone will lmao.
This project is licensed under the MIT License.
See the LICENSE file for details.
Basically:
- No warranty.
- No responsibility.
- I barely know how to code.
Made with love for Bash scripting and pure hatred for unnecessary complexity by T.B. ❤️
