making it releasable

3 files changed, 228 insertions, 17 deletions

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..3162aad
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Teleco Switzerland
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
\ No newline at end of file
diff --git a/README.md b/README.md
index d017377..def3624 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,47 @@
 # Basic Kiosk Installer
-A really basic Bash script that helps you display one or multiple websites Kiosk style on Debian based distros.
+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).
 
 ## Requirements
 What you need
 
-- Option 1 : Debian 12
-    - Base Installation with following :
+- Option 1: Debian 12
+    - Base Installation with the following:
         - Locale set to your locale
-        - Hostename set to something appropriate
+        - Hostname set to something appropriate
         - Password for root set
         - "kiosk" user made
-        - Software selection : SSH Server and Standard System Utilities (nothing more than that)
+        - Software selection: SSH Server and Standard System Utilities (nothing more than that)
 
-- Option 2 : Raspberry Pi OS Lite
-    - Base Image with following :
+- Option 2: Raspberry Pi OS Lite
+    - Base Image with the following:
         - Network Configured
         - Locale set to your locale
-        - Hostename set to something appropriate
+        - Hostname set to something appropriate
         - "kiosk" user made
         - SSH Enabled
 
-## Debian 12 
+## Lazy Installation
+
+### Using the Lazy Installer Script (not tested on PI OS Lite)
+1. Sign in to your Debian machine using SSH and kiosk user `ssh kiosk@your.debian.host`
+2. Sign into your root account using `su`
+3. Clone the repository to the root's home directory
+```bash
+cd ~
+git clone https://git.teleco.ch/crt/basic-kiosk.git/
+```
+4. Run the lazy installer
+```bash
+bash basic-kiosk/lazy-installer.sh
+```
+
+## Normal Installation
 
 ### Basic user setup and preparations
-1. sign in to your Debian machine using SSH and kiosk user `ssh kiosk@your.debian.host`
-2. sign into your root account using `su`
-3. install the basics : `apt update && apt upgrade -y && apt install sudo dialog git htop tmux screen screenfetch -y`
-4. add sbin to bash paths for root `echo 'export PATH=$PATH:/sbin:/usr/sbin' | tee -a ~/.bashrc ~/.profile > /dev/null && bash`
+1. Sign in to your Debian machine using SSH and kiosk user `ssh kiosk@your.debian.host`
+2. Sign into your root account using `su`
+3. Install the basics: `apt update && apt upgrade -y && apt install sudo dialog git htop tmux screen screenfetch -y`
+4. Add sbin to bash paths for root `echo 'export PATH=$PATH:/sbin:/usr/sbin' | tee -a ~/.bashrc ~/.profile > /dev/null && bash`
 5. Add kiosk user to sudo group
 ```bash
 bash
@@ -35,12 +50,94 @@ exit
 exit
 exit
 ```
-6. Sign back in via ssh `ssh kiosk@your.debian.host`
-7. add sbin to bash paths for kiosk user `echo 'export PATH=$PATH:/sbin:/usr/sbin' | tee -a ~/.bashrc ~/.profile > /dev/null && bash`
-8. download the kiosk and go to its folder `git clone https://git.teleco.ch/crt/basic-kiosk.git/ && cd basic-kiosk`
+6. Sign back in via SSH `ssh kiosk@your.debian.host`
+7. Add sbin to bash paths for kiosk user `echo 'export PATH=$PATH:/sbin:/usr/sbin' | tee -a ~/.bashrc ~/.profile > /dev/null && bash`
+8. Download the kiosk and go to its folder `git clone https://git.teleco.ch/crt/basic-kiosk.git/ && cd basic-kiosk`
 
 ### Installing the Kiosk via Terminal User Interface (TUI/GUI)
-1. run the installer 
+1. Run the installer
+```bash
+bash installer.sh
+```
+
+### What to Expect in the TUI
+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:
+
+1. **Select Distribution**: Choose your Linux distribution (Debian or Raspberry Pi OS Lite).
+2. **Package Installation**: The script will install necessary packages for your selected distribution and ask for the sudo password.
+3. **Configure .xinitrc**: The script will configure the `.xinitrc` file for the kiosk user and make it executable.
+4. **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.
+5. **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.
+6. **Configure Automatic Login**: The script will configure automatic login for the kiosk user.
+7. **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
+
+## Project Structure
+(I am so professional for adding this omg)
+
+### Files and Descriptions
+
+- `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.
+
+## Using Auto Functions
+
+### Auto Mode for `installer.sh`
+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.
+
+#### Usage
+```bash
+bash installer.sh --auto <distro> <scaling_factor> <vnc_password> <url1> [<url2> ... <urlN>]
+```
+
+#### Example
+```bash
+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"
+```
+
+### Auto Mode for `configure.sh`
+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.
+
+#### Usage
+```bash
+bash configure.sh --auto <scaling_factor> <url1> [<url2> ... <urlN>]
+```
+
+#### Example
+```bash
+bash configure.sh --auto 1 "https://www.example.com"
+bash configure.sh --auto 2 "https://www.example1.com" "https://www.example2.com"
+```
+
+## Misc
+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 
+```
+sleep 30
+```
+to however many seconds it should wait before switching tabs.
+
+If you 
+
+## Contributing
+
+You can contribute if you want…
+…but I doubt anyone will lmao.
+
+## License
+
+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. ❤️
 
diff --git a/lazy-installer.sh b/lazy-installer.sh
new file mode 100644
index 0000000..6e7276c
--- /dev/null
+++ b/lazy-installer.sh
@@ -0,0 +1,93 @@
+#!/bin/bash
+
+# Function to check if running as root
+check_root() {
+    if [ "$(id -u)" -ne 0; then
+        echo "Please run this script as root."
+        echo "To switch to root, use: su"
+        echo "Then navigate to the home directory and clone the repository:"
+        echo "cd ~"
+        echo "git clone https://git.teleco.ch/crt/basic-kiosk.git/"
+        echo "Run this script again using: bash basic-kiosk/lazy-installer.sh"
+        exit 1
+    fi
+}
+
+# Function to check if /sbin paths are in root's bash profile
+check_sbin_paths() {
+    if ! grep -q '/sbin' ~/.bashrc; then
+        echo 'export PATH=$PATH:/sbin:/usr/sbin' >> ~/.bashrc
+        echo 'export PATH=$PATH:/sbin:/usr/sbin' >> ~/.profile
+        echo "Added /sbin paths to root's bash profile."
+    fi
+    export PATH=$PATH:/sbin:/usr/sbin
+}
+
+# Function to install basic packages
+install_basics() {
+    apt update && apt upgrade -y
+    apt install sudo dialog git htop tmux screen screenfetch -y
+}
+
+# Function to check if kiosk user exists, if not create it
+check_kiosk_user() {
+    if ! id -u kiosk > /dev/null 2>&1; then
+        read -p "Enter password for kiosk user: " kiosk_password
+        useradd -m -s /bin/bash kiosk
+        echo "kiosk:$kiosk_password" | chpasswd
+        echo "Created kiosk user."
+    fi
+    if ! groups kiosk | grep -q "\bsudo\b"; then
+        usermod -aG sudo kiosk
+        echo "Added kiosk user to sudo group."
+    fi
+}
+
+# Function to clone the repository for root user
+clone_repo_for_root() {
+    if [ ! -d ~/basic-kiosk ]; then
+        echo "Cloning the repository to the home directory..."
+        if ! git clone https://git.teleco.ch/crt/basic-kiosk.git/ ~/basic-kiosk; then
+            read -p "Git clone failed. Do you want to try copying the folder instead? (y/n): " choice
+            if [ "$choice" = "y" ]; then
+                cp -r "$(dirname "$0")" ~/basic-kiosk
+                echo "Copied the folder to the home directory."
+            else
+                echo "Please clone the repository manually and run the script again."
+                exit 1
+            fi
+        fi
+    fi
+}
+
+# Function to clone the repository for kiosk user
+clone_repo_for_kiosk() {
+    if ! sudo -u kiosk bash -c "[ -d ~/basic-kiosk ]"; then
+        echo "Cloning the repository to the kiosk user's home directory..."
+        if ! sudo -u kiosk bash -c "git clone https://git.teleco.ch/crt/basic-kiosk.git/ ~/basic-kiosk"; then
+            read -p "Git clone failed. Do you want to try copying the folder instead? (y/n): " choice
+            if [ "$choice" = "y" ]; then
+                sudo -u kiosk bash -c "cp -r $(dirname "$0") ~/basic-kiosk"
+                sudo chown -R kiosk:kiosk /home/kiosk/basic-kiosk
+                echo "Copied the folder to the kiosk user's home directory."
+            else
+                echo "Please clone the repository manually and run the script again."
+                exit 1
+            fi
+        fi
+    fi
+}
+
+# Function to run the installer as kiosk user
+run_installer_as_kiosk() {
+    sudo -u kiosk bash -c "cd ~/basic-kiosk && bash installer.sh"
+}
+
+# Main script execution
+check_root
+check_sbin_paths
+clone_repo_for_root
+install_basics
+check_kiosk_user
+clone_repo_for_kiosk
+run_installer_as_kiosk