root/ubuntu-based-kiosk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Readme.md

Browse Source
This commit is contained in:
outis1one
2025-11-23 16:57:01 -05:00
committed by GitHub
parent ca4a6d355a
commit 66bcf9dc66
1 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Readme.md
+14 -8
View File
@@ -1,21 +1,21 @@
UBK (Ubuntu Based Kiosk) — Installer README ### UBK (Ubuntu Based Kiosk) — Installer README
Built with Claude Sonnet 4/.5 AI assistance Built with Claude Sonnet 4/.5 AI assistance
License: GPL v3 - Keep derivatives open sour License: GPL v3 - Keep derivatives open sour
Repository: https://github.com/outis1one/ubk/ Repository: https://github.com/outis1one/ubk/
TARGET SYSTEMS: ## TARGET SYSTEMS:
- Ubuntu 24.04+ Server (minimal install recommended) - Ubuntu 24.04+ Server (minimal install recommended)
- Raspberry Pi 4+ (with or without touchscreen) - Raspberry Pi 4+ (with or without touchscreen)
- Laptops, desktops, all-in-ones, 2-in-1s - Laptops, desktops, all-in-ones, 2-in-1s
- Touch support optional (works with keyboard/mouse) - Touch support optional (works with keyboard/mouse)
SECURITY NOTICE: # SECURITY NOTICE:
This is NOT suitable for secure locations or public kiosks. This is NOT suitable for secure locations or public kiosks.
Do NOT use as a replacement for hardened kiosk solutions. Do NOT use as a replacement for hardened kiosk solutions.
Use entirely at your own risk. Use entirely at your own risk.
PURPOSE: # PURPOSE:
Home/office kiosk for reusing old hardware, displaying: Home/office kiosk for reusing old hardware, displaying:
- Self-hosted services (Immich, MagicMirror2, Home Assistant) - Self-hosted services (Immich, MagicMirror2, Home Assistant)
- Web dashboards, digital signage - Web dashboards, digital signage
@@ -23,7 +23,6 @@ Home/office kiosk for reusing old hardware, displaying:
- Any web-based content - Any web-based content
## Overview ## Overview
UBK is a full kiosk environment built on Ubuntu, designed for locked‑down, single‑purpose deployments. This installer (`install_kiosk_0.9.7.sh`) automates setup of the entire system, including: UBK is a full kiosk environment built on Ubuntu, designed for locked‑down, single‑purpose deployments. This installer (`install_kiosk_0.9.7.sh`) automates setup of the entire system, including:
* Electron-based kiosk application * Electron-based kiosk application
@@ -37,7 +36,14 @@ UBK is a full kiosk environment built on Ubuntu, designed for locked‑down, sin
The script is intended for fresh installations and can fully provision a kiosk from a clean Ubuntu machine. The script is intended for fresh installations and can fully provision a kiosk from a clean Ubuntu machine.
--- ## Functionality
- single or multiple sites, with auto rotation, and manual sites not in rotation
- ability to pause a rotational site, auto return to home popup for manual sites
- password protection
- Squeezelite player
- Cups printing
- touch screen controls (two finger swiping between sites, toggable on screen keyboard and pause site)
## Quick Install ## Quick Install
@@ -225,7 +231,7 @@ UBK aggregates open-source software governed by their respective licenses. The a
## Project Status ## Project Status
This installer is part of an evolving kiosk system. Future versions may include additional lockdown measures, network watchdogs, or health monitoring. This installer is part of an evolving kiosk system. Future versions may include intercom functionality, a web base gui configuration screen, all in one iso.
--- ---