Kioskys

MDM-Dokumentation

Kioskys unterstützt die verwaltete App-Konfiguration (Managed App Configuration). Ihr MDM liefert der App ein Plist mit Schlüsseln; jeder gesetzte Schlüssel hat Vorrang vor dem, was der Benutzer eingegeben hat, und der Benutzer kann ihn nicht ändern. Alle Schlüssel sind optional.

Was Sie brauchen

Schlüssel

SchlüsselTypWerteFunktion
kioskURLZeichenfolgeAdresseDie Kiosk-Website. Ohne Schema wird https:// ergänzt (http:// für IPs und das lokale Netzwerk).
autoStartSecondsGanzzahl0, oder 3–120Sekunden des Start-Countdowns. 0 = kein Einstellungsbildschirm, der Kiosk startet sofort. Standard 10.
settingsPINZeichenfolge4–8 ZiffernPIN zum Schutz der Einstellungen. Der Benutzer kann sie weder ändern noch entfernen. Als Zeichenfolge schreiben, damit führende Nullen erhalten bleiben.
allowUserConfigurationBooleschtrue / falsefalse = der Einstellungsbildschirm ist schreibgeschützt. Standard true.
allowedHostsArray von ZeichenfolgenHostnamenZusätzliche Domains, zu denen die Seite navigieren darf (zum Beispiel ein externer Login). Nur Hostnamen, ohne Schema oder Pfad.
allowCameraBooleschtrue / falseGewährt den Seiten der konfigurierten Website die Kamera. Standard true.
allowLocationBooleschtrue / falseGewährt den Standort. Bei false antwortet navigator.geolocation mit „denied“. Standard true.
staleReloadMinutesGanzzahl0–1440Minuten im Hintergrund, nach denen die Seite bei der Rückkehr neu geladen wird. 0 = nie. Standard 0 (aus).
orientationZeichenfolgeauto, portrait, landscapeAusrichtungssperre (portrait und landscape erlauben auch die 180°-Drehung). Standard auto.
energySaverEnabledBooleschtrue / falseEnergiesparmodus: Nach den eingestellten Minuten ohne Berührung wird der Bildschirm auf 5 % abgedunkelt; eine Berührung stellt 100 % wieder her. Standard true.
energySaverMinutesGanzzahl1–120Minuten ohne Berührung vor dem Abdunkeln. Standard 5.
deviceNameZeichenfolge1–80 ZeichenGerätename, für Seiten als window.Kioskys.deviceName sichtbar.
openingHoursDictionarymon … sun, dailyÖffnungszeiten. Jeder Tag ist "HH:mm-HH:mm", "24h" oder "closed"; nicht aufgeführte Tage sind geschlossen, außer daily ist angegeben. Leeres Dictionary = immer geöffnet. Schließzeit vor der Öffnungszeit = geöffnet über Mitternacht hinaus.
closedMessageZeichenfolgebis zu 200 ZeichenText auf dem Ruhebildschirm.
idleResetSecondsGanzzahl0, oder 10–3600Nach dieser Anzahl Sekunden ohne Berührung (oder Tastendruck) kehrt der Kiosk zur ersten Seite zurück. 0 = aus. Standard aus.
idleResetClearDataBooleschtrue / falseLöscht beim Zurücksetzen auch Cookies und Website-Daten. Standard true.
playlistArray von Dictionariestype, url, seconds, mutedPlaylist-Modus: Seiten, Fotos und Videos nacheinander in einer Schleife (bis zu 50). type: page, image oder video; seconds: 3–3600 (0 bei einem Video = bis zum Ende); muted: true schaltet ein Video stumm. Fotos und Videos werden geladen und auf dem iPad gespeichert und laufen daher ohne Verzögerung. Ersetzt kioskURL. Leeres Array = klassischer Kiosk.
closedBrightnessGanzzahl0–100Bildschirmhelligkeit bei Geschlossen (Prozent). Standard 5.
closedMediaDictionarytype, urlEin Foto oder Video, das bei Geschlossen angezeigt wird: {type: image oder video, url}. Es wird geladen und auf dem iPad gespeichert; ein Video wird wiederholt. Leeres Dictionary = Standard-Ruhebildschirm.
bridgeEnabledBooleschtrue / falseDie JavaScript-Bridge (window.Kioskys.scan, beep). Standard true.
disablePageZoomBooleschtrue / falseSperrt den Seitenzoom: Pinch-Geste, Doppeltippen und der Viewport der Seite. Standard true.
scannerCameraZeichenfolgefront, backVon Kioskys.scan() verwendete Kamera. Standard front.
energySaverBrightnessGanzzahl0–100Bildschirmhelligkeit (Prozent), wenn der Energiesparmodus den Bildschirm abgedunkelt hat. Standard 5. Erhöhen Sie sie, wenn Sie einen Bildschirmschoner verwenden.
screensaverEnabledBooleschtrue / falseBildschirmschoner: Solange der Energiesparmodus den Bildschirm abdunkelt, wird statt des Kiosks ein Foto oder Video gezeigt; eine Berührung bringt den Kiosk zurück. Er hat weder einen eigenen Timer noch eine eigene Helligkeit. Standard aus (schaltet sich von selbst ein, wenn Sie screensaverMedia ohne diesen Schlüssel senden).
screensaverMediaDictionarytype, urlFoto oder Video des Bildschirmschoners: {type: image oder video, url}. Es wird geladen und auf dem iPad gespeichert; ein Video wird ohne Ton wiederholt. Leeres Dictionary = kein Inhalt (der Bildschirmschoner startet nicht).
customCSSZeichenfolge≤ 100 000CSS, das jeder Seite der Kiosk-Website (und der Domains aus allowedHosts) hinzugefügt wird, nicht Seiten Dritter, auf die die Website weiterleitet. Wird angewendet, bevor die Seite erscheint.
customJSZeichenfolge≤ 100 000JavaScript, das auf jeder Seite der Kiosk-Website (und der Domains aus allowedHosts) nach dem Laden ausgeführt wird; window.Kioskys ist verfügbar. Fehler landen in der Konsole der Seite. Mit customJS entscheidet Ihr MDM, was im Kiosk läuft: Schreiben Sie es wie den Code Ihrer eigenen Website.

Gut zu wissen

Fertige Dateien

Die Profile tragen bereits die Bundle-ID app.consulenza.kioskys. Erzeugen Sie vor der Verwendung neue UUIDs (uuidgen). Die Kommentare in den Dateien sind auf Englisch.

Beispielkonfiguration

<?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>