Kioskys

Documentación MDM

Kioskys admite la configuración de app gestionada (Managed App Configuration). Tu MDM entrega a la app un plist de claves; cualquier clave que definas prevalece sobre lo que el usuario haya escrito, y el usuario no puede cambiarla. Todas las claves son opcionales.

Qué necesitas

Claves

ClaveTipoValoresQué hace
kioskURLcadenadirecciónEl sitio del quiosco. Sin esquema se añade https:// (http:// para IP y red local).
autoStartSecondsentero0, o 3–120Segundos de la cuenta atrás al iniciar. 0 = sin pantalla de ajustes, el quiosco arranca enseguida. Por defecto 10.
settingsPINcadena4–8 dígitosPIN que protege los ajustes. El usuario no puede cambiarlo ni quitarlo. Escríbelo como cadena para conservar los ceros iniciales.
allowUserConfigurationbooleanotrue / falsefalse = la pantalla de ajustes es de solo lectura. Por defecto true.
allowedHostsmatriz de cadenasnombres de hostDominios adicionales a los que la página puede navegar (por ejemplo un inicio de sesión externo). Solo nombres de host, sin esquema ni ruta.
allowCamerabooleanotrue / falseConcede la cámara a las páginas del sitio configurado. Por defecto true.
allowLocationbooleanotrue / falseConcede la ubicación. Si es false, navigator.geolocation responde «denegado». Por defecto true.
staleReloadMinutesentero0–1440Minutos en segundo plano tras los cuales la página se recarga al volver. 0 = nunca. Por defecto 0 (desactivado).
orientationcadenaauto, portrait, landscapeBloqueo de orientación (vertical y horizontal permiten también el giro de 180°). Por defecto auto.
energySaverEnabledbooleanotrue / falseAhorro de energía: tras los minutos indicados sin toques el brillo baja al 5 %; un toque lo devuelve al 100 %. Por defecto true.
energySaverMinutesentero1–120Minutos sin toques antes de bajar el brillo. Por defecto 5.
deviceNamecadena1–80 caracteresNombre del dispositivo, visible para las páginas como window.Kioskys.deviceName.
openingHoursdiccionariomon … sun, dailyHorario de apertura. Cada día es "HH:mm-HH:mm", "24h" o "closed"; los días no indicados están cerrados salvo que se dé daily. Diccionario vacío = siempre abierto. Cierre anterior a la apertura = abierto pasada la medianoche.
closedMessagecadenahasta 200 caracteresTexto que se muestra en la pantalla de cierre.
idleResetSecondsentero0, o 10–3600Pasados estos segundos sin toques (ni teclas pulsadas) el quiosco vuelve a su primera página. 0 = desactivado. Por defecto desactivado.
idleResetClearDatabooleanotrue / falseAl restablecer borra también las cookies y los datos del sitio. Por defecto true.
playlistmatriz de diccionariostype, url, seconds, mutedModo lista de reproducción: páginas, fotos y vídeos en rotación, en bucle (hasta 50). type: page, image o video; seconds: 3–3600 (0 en un vídeo = hasta que acabe); muted: true silencia un vídeo. Las fotos y los vídeos se descargan y se guardan en el iPad, así que se reproducen sin retrasos. Sustituye a kioskURL. Matriz vacía = quiosco clásico.
closedBrightnessentero0–100Brillo de la pantalla mientras está cerrado (porcentaje). Por defecto 5.
closedMediadiccionariotype, urlUna foto o un vídeo que se muestra mientras está cerrado: {type: image o video, url}. Se descarga y se guarda en el iPad; el vídeo se repite. Diccionario vacío = pantalla de cierre estándar.
bridgeEnabledbooleanotrue / falseEl puente JavaScript (window.Kioskys.scan, beep). Por defecto true.
disablePageZoombooleanotrue / falseBloquea el zoom de la página: pellizco, doble toque y el viewport de la página. Por defecto true.
scannerCameracadenafront, backCámara que usa Kioskys.scan(). Por defecto front.
energySaverBrightnessentero0–100Brillo de la pantalla (porcentaje) cuando el ahorro de energía la ha atenuado. Por defecto 5. Súbelo si usas un salvapantallas.
screensaverEnabledbooleanotrue / falseSalvapantallas: cuando el ahorro de energía atenúa la pantalla, se muestra una foto o un vídeo en lugar del quiosco; un toque devuelve el quiosco. No tiene temporizador ni brillo propios. Por defecto desactivado (se activa solo si envías screensaverMedia sin esta clave).
screensaverMediadiccionariotype, urlFoto o vídeo del salvapantallas: {type: image o video, url}. Se descarga y se guarda en el iPad; un vídeo se repite, sin sonido. Diccionario vacío = sin contenido (el salvapantallas no se inicia).
customCSScadena≤ 100 000CSS añadido a cada página del sitio del quiosco (y de los dominios de allowedHosts), no a páginas de terceros a las que el sitio redirige. Se aplica antes de que aparezca la página.
customJScadena≤ 100 000JavaScript que se ejecuta en cada página del sitio del quiosco (y de los dominios de allowedHosts) una vez cargada; window.Kioskys está disponible. Los errores van a la consola de la página. Con customJS tu MDM decide qué se ejecuta en el quiosco: escríbelo como el código de tu propio sitio.

Conviene saber

Archivos listos

Los perfiles ya llevan el Bundle ID app.consulenza.kioskys. Regenera sus UUID (uuidgen) antes de usarlos. Los comentarios de los archivos están en inglés.

Configuración de ejemplo

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