Kiosk Show Replacement

A self-hosted replacement for kiosk.show - a web application for managing and displaying slideshow presentations on kiosk displays.

Contents:

• Deployment
  • System Requirements
  • Docker Deployment
  • Production Configuration
  • Production Checklist
  • Upgrade Procedures
  • Troubleshooting
  • SQLite to MariaDB Migration
• Usage
  • Web Interface
  • Programmatic Access
• API Reference
  • Base URL
  • Authentication
  • Standard Response Format
  • Content Types
  • Data Models
• Application Routes
  • Main Application Routes
  • Authentication Routes
  • Dashboard Routes
  • Slideshow Management Routes (Web)
  • Display Interface Routes
  • Admin Interface Routes
• REST API Endpoints
  • API Root
  • API v1 Authentication
  • API v1 Status
  • API v1 Slideshows
  • API v1 Slideshow Items
  • API v1 Displays
  • API v1 Assignment History
  • API v1 Video URL Validation
  • API v1 File Uploads
• Development
  • System Requirements
  • Setting up Development Environment
  • Development Workflow
  • Code Style
  • Testing
  • Project Structure
  • Adding New Features
  • Database Migrations
  • Frontend Development
  • Contributing
  • Release Process
• API Documentation
  • create_app()
  • Core Modules

Features

• Web-based slideshow management: Create and manage slideshows through a modern React admin interface

• Kiosk display mode: Full-screen slideshow display for kiosk installations

• REST API: Complete API for programmatic management of slideshows and slides

• Multiple media types: Support for images, videos, web content, text slides, and Skedda calendars

• User management: Role-based access with admin and regular user accounts

• Responsive design: Works on desktop, tablet, and mobile devices

• Multi-database support: SQLite for development, MariaDB/PostgreSQL for production

• Docker deployment: Easy production deployment with Docker and Docker Compose

• Multi-architecture: Supports x86_64 and ARM64 (including Raspberry Pi)

Quick Start

Docker is the only supported deployment method for production. See Deployment for detailed instructions including environment configuration, monitoring setup, and troubleshooting.

# Clone and configure
git clone https://github.com/jantman/kiosk-show-replacement.git
cd kiosk-show-replacement
cp .env.docker.example .env
# Edit .env with your settings (SECRET_KEY, passwords, etc.)

# Start the application
docker-compose -f docker-compose.prod.yml up -d

# Access at http://localhost:5000/admin (default: admin/admin)

For local development setup (Python/Poetry), see Development.

Indices and tables

• Index

• Module Index

• Search Page