Quick Start Guide

Welcome

Welcome to Kiosk{ed}! Our goal is to help you quickly get your bearings and to answer your questions about using Kiosk{ed} to deliver even your most sensitive educational content.

Your questions, feedback and comments are always appreciated. Click the Feedback button on the right of any topic to let us know your opinions. We want to deliver what you need to succeed.

The best way to see Kiosk{ed} is to try it! Download our demo app, load any website, and take a look at our browser in action. This app is a great way to test the primary Kiosk{ed} features.

In this article, you can explore the Kiosk{ed} capabilities and interface, review the supported platforms, and learn about integration and building your custom applications.


Key Capabilities

The Kiosk{ed} browser is a stable platform for you to deliver great education content. We deal with the ever changing world of new devices and OS updates and work hard to provide a consistent experience across them all. With Kiosk{ed}, you can:

Securely deliver content using Lockdown Mode.
Leverage the latest in web technologies with our Modern Browser.
Ensure devices meet minimum requirements with our Startup Checks.
Advanced options are available through a secret Proctor Panel.
Power up your app with the integrated JavaScript API.


Supported Platforms

Supporting all the devices found in the wild can be a challenge. We provide a consistent experience across all devices with the feel of a native app for each platform. We continue to expand our supported platforms. If a platform you need is not listed, let us know.

  • macOS: version 10.9 or later.
  • Windows: Windows 7 or later.
  • Chrome OS: version 61 or later.
  • iOS: version 9.3.2 or later. 10.2.1 or later is recommended.

Linux support coming soon. Android support is planned.


User Interface

The focus is on the content not the interface. The Kiosk{ed} interface is straightforward, intuitive and simple to navigate. This diagram shows your content represented with the blue background.

Program Flow

The opening view displays your branding and a progress bar, providing feedback for the user while downloading server-side assets. We perform system checks to ensure the device meets all requirements. If a device fails, we display a summary of the issue and if possible, give the user an opportunity to resolve it and rerun the check. Refer to Startup Checks for details.

Your web application is launched in a full-screen browser. If the user enters a section that should be secured, you can enter lockdown mode with a JavaScript call to kiosk.lock(). Alternatively, you can use the AutoLock configuration property to enter lockdown mode when the application is launched. Refer to Securing a Device for details. In lockdown mode, all browser and OS functions such as toolbars and menus are hidden from the user.

Kiosk{ed} provides detailed feedback whenever a startup check fails or if network or security issues are detected during a test. If something goes wrong in lockdown mode, the proctor can gracefully unlock and exit. Refer to Troubleshooting for a list of possible errors.

The Proctor Panel is accessible to proctors and administrators to access functionality not displayed to a student. To access this hidden panel, a special key or touch combination is required along with a passcode.


Integration

Integration is easy and can be done with zero work on your end. You can take advantage of the extended functionality Kiosk{ed} provides on your schedule. For example, using the AutoLock build option secures your application from the moment it is launched and requires no code changes. Or, you can choose to control when locking and unlocking occurs by calling those methods when appropriate in your application.

Kiosk{ed} automatically injects a JavaScript object into your code with all the built-in methods you need. Here is an example of locking down a device before entering a secure section of your application.

kiosk.lock((success) => {
    
    // If successfully locked
    if (success) {
        console.log("Now in lockdown mode.")
    } else {
        console.log("Unable to lockdown device.")
    }

})

For a list of the latest methods available, refer to the JavaScript API article.


Building Apps

This process is currently managed by us. We need basic information to create your custom application. In the future, an automated process will enable you to create your own builds.

Here is the information we need to start building your custom application:

Property Description Required
Application Name Short name of your application Yes
Application ID app.company.com format identifier No
Icon High resolution png for your app (1024x1024) Yes
URL Address of your web application Yes
AutoLock Set to true if you want your app to lock on start Yes

Once we have your details we usually create your custom applications in two to three business days.


Deploying Apps

For each build we provide the native installers required for each platform. We are happy to manage the deployment to web stores for you.

OS Installer Description
macOS .dmg file
Windows .exe (32-bit executable) and .msi installer
Chromebook Archive file to be uploaded on Google Play
iOS Archive file to be uploaded on the App Store

If you or one of your customers require deploying the application across a network of computers, let us know. We can help you with instructions for network installs.

2018 © Learning Logistics. All Rights Reserved.