Kioskys

Documentation MDM

Kioskys prend en charge la configuration d’app gérée (Managed App Configuration). Votre MDM remet à l’app un plist de clés ; toute clé définie l’emporte sur ce que l’utilisateur a saisi, et il ne peut pas la modifier. Toutes les clés sont facultatives.

Ce qu’il faut

Clés

CléTypeValeursCe que ça fait
kioskURLchaîneadresseLe site du kiosque. Sans schéma, https:// est ajouté (http:// pour les IP et le réseau local).
autoStartSecondsentier0, ou 3–120Secondes du compte à rebours au démarrage. 0 = pas d’écran de réglages, le kiosque démarre tout de suite. Par défaut 10.
settingsPINchaîne4–8 chiffresCode PIN qui protège les réglages. L’utilisateur ne peut ni le changer ni le retirer. À écrire comme une chaîne pour garder les zéros initiaux.
allowUserConfigurationbooléentrue / falsefalse = l’écran des réglages est en lecture seule. Par défaut true.
allowedHoststableau de chaînesnoms d’hôteDomaines supplémentaires vers lesquels la page peut naviguer (par exemple une connexion externe). Noms d’hôte seulement, sans schéma ni chemin.
allowCamerabooléentrue / falseAccorde la caméra aux pages du site configuré. Par défaut true.
allowLocationbooléentrue / falseAccorde la position. Si false, navigator.geolocation répond « refusé ». Par défaut true.
staleReloadMinutesentier0–1440Minutes passées en arrière-plan après lesquelles la page se recharge au retour. 0 = jamais. Par défaut 0 (désactivé).
orientationchaîneauto, portrait, landscapeVerrouillage de l’orientation (portrait et paysage autorisent aussi la rotation de 180°). Par défaut auto.
energySaverEnabledbooléentrue / falseÉconomie d’énergie : après les minutes définies sans toucher, l’écran passe à 5 % de luminosité ; un toucher rétablit 100 %. Par défaut true.
energySaverMinutesentier1–120Minutes sans toucher avant de baisser la luminosité. Par défaut 5.
deviceNamechaîne1–80 caractèresNom de l’appareil, visible par les pages sous la forme window.Kioskys.deviceName.
openingHoursdictionnairemon … sun, dailyHoraires d’ouverture. Chaque jour vaut "HH:mm-HH:mm", "24h" ou "closed" ; les jours non indiqués sont fermés sauf si daily est donné. Dictionnaire vide = toujours ouvert. Fermeture avant l’ouverture = ouvert après minuit.
closedMessagechaînejusqu’à 200 caractèresTexte affiché sur l’écran de fermeture.
idleResetSecondsentier0, ou 10–3600Après ce nombre de secondes sans toucher (ni touche pressée), le kiosque revient à sa première page. 0 = désactivé. Par défaut désactivé.
idleResetClearDatabooléentrue / falseEfface aussi les cookies et les données du site lors de la réinitialisation. Par défaut true.
playlisttableau de dictionnairestype, url, seconds, mutedMode liste de lecture : pages, photos et vidéos affichées tour à tour, en boucle (jusqu’à 50). type : page, image ou video ; seconds : 3–3600 (0 pour une vidéo = jusqu’à la fin) ; muted : true coupe le son d’une vidéo. Photos et vidéos sont téléchargées et enregistrées sur l’iPad, donc lues sans délai. Remplace kioskURL. Tableau vide = kiosque classique.
closedBrightnessentier0–100Luminosité de l’écran en période de fermeture (pourcentage). Par défaut 5.
closedMediadictionnairetype, urlUne photo ou une vidéo affichée pendant la fermeture : {type : image ou video, url}. Elle est téléchargée et enregistrée sur l’iPad ; la vidéo se répète. Dictionnaire vide = écran de fermeture standard.
bridgeEnabledbooléentrue / falseLe pont JavaScript (window.Kioskys.scan, beep). Par défaut true.
disablePageZoombooléentrue / falseBloque le zoom de la page : pincement, double toucher et viewport de la page. Par défaut true.
scannerCamerachaînefront, backCaméra utilisée par Kioskys.scan(). Par défaut front.
energySaverBrightnessentier0–100Luminosité de l’écran (en pourcentage) lorsque l’économie d’énergie l’a assombri. Par défaut 5. À augmenter si vous utilisez un économiseur d’écran.
screensaverEnabledbooléentrue / falseÉconomiseur d’écran : quand l’économie d’énergie assombrit l’écran, une photo ou une vidéo s’affiche à la place du kiosque ; un toucher ramène le kiosque. Il n’a ni minuterie ni luminosité propres. Par défaut désactivé (il s’active tout seul si vous envoyez screensaverMedia sans cette clé).
screensaverMediadictionnairetype, urlPhoto ou vidéo de l’économiseur d’écran : {type : image ou video, url}. Elle est téléchargée et enregistrée sur l’iPad ; une vidéo se répète, sans son. Dictionnaire vide = aucun contenu (l’économiseur ne démarre pas).
customCSSchaîne≤ 100 000CSS ajouté à chaque page du site du kiosque (et des domaines de allowedHosts), pas aux pages tierces vers lesquelles le site redirige. Il s’applique avant l’affichage de la page.
customJSchaîne≤ 100 000JavaScript exécuté sur chaque page du site du kiosque (et des domaines de allowedHosts) une fois chargée ; window.Kioskys est disponible. Les erreurs vont dans la console de la page. Avec customJS, votre MDM décide de ce qui s’exécute dans le kiosque : écrivez-le comme le code de votre propre site.

À savoir

Fichiers prêts à l’emploi

Les profils portent déjà le Bundle ID app.consulenza.kioskys. Régénérez leurs UUID (uuidgen) avant usage. Les commentaires des fichiers sont en anglais.

Exemple de configuration

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