FreeKiosk is an open-source kiosk platform for Android tablets, built for teams that want full control without license costs.

Instead of burying everything in one long page, this README gives you the essentials and points to complete docs in docs/.

Why teams choose it

• ✅ Free and MIT licensed
• ✅ Device Owner support for true lockdown
• ✅ Works in WebView mode or External App mode
• ✅ Native REST API and MQTT integration
• ✅ Headless ADB provisioning for mass rollout
• ✅ Privacy-first: no mandatory tracking layer

✨ Key capabilities

Area	What you get	Deep dive
Kiosk modes	WebView, External App, Dashboard, Media/Multi-App evolution	Features and Modes
Device control	Lock task, boot behavior, status bar policies, PIN access	Installation
Automation	40+ REST endpoints, MQTT discovery for Home Assistant	Integrations
Provisioning	ADB command-based configuration and scripting	ADB Configuration

📦 Install in 60 seconds

1. Download the latest APK from Releases.
2. Install on Android 8.0+ tablet.
3. Configure URL/app + PIN.
4. Start kiosk mode.

For production lockdown, use Device Owner mode:

adb shell dpm set-device-owner com.freekiosk/.DeviceAdminReceiver

👉 Full setup guide: docs/installation.md

🧩 Docs map

I want to...	Go to
Deploy tablets correctly	Installation Guide
Understand display/kiosk modes	Features and Modes
Integrate with Home Assistant	Integrations Overview
Use API endpoints	REST API Docs
Configure MQTT topics/discovery	MQTT Docs
Provision with scripts	ADB Configuration
Follow release direction	Roadmap and Changelog
Contribute code	Development Guide

🥊 FreeKiosk vs Fully Kiosk Browser

Feature	FreeKiosk	Fully Kiosk
Price	🟢 Free	🔴 Paid per device
Open-source	🟢 MIT	🔴 Closed source
Device Owner mode	✅	✅
REST API	✅	✅
MQTT + Home Assistant discovery	✅	❌
Cloud fleet management	Roadmap	✅

🛠️ Tech stack

• React Native + TypeScript
• Kotlin native modules (Android policy and system control)
• Android SDK 26+ (Android 8+)

🗺️ Roadmap snapshot

• v1.2.x: reliability and operational hardening
• v1.3.x: richer deployment and media workflows
• v2.x: optional cloud/fleet management direction

Detailed notes: docs/roadmap-and-changelog.md

🤝 Contributing

Contributions are welcome.

• Guidelines: CONTRIBUTING.md
• Issues: GitHub Issues
• Discussions: GitHub Discussions

---

📄 License

MIT License. See LICENSE.