Settings Documentation

Remote Management

Enable

Enable/Disable remote management functionality.

Devices

Select the device you wish to configure. If "all devices" is selected then your settings will apply to every device listed.

UI

Fullscreen

This option enables the browser to run in fullscreen mode. For complete fullscreen, you must also disable Tabs Toolbar.

Floating Navigation

When enabled, a floating navigation control will auto appear at the top of the screen when in fullscreen mode.

Tabs Toolbar

Display or hide the tabs toolbar.

Tabs Toolbar Context Menu

Display or hide tabs toolbar context menu when a user right clicks on a tab.

Display or hide the navigation toolbar.

URLBar

Display or hide the urlbar.

URLBar Context Menu

Display or hide the urlbar context menu displayed when a user right clicks on the url input field.

Bookmarks Toolbar

Display or hide the bookmarks toolbar allowing users to add or remove bookmarks during a sesssion.

Bookmarks Context Menu

Allow users to access right click context menu for the bookmarks toolbar where they can add or paste a url to bookmark or add a separator to the toolbar.

Persist Bookmarks

Allow displayed bookmarks to persist across user sessions.

On Screen Keyboard

Enable the on screen keyboard (osk). If the display is a touchscreen, the osk should automatically appear when focus is on a text input control. OSK can also be manually displayed by swiping up from the bottom center of the touchscreen with one finger.

Check for Keyboard

When enabled, the browser at startup will attempt to determine of a keyboard is present on the device. If no keyboard is detected, the osk will automatically display when text input controls receive focus.

OSK Audio

Allow audible click sound when user touches or clicks on an osk key.

OSK Autohide

Set time interval in seconds after which the osk should autohide.

Large Size Notifications

Enable large size user notifications box.

Context Menu

Display or hide context menu when a user right clicks on a web page.

Highlighted Text Search

Display context menu option to search for highlighted text.

Link Status

Display link status at bottom of page when hovering or loading a url.

Toolbar

[document]

Add Bookmark URL

Add a new bookmark url to the bookmarks toolbar.

Bookmark Title

The title to display when adding a new bookmark. If left empty, the url address will be displayed instead.

Remove Bookmark

Remove an existing bookmark that matches the url address provided.

Bookmark Folder Title

Set the title for a new bookmark folder.

Remove Bookmark Folder

Remove the named Bookmark Folder.

Screens

Display Orientation

Choose a screen orientation for your main display (HDMI-1).

Home Page

Set the browser default home page which is loaded at startup and after session reset.

Attract Page

Enable the browser attract page. This page will initially load into fullscreen mode at startup and session resets and will remain displayed until there is a user click or touch event. After which, your configured operating mode will resume. For example, if browser toolbars are configured, they will be displayed to the user and the home page will be loaded.

Attract URL

The URL to load for your attract page. This should be a regular web page or screensaver video page.

Attract Mode

Set the mode type for the attract page to display.

Screensaver Mode

When in screensaver mode, a page with an embeded screensaver video is displayed in fullscreen and will exit when a mouseor touch events are detected.

Sample Screensaver Pages

Choose Screensaver in the Attract Mode dropdown, right clink a link above, copy the link and paste into the Attract Page URL textbox and enable.

Page Mode

This is just any web page you choose for an attract page.

Enable Redirect

When enabled the Redirect URL you provide will be loaded for blocked pages when Filters are enabled to notify users attempting to access prohibited or inaccessible content.

Redirect URL

The url to load to redirect blocked pages to.

Enable AUP

Enable acceptable use policy terms of service agreement page.

AUP URL

The URL for your acceptable use policy terms of service agreement page if applicable.

Enable Dual Display

Enable the use of an additional display for your device. For example a user facing touchscreen. Use HDMI-1 for main screen and HDMI-2 for alternative screen. When enabled, a new window will open in the HDMI-2 screen.

Dual Display URL

This is the URL that will initially load when an additional display is enabled.

Dual Display Configuration

This is the UI configuration available when using an additional display (HDMI-2).

Dual Display Orientation

Choose a screen orientation for your additional display (HDMI-2).

Session

[document]

Timer

Enable session time interval for users before the terminal is reset.

Minutes and Seconds

Set minutes and seconds for session duration.

Countdown Notification

Enable a countdown notification to appear when the session is ending to warn the user and allow them to continue their session.

Countdown Time

Set the countdown time.

Manual Countdown

When a manual reset is triggered by using the key combo Shift+F7 (fn) or the reset session toolbar button, when enabled, will display the countdown notification. If not, the terminal will simply reset.

Cache

Allow web page caching across sessions.

History

Preserve browsing history across sessions.

Cookies

Preserve cookies across sessions.

Filters

[document]

Enable

Enable URL filtering.

Type

Filter Type

Strict Mode

A deep filter check is done on every url resource inside a web page instead of just a top level url location check. This is more secure but prone to break html content if there are page url resources missing in the filter rules.

Display Notification

Display a notification when a blocked page is encountered.

Blocked Page Display

Choose the page type you wish to display when a url is blocked.

Rules

[document]

Javascript

Enable javascript.

Add Block

Enable uBlock Origin content blocker extension.

Protocols

Choose the url protocols you wish to permit users to access.

Access

[document]

Login

Enable terminal access to login, quit, reset controls. When disabled, all local access to the terminal is blocked.

Password

Change the password for local access to settings on the device. This is the password you set for user openkiosk when you installed Debian Linux.

Quit Button Password

Enable to show the password prompt to quit the browser. The quit button is there as a convenience for administrative and development testing purposes. It serves no purpose being user facing.

Use Clean Profile

Use a fresh browser user profile at startup. After enabling, a browser restart is required.

Silent Printing

Enable silent printing.

Print from Web Page

Allow printing from a web page.

Keyboard Shortcuts

Enable browser navigation and or settings keyboard shortcuts.

Keyboard Shortcuts

Downloads

Allow users to download content from the web (insecure).

PDF

Allow the save button to appear on the pdf viewer toolbar. When a user clicks on it, the pdf file will automatically be saved to the Downloads folder.

File Upload

Allow the html file upload control to be displayed in web pages permitting access to the terminal filesystem (insecure).

Page Selection

Allow user selection of web page text.

Start New Session on Settings Exit

Start a new session after exiting device settings.

System

[document]

Device Name

Set a name for the selected device.

Language

Set the browser default language for the device.

Shutdown

Shutdown the device.

Reboot

Reboot the device. If a system OS update is available, system update available notification will appear.

Restart

Restart the browser.

Update

Check for updates and perform an OpenKiosk software update when available.

Media

[document]

Mute

Mute soundon the device.

Volume

Set the volume on the device.

Autoplay

Allow media content to autoplay on webpages.

Actions

Load URL

Load this url into the main display of the browser.

Load Home Page

Use New Tab

Load an action URL into a new tab.

Manual Reset

This action will manually reset the main display. A countdown will be displayed if enabled.

Load Display URL

This action will load the provided url into the secondary display (if connected).