Kioskys

MDM-dokumentation

Kioskys stöder hanterad appkonfiguration (Managed App Configuration). Ditt MDM levererar en plist med nycklar till appen; varje nyckel du anger går före det användaren har skrivit, och användaren kan inte ändra den. Alla nycklar är valfria.

Det här behöver du

Nycklar

NyckelTypVärdenVad den gör
kioskURLsträngadressKiosk-webbplatsen. Utan schema läggs https:// till (http:// för IP-adresser och lokalt nätverk).
autoStartSecondsheltal0, eller 3–120Sekunder för nedräkningen vid start. 0 = ingen inställningsskärm, kiosken startar direkt. Standard 10.
settingsPINsträng4–8 siffrorPIN-kod som skyddar inställningarna. Användaren kan inte ändra eller ta bort den. Skriv den som en sträng så att inledande nollor bevaras.
allowUserConfigurationboolesktrue / falsefalse = inställningsskärmen är skrivskyddad. Standard true.
allowedHostsarray av strängarvärdnamnExtra domäner som sidan får navigera till (till exempel en extern inloggning). Endast värdnamn, inget schema eller sökväg.
allowCameraboolesktrue / falseGer sidorna på den konfigurerade webbplatsen tillgång till kameran. Standard true.
allowLocationboolesktrue / falseGer tillgång till platsen. Vid false svarar navigator.geolocation "denied". Standard true.
staleReloadMinutesheltal0–1440Minuter i bakgrunden efter vilka sidan laddas om vid återkomst. 0 = aldrig. Standard 0 (av).
orientationsträngauto, portrait, landscapeOrienteringslås (portrait och landscape tillåter också 180°-vändning). Standard auto.
energySaverEnabledboolesktrue / falseEnergisparläge: efter de inställda minuterna utan beröring dimmas skärmen till 5 %; en beröring återställer 100 %. Standard true.
energySaverMinutesheltal1–120Minuter utan beröring innan skärmen dimmas. Standard 5.
deviceNamesträng1–80 teckenEnhetsnamn, synligt för sidor som window.Kioskys.deviceName.
openingHoursdictionarymon … sun, dailyÖppettider. Varje dag är "HH:mm-HH:mm", "24h" eller "closed"; dagar som inte anges är stängda om inte daily anges. Tom dictionary = alltid öppet. Stängning före öppning = öppet efter midnatt.
closedMessagesträngupp till 200 teckenText som visas på stängd-skärmen.
idleResetSecondsheltal0, eller 10–3600Efter så här många sekunder utan beröring (eller tangenttryckning) återgår kiosken till sin första sida. 0 = av. Standard av.
idleResetClearDataboolesktrue / falseRensar även cookies och webbplatsdata vid återställning. Standard true.
playlistarray av dictionariestype, url, seconds, mutedSpellisteläge: sidor, foton och videor i tur och ordning i en slinga (upp till 50). type: page, image eller video; seconds: 3–3600 (0 för en video = till slutet); muted: true tystar en video. Foton och videor hämtas och sparas på iPad, så de spelas utan fördröjning. Ersätter kioskURL. Tom array = klassisk kiosk.
closedBrightnessheltal0–100Skärmens ljusstyrka när det är stängt (procent). Standard 5.
closedMediadictionarytype, urlEtt foto eller en video som visas när det är stängt: {type: image eller video, url}. Det hämtas och sparas på iPad; en video upprepas. Tom dictionary = standardskärmen för stängt.
bridgeEnabledboolesktrue / falseJavaScript-bryggan (window.Kioskys.scan, beep). Standard true.
disablePageZoomboolesktrue / falseBlockerar sidzoom: nypning, dubbeltryck och sidans viewport. Standard true.
scannerCamerasträngfront, backKamera som används av Kioskys.scan(). Standard front.
energySaverBrightnessheltal0–100Skärmens ljusstyrka (procent) när energisparläget har dämpat skärmen. Standard 5. Höj den om du använder en skärmsläckare.
screensaverEnabledboolesktrue / falseSkärmsläckare: när energisparläget dämpar skärmen visas ett foto eller en video i stället för kiosken; en beröring tar tillbaka kiosken. Den har ingen egen timer eller ljusstyrka. Standard av (slås på av sig själv om du skickar screensaverMedia utan den här nyckeln).
screensaverMediadictionarytype, urlSkärmsläckarens foto eller video: {type: image eller video, url}. Hämtas och sparas på iPad; en video upprepas, utan ljud. Tom dictionary = inget innehåll (skärmsläckaren startar inte).
customCSSsträng≤ 100 000CSS som läggs till på varje sida på kiosksajten (och på domänerna i allowedHosts), inte på tredjepartssidor som sajten omdirigerar till. Tillämpas innan sidan visas.
customJSsträng≤ 100 000JavaScript som körs på varje sida på kiosksajten (och på domänerna i allowedHosts) när den har laddats; window.Kioskys finns tillgängligt. Fel hamnar i sidans konsol. Med customJS bestämmer din MDM vad som körs i kiosken: skriv det som koden på din egen sajt.

Bra att veta

Färdiga filer

Profilerna har redan Bundle ID app.consulenza.kioskys. Skapa nya UUID:n (uuidgen) före användning. Kommentarerna i filerna är på engelska.

Exempelkonfiguration

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<!--
  Kioskys - Managed App Configuration
  Paste this dictionary into the "App Configuration" field of your MDM, for the app with the Bundle ID
  app.consulenza.kioskys. All keys are optional: keep only the ones you need.
  A key that is present wins over what the user set by hand, and the user cannot change it.
-->
<plist version="1.0">
<dict>
	<!-- Kiosk address. Without a scheme https:// is added (http:// for IPs and local network). -->
	<key>kioskURL</key>
	<string>https://example.org/kiosk</string>

	<!-- Seconds of the start countdown: 0 = no settings screen, the kiosk starts immediately; otherwise 3-120. -->
	<key>autoStartSeconds</key>
	<integer>0</integer>

	<!-- PIN protecting the settings (string of 4-8 digits). The user cannot change or remove it.
	     Note: it is in clear text inside the profile (MDM administrators can see it). It is not stored on the device. -->
	<key>settingsPIN</key>
	<string>4821</string>

	<!-- false = the settings screen is read-only (no local changes). Default: true. -->
	<key>allowUserConfiguration</key>
	<true/>

	<!-- Extra domains the page may navigate to (e.g. an external login). Host names only, no https:// and no paths. -->
	<key>allowedHosts</key>
	<array>
		<string>login.example.com</string>
	</array>

	<!-- Camera and location granted to the pages of the configured site. Default: true. -->
	<key>allowCamera</key>
	<true/>
	<key>allowLocation</key>
	<true/>

	<!-- Minutes in the background after which the page reloads on return (0 = never). Default: 0. -->
	<key>staleReloadMinutes</key>
	<integer>0</integer>

	<!-- Screen orientation lock: auto (free), portrait or landscape.
	     Portrait and landscape also allow the 180-degree flip. Default: auto. -->
	<key>orientation</key>
	<string>landscape</string>

	<!-- Energy Saver: after energySaverMinutes without touches the brightness drops to energySaverBrightness (default 5%); a touch restores 100%.
	     Default: on, 5 minutes. Minutes: 1 to 120. Brightness: 0 to 100. -->
	<key>energySaverEnabled</key>
	<true/>
	<key>energySaverMinutes</key>
	<integer>5</integer>
	<key>energySaverBrightness</key>
	<integer>30</integer>

	<!-- Device name, visible to pages as window.Kioskys.deviceName (max 80 characters). -->
	<key>deviceName</key>
	<string>Warehouse iPad 1</string>
	<!-- Opening hours: mon..sun (or daily) as "HH:mm-HH:mm", "24h" or "closed". Days not listed are closed unless daily is given.
	     An empty dictionary means always open. Outside the hours the kiosk shows a closed screen at minimum brightness. -->
	<key>openingHours</key>
	<dict>
		<key>daily</key>
		<string>08:00-20:00</string>
		<key>sun</key>
		<string>closed</string>
	</dict>
	<key>closedMessage</key>
	<string>We are closed. See you tomorrow!</string>
	<!-- Closed screen: brightness in percent (default 5) and an optional photo or video that is downloaded and saved on the iPad.
	     Use <dict/> for the standard closed screen (moon and message). -->
	<key>closedBrightness</key>
	<integer>40</integer>
	<key>closedMedia</key>
	<dict>
		<key>type</key><string>image</string>
		<key>url</key><string>https://example.org/closed.jpg</string>
	</dict>
	<!-- Inactivity reset: after this many seconds without touches the kiosk returns to its first page (0 = off; 10-3600). -->
	<key>idleResetSeconds</key>
	<integer>120</integer>
	<key>idleResetClearData</key>
	<true/>
	<!-- Playlist: pages, photos and videos shown in turn, in a loop (up to 50). It replaces kioskURL when present; an empty array = no playlist.
	     seconds: 3-3600; for a video 0 means "until it ends". -->
	<key>playlist</key>
	<array>
		<dict>
			<key>type</key><string>page</string>
			<key>url</key><string>https://example.org/menu</string>
			<key>seconds</key><integer>30</integer>
		</dict>
		<dict>
			<key>type</key><string>image</string>
			<key>url</key><string>https://example.org/offer.jpg</string>
			<key>seconds</key><integer>10</integer>
		</dict>
		<dict>
			<key>type</key><string>video</string>
			<key>url</key><string>https://example.org/promo.mp4</string>
			<key>seconds</key><integer>0</integer>
			<key>muted</key><true/>
		</dict>
	</array>
	<!-- JavaScript bridge (window.Kioskys.scan / beep) and the camera used for scanning: front or back. -->
	<key>bridgeEnabled</key>
	<true/>
	<!-- Blocks page zoom: pinch, double-tap and the page's own viewport. Default: true. -->
	<key>disablePageZoom</key>
	<true/>
	<key>scannerCamera</key>
	<string>front</string>
	<!-- Screensaver: while the Energy Saver has dimmed the screen (energySaverMinutes/energySaverBrightness) this photo or video is shown; a touch brings the kiosk back. It has no timer of its own. -->
	<key>screensaverEnabled</key>
	<true/>
	<key>screensaverMedia</key>
	<dict>
		<key>type</key><string>video</string>
		<key>url</key><string>https://example.org/screensaver.mp4</string>
	</dict>
	<!-- Custom CSS and JavaScript, applied to the pages of the kiosk site (not to third-party pages). Up to 100000 characters each. -->
	<key>customCSS</key>
	<string>.cookie-banner { display: none !important; }</string>
	<key>customJS</key>
	<string>document.documentElement.classList.add('kiosk');</string>
</dict>
</plist>