docs: Add 2, update 5 and remove 1 files
All checks were successful
Test and Publish Templates / test-and-publish (push) Successful in 45s
All checks were successful
Test and Publish Templates / test-and-publish (push) Successful in 45s
This commit is contained in:
@@ -9,11 +9,14 @@ installing packages, configuring auto-login, and modifying system services.
|
||||
|
||||
REQUIREMENTS
|
||||
------------
|
||||
* Raspberry Pi or Linux system with HDMI output
|
||||
* Fresh Raspberry Pi OS Lite installation (recommended)
|
||||
* Supported systems:
|
||||
- Raspberry Pi with Raspberry Pi OS
|
||||
- Intel Mac Mini with Ubuntu Server
|
||||
- Other x86_64 systems with Ubuntu
|
||||
* Docker installed (for running setup)
|
||||
* Internet connection for package installation
|
||||
* Target URL to display
|
||||
* HDMI or DisplayPort output
|
||||
|
||||
WHAT IT DOES
|
||||
------------
|
||||
@@ -22,10 +25,12 @@ This template automates the complete kiosk setup process:
|
||||
2. Creates/configures kiosk user account
|
||||
3. Sets up auto-login on boot
|
||||
4. Configures X server to start automatically
|
||||
5. Launches Chromium in kiosk mode
|
||||
5. Launches Chromium/Chrome in kiosk mode
|
||||
6. Disables screen blanking and power management
|
||||
7. Optional watchdog to restart browser if it crashes
|
||||
8. Configures GPU memory for better performance (RPi)
|
||||
8. System-specific optimizations:
|
||||
- Raspberry Pi: GPU memory allocation, update disabling
|
||||
- Ubuntu/Mac Mini: Intel GPU optimizations
|
||||
|
||||
CONFIGURATION
|
||||
-------------
|
||||
@@ -42,11 +47,16 @@ Key settings in service.env:
|
||||
INSTALLATION
|
||||
------------
|
||||
1. Configure your settings in the service configuration
|
||||
2. Run: ./install.sh
|
||||
2. Run: ./install.sh (will auto-detect system type)
|
||||
3. Confirm system modifications when prompted
|
||||
4. REBOOT the system: sudo reboot
|
||||
5. System will auto-start in kiosk mode
|
||||
|
||||
The installer will automatically detect if you're running on:
|
||||
- Raspberry Pi (ARM-based)
|
||||
- Ubuntu on x86_64 (Mac Mini or PC)
|
||||
If detection fails, you'll be prompted to select manually.
|
||||
|
||||
The installation uses a privileged Docker container to make the
|
||||
necessary system changes. This is intentional and required.
|
||||
|
||||
|
Reference in New Issue
Block a user