Articles on: Kiosk Browser - Features

Kiosk Browser - Automatic Configuration JSON

The automatic config feature in Kiosk Browser allows you to specify a Url (Settings > Advanced) where Kiosk Browser will check for config changes every 15 mins. For example https://www.android-kiosk.com/kbconfig.json This allows you to keep your devices configured consistently but also allows you to easily make changes.

The below list of properties is a complete list of all configuration properties. They are all optional, if you do not include a specific property, the default setting from Kiosk Browser is used instead. If you have already configured a device with the required settings you can export your config to a JSON file stored publicly on our servers for 15 minutes. Go to Settings > Admin > Create Automatic Configuration File.


Please note that some fields require specific strings as detailed in the comments (comments must not be included in the final json as it does not support comments).

It's possible to clear a string property by just using an empty string "". Null can be applied to all of the sleep/wake/restart times


Licensing


You can automatically activate licences via JSON property as per below:
{
     "licence_key": "12345"
}


Example Properties


{
	"kiosk_url": "https://www.google.com",
	"custom_app_title":"Kiosk Browser",
	"hyperlink_sound": true,
	"enable_timeout": true,
	"idle_timeout": 5, //idle timeout in minutes
	"idle_timeout_always_reload": true,
	"reload_on_screen_on": true,
	"theme": "Green", //must be "Blue" OR "Cyan" OR "Green" OR "Grey" OR "Orange" OR "Pink" OR "Purple" OR "Red" OR "Teal" OR "Yellow"
	"colour_navigation_bar": false,
	"lock_rotation": false,
	"rotation": "Landscape", //must be "LANDSCAPE" OR "REVERSE LANDSCAPE" OR "PORTRAIT" OR "REVERSE PORTRAIT"
	"fullscreen_mode": false,
	"back_toggles_fullscreen": false,
	"custom_screensaver": false,
	"screensaver_timeout": 5 //idle time before screensaver starts in minutes
	"custom_screensaver_type": "IMAGE", //must be "IMAGE" OR "VIDEO" OR "WEBSITE"
	"screensaver_slide_delay": 15, //time between slides in seconds
	"screensaver_random": false,
	"screensaver_urls": "https://www.google.com,https://www.android.com",
	"hide_action_bar": false, //hide toolbar
	"display_toolbar_swipe_down": true, //displays toolbar on swipe down if hidden,
	"custom_launcher_icon": false, //custom app icon
	"icon_loads_home_page": true,
	"show_browser_controls": true,
	"show_home_icon": true,
	"show_refresh_icon": true,
	"show_back_icon": true,
	"show_forward_icon": true,
	"show_app_drawer_icon": false,
	"show_bookmarks_icon": false,
	"bookmarks": "https://www.google.com,https://www.android.com",
	"bookmark_names": "Google,Android Website",
	"bookmarks_title": "My Bookmarks",
	"show_print_menu": false,
	"custom_toolbar_url": "https://mywebsite.com",
	"barcode_scanner": false,
	"barcode_redirect_url": "https://www.mywebsite.com?barcoderesult=",
	"camera_icon": false,
	"show_restart_app_menu": false,
	"hide_menu_items": false, //hides overflow menu items such as settings and exit
	"page_zooming": true,
	"overview_mode": true,
	"use_wide_viewport": true,
	"initial_zoom": 0, //value between 0-400
	"user_agent": "DEFAULT" //must be "DEFAULT" OR "DESKTOP" OR "CUSTOM"
	"user_agent_custom": "", //valid custom user agent string, user_agent must be set to CUSTOM
	"timeout_cacheclear": true,
	"timeout_storageclear": true,
	"timeout_cookieclear": true,
	"timeout_formsclear": true,
	"autoplay_video": false,
	"autoplay_audio": false,
	"custom_error_page": false,
	"redirect_custom_error_page": false,
	"custom_denied_page": false,
	"ignore_certificate_errors": false,
	"cache_mode": "LOAD_DEFAULT", //must be "LOAD_DEFAULT" OR  "LOAD_NO_CACHE" OR "LOAD_CACHE_ELSE_NETWORK" OR "LOAD_CACHE_ONLY"
	"prevent_uploads": false,
	"force_camera_uploads": false,
	"keep_screen_on": true,
	"prevent_screen_power_off": false,
	"use_device_backbutton": true,
	"nfc_enabled": false,
	"control_wifi_state": false,
	"wifi_enabled": true,
	"volume_controls_enabled": true,
	"default_camera": "FRONT", //must be "FRONT" OR "BACK"
	"allow_bluetooth_devices": true,
	"default_bluetooth_device": "00:00:00:00:00:00", //mac address of bluetooth device
	"reload_network_change": true,
	"reset_wifi": false,
	"reset_wifi_interval": 0, //interval in minutes
	"delay_load_on_startup": 30, //delay loading of page on startup in seconds
	"url_whitelist": false,
	"whitelist_deny_kiosk_url": false,
	"whitelist_urls": "google.com,android.com",
	"url_blacklist": false,
	"blacklist_urls": "facebook.com",
	"whitelist_redirect": false,
	"whitelist_troubleshoot": false,
	"enable_app_drawer": false,
	"visible_apps": "com.google.android.calculator,com.google.android.calendar",
	"wake_device": false, //scheduled wake
	"device_wake_time": "07:00", //SUNDAY must be valid time string or empty string
        "device_wake_time_monday": "", //must be valid time string or empty string
        "device_wake_time_tuesday": "", //must be valid time string or empty string
        "device_wake_time_wednesday": "", //must be valid time string or empty string
        "device_wake_time_thursday": "", //must be valid time string or empty string
        "device_wake_time_friday": "", //must be valid time string or empty string
        "device_wake_time_saturday": ", //must be valid time string or empty string
	"sleep_device": false, //schedule sleep
	"device_sleep_time": "20:00", //SUNDAY must be valid time string or empty string
        "device_sleep_time_monday": "", //must be valid time string or empty string
        "device_sleep_time_tuesday": "", //must be valid time string or empty string
        "device_sleep_time_wednesday": "", //must be valid time string or empty string
        "device_sleep_time_thursday": "", //must be valid time string or empty string
        "device_sleep_time_friday": "", //must be valid time string or empty string
        "device_sleep_time_saturday": "", //must be valid time string or empty string
	"app_restart": false,
	"app_restart_time": "21:00", //must be valid time string
	"always_wake_device": false,
	"sleep_power_disconnect": false,
	"sleep_power_connect": false, 
        "reboot_device": false, //schedule reboot
	"device_reboot_time": "06:00", //SUNDAY must be valid time string or empty string
	"device_reboot_time_monday": "", //must be valid time string or empty string
        "device_reboot_time_tuesday": "", //must be valid time string or empty string
        "device_reboot_time_wednesday": "", //must be valid time string or empty string
        "device_reboot_time_thursday": "", //must be valid time string or empty string
        "device_reboot_time_friday": "", //must be valid time string or empty string
        "device_reboot_time_saturday": "", //must be valid time string or empty string
	"show_reboot_device_menu": false,
	"disable_safe_mode": false,
	"disable_recents": true, //samsung knox only
	"disable_svoice": true, //samsung knox only
	"hide_status_bar": false, //samsung knox only
	"hide_system_dialogs": true,
	"aggressively_hide_system_dialogs": false,
	"input_resize_page": false,
	"input_resize_page_padding": 0,
	"prevent_submit_keyboard": false,
	"hide_progress_bar": false,
	"require_password": true,
	"multitap_settings": true,
	"hardware_acceleration": true,
	"javascript_interface": true,
	"pause_javascript_timers_on_sleep": false,
	"prevent_alert_dialogs": false,
	"prevent_notification_access": true,
	"barcode_scanner_timeout": 60, //timeout in seconds
	"allow_intents": false,
	"serial_number_source": "DEFAULT", //must be "DEFAULT" OR "RIL_SERIAL_NUMBER" OR RO_SERIAL_NUMBER" OR "SYS_SERIAL_NUMBER"
	"hide_google_play_services_messages": false,
	"allow_popup_windows": false,
	"settings_password": "0000",
        "wifi_settings_password":, "WiFiPassword",
	"above_screen_lock": true,
	"automatic_config_url": "https://www.myconfigurl.com/kbconfig.json",
	"automatic_config_download_frequency": 18 //valid values between 15  and 1440 minutes
}

Updated on: 14/12/2023

Was this article helpful?

Share your feedback

Cancel

Thank you!