Documentation

FreeKiosk Documentation

Everything you need to deploy and configure your kiosk

Table of Contents

Overview

FreeKiosk is a free, open-source application that transforms Android tablets into secure kiosks displaying a single fullscreen website or web app. Ideal for information displays, POS systems, digital signage, and public access terminals.

What it does

  • Fullscreen WebView or External App
  • REST API (40+ endpoints)
  • URL Rotation & Planner
  • Complete device lockdown

Requirements

  • Android 8.0+ (Oreo)
  • Network connection
  • ADB (for Device Owner)

Installation

Basic Installation

  1. 1

    Download the APK

    From our download page or Google Play Store

  2. 2

    Transfer to device

    Via USB, email, or direct download

  3. 3

    Install the app

    Enable "Unknown sources" in Settings > Security if needed

  4. 4

    Open FreeKiosk

    Configure your URL and settings

Download FreeKiosk

Device Owner Mode

Why Device Owner?

Device Owner mode provides complete lockdown: no status bar, no notifications, no navigation buttons, automatic restart on crash, and no way for users to exit the kiosk.

Requirements

  • Factory reset device (no Google account)
  • ADB installed on your computer
  • USB debugging enabled on device
  • FreeKiosk already installed

Step-by-Step Setup

Step 1: Factory Reset

Go to Settings → System → Reset options → Erase all data

Do NOT add a Google account during the initial setup. Skip all account creation.

Step 2: Enable Developer Options
  1. Go to Settings → About tablet
  2. Tap Build number 7 times
  3. Go back to Settings → Developer options
  4. Enable USB debugging
Step 3: Install FreeKiosk

Install the APK via USB transfer, web download, or SD card. Make sure the app is installed before running the ADB command.

Step 4: Set Device Owner

Connect the tablet via USB and run:

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

You should see: Success: Device owner set

Removing Device Owner Mode

To remove Device Owner status, go to FreeKiosk Settings → Remove Device Owner, or run:

adb shell dpm remove-active-admin com.freekiosk/.DeviceAdminReceiver

Basic Configuration (Quick Start)

1Your URL

The URL that the tablet will display permanently.

https://freekiosk.app

2PIN Code

4-6 digit PIN to access settings.

3Recommended Mode

UsageModeScreen Pinning
🌐 Web pageWebView✅ Enabled
📺 External AppExternal App✅ Enabled
🧪 Test / DemoWebView❌ Disabled

4Essential Settings

OptionRecommended Value
Fullscreen✅ Enabled
Auto-start on boot✅ Enabled
Hide status bar✅ Enabled
Screen timeoutNever (or via ScreenSaver)
Brightness50-70%

5REST API (optional)

Control your tablet from Home Assistant.

See API documentation for more details.

Features

Full Lockdown

No exit without PIN code

REST API

40+ endpoints for Home Assistant

URL Rotation

Cycle through multiple URLs

External App Mode

Lock any Android app

URL Planner

Schedule URLs by time/date

Modern UI

4 organized settings tabs

Troubleshooting

Device Owner command fails

Ensure the device is factory reset with no Google account. Remove all accounts in Settings → Accounts.

ADB device not found

Enable USB debugging, try a different USB cable, and install device drivers on your PC.

White screen in kiosk

Check URL is correct and accessible. Try loading the URL in Chrome first.

Cannot exit kiosk mode

Tap the screen 5 times rapidly in the top-left corner to bring up the exit prompt.

Need More Help?

Check our FAQ or open an issue on GitHub

View FAQGitHub Issues