Create and deploy Chrome kiosk apps

This article is for Chrome administrators and developers with experience developing Chrome apps.

As a Chrome administrator, you can turn ChromeOS devices into single-purpose devices, such as a digital sign or interactive display. You can deploy off-the-shelf kiosk apps from the Chrome Web Store or you can build your own kiosk app.

In Chrome version 57 and later, some ChromeOS devices support Android apps. For information about how to install Android apps on managed Chrome devices, see Use Android apps on Chrome devices running as a kiosk.

Considerations

• Before you can deploy kiosk apps on ChromeOS devices, you need to enroll the devices. For details, see Enroll ChromeOS devices.
• You can use Chrome packaged apps to build kiosk apps. But, you can’t use hosted apps.
• Use Chrome apps that are set up to run on a full screen.
• Follow the Chrome app development best practices.

Step 1: Build a Chrome kiosk app

As a developer, there are 2 ways to build a kiosk app that you can deploy on Chrome devices. Use an existing web app and Chrome App Builder to package it as a kiosk app or create a new web app.

Option 1: Use an existing web app

Before you begin: On the computer where you’re building the kiosk app, add Chrome App Builder to Chrome browser.

1. On the computer where you’re building the app, create a folder for the app’s files.
2. Open Chrome App Builder.
3. Enter the app name and initial version.
   Make the initial version a low number, such as 0.0.0.1, so you have room to increase the number for new versions.
4. Enter the URL of the app’s current homepage.
   The URL will be the landing page for the new kiosk app.
5. Choose navigation controls, such as back, forward, reload, and restart session.
6. Specify timeout values:
   • Session idle timeout—Amount of time the app is idle before browsing data is cleared.
   • Timeout to return home—Amount of time the app is idle before returning to the homepage. Browsing data is not cleared.
     The default for Session idle timeout and Timeout to return home is zero minutes—the app doesn’t time out.
7. (Optional) To specify a Terms of Service for app users, enter the text.
8. (Optional) To rotate the homepage to fit the device where it will run, select a value.
   For example, rotate an app 90 degrees to run it on a device that’s set with a portrait layout.
9. Select Kiosk mode enabled.
10. Click Export kiosk app.
11. Choose where you want to export the app files and click Select.

After you create a kiosk app with Chrome App Builder, you can customize it by adding more files.

Option 2: Build a new app

Use the sample files provided in the steps below to build a simple kiosk app.

1. On the computer where you’re building the app, create a folder for the app’s files. 
2. Create the app’s HTML file.
   1. Using a text editor, create an HTML file.
      Here is a sample HTML file.
   2. In the app folder, save the file as application.html.
3. Create the manifest.
   1. Using a text editor, create a JavaScript Object Notation (JSON) file. Here is a sample JSON file.
   2. Make sure that kiosk_enabled is set to true, "kiosk_enabled": true.
   3. (Optional) To prevent an app being run as a regular app, set kiosk_only to true, "kiosk_only": true.
   4. (Optional) To speed up the time it takes for webpages to initially load in the kiosk app's webview control, specify partition="persist:" in the webview tag.
      For details, see developer information for the partition attribute.
   5. Make sure the JSON code is formatted correctly with the third-party JSON validation tool of your choice.
   6. In the app folder, save the file as manifest.json.
4. Specify the height and width of the app.
   1. Using a text editor, create a CSS file. Here is a sample CSS file.
   2. In the app folder, save the file as application.css.
      Note: Kiosk apps automatically expand to full screen.
5. (Optional) To let users end the kiosk session:
   1. Using a text editor, create a JavaScript file. Here is a sample JS file.
   2. In the app folder, save the file as application.js.
6. Create the background script:
   1. Using a text editor, create a JavaScript file. Here is a sample JS file.
   2. In the app folder, save the file as background.js.
7. Create the app icons for the app and save them in the app folder:
   1. Create a 128 by 128p icon and save it as 128.png.
   2. Create a 96 by 96p icon and save it as 96.png.

Alternatively, use this sample zip file that contains app files for a test app with navigation controls and a reset button. A live version of the app, Chrome browser Kiosk App 1.0, is published in the Chrome Web Store. You can edit the files with any text editor.

Step 2. Test the kiosk app

As a developer, make sure your that kiosk app works on a ChromeOS device.

1. On a Chrome device, sign in to your Google Account.
2. Save the app folder on your test device.
3. Go to chrome://extensions/.
4. At the top right, turn on Developer mode.
5. Click Load unpacked.
6. Find and select the app folder.
7. Open a new tab in Chrome browser and click Apps  the app. Make sure it loads and works correctly.
8. If needed, make changes in the manifest.json file, host the app folder, and retest it. Repeat until the app works correctly.

Step 3: Publish in the Chrome Web Store

As a developer, you can choose to make apps and extensions available for everyone or control who can install them. There are 2 ways you can publish kiosk apps in the Chrome Web Store:

• Public—Everyone can see and install the app.
• Unlisted—Only users with the app link can see and install it. The app doesn’t appear in the Chrome Web Store search results. You can share the app link with users outside of your domain.

To add a kiosk app in the Chrome Web Store:

1. Zip the folder that contains your files.
2. Follow the steps in Publish in the Chrome Web Store. 

Step 4: Deploy the kiosk app

As an admin, you can add the kiosk app in the Google Admin console.​

1. Sign in to your Google Admin console.

   Sign in using your administrator account (does not end in @gmail.com).

2. In the Admin console, go to Menu  DevicesChromeApps & extensionsKiosks.
3. To apply the setting to all users, leave the top organizational unit selected. Otherwise, select a child organizational unit.
4. Point to Add and click Add from Chrome Web Store.
5. Search for the app that you want to deploy and click Select.
6. If prompted, accept the app permissions on behalf of your organization.
7. In the panel on the right, set the app and extension policies. Learn about each setting.
8. Click Save.

Related topics

• Kiosk apps
• Create your first app
• Kiosk settings
• Manage Chrome kiosk app settings
• Schedule and display content with Chrome Sign Builder

Google and related marks and logos are trademarks of Google LLC. All other company and product names are trademarks of the companies with which they are associated.