MDM-dokumentation
Kioskys understøtter administreret appkonfiguration (Managed App Configuration). Din MDM leverer en plist med nøgler til appen; hver nøgle, du angiver, går forud for det, brugeren har skrevet, og brugeren kan ikke ændre den. Alle nøgler er valgfrie.
Det skal du bruge
- En overvåget iPad, der er tilmeldt din MDM (kræves til Single App Mode).
- Kioskys købt i volumen i Apple Business Manager (betalt app, tildelt dine enheder eller brugere) og installeret af MDM som administreret app: Konfigurationen leveres kun til administrerede apps.
- Appens Bundle ID: app.consulenza.kioskys (det samme for alle, du behøver ikke ændre det).
Nøgler
| Nøgle | Type | Værdier | Hvad den gør |
|---|---|---|---|
kioskURL | streng | adresse | Kiosk-webstedet. Uden skema tilføjes https:// (http:// for IP-adresser og lokalt netværk). |
autoStartSeconds | heltal | 0, eller 3–120 | Sekunder for nedtællingen ved start. 0 = ingen indstillingsskærm, kiosken starter med det samme. Standard 10. |
settingsPIN | streng | 4–8 cifre | Pinkode, der beskytter indstillingerne. Brugeren kan ikke ændre eller fjerne den. Skriv den som en streng for at bevare indledende nuller. |
allowUserConfiguration | boolesk | true / false | false = indstillingsskærmen er skrivebeskyttet. Standard true. |
allowedHosts | array af strenge | værtsnavne | Ekstra domæner, som siden må navigere til (for eksempel et eksternt login). Kun værtsnavne, uden skema eller sti. |
allowCamera | boolesk | true / false | Giver siderne på det konfigurerede websted adgang til kameraet. Standard true. |
allowLocation | boolesk | true / false | Giver adgang til lokaliteten. Ved false svarer navigator.geolocation "denied". Standard true. |
staleReloadMinutes | heltal | 0–1440 | Minutter i baggrunden, hvorefter siden genindlæses ved tilbagevenden. 0 = aldrig. Standard 0 (fra). |
orientation | streng | auto, portrait, landscape | Retningslås (portrait og landscape tillader også 180°-vending). Standard auto. |
energySaverEnabled | boolesk | true / false | Strømsparetilstand: efter de angivne minutter uden berøring dæmpes skærmen til 5 %; en berøring genopretter 100 %. Standard true. |
energySaverMinutes | heltal | 1–120 | Minutter uden berøring, før skærmen dæmpes. Standard 5. |
deviceName | streng | 1–80 tegn | Enhedsnavn, synligt for sider som window.Kioskys.deviceName. |
openingHours | dictionary | mon … sun, daily | Åbningstider. Hver dag er "HH:mm-HH:mm", "24h" eller "closed"; dage, der ikke er angivet, er lukkede, medmindre daily er angivet. Tom dictionary = altid åben. Lukning før åbning = åben efter midnat. |
closedMessage | streng | op til 200 tegn | Tekst, der vises på lukket-skærmen. |
idleResetSeconds | heltal | 0, eller 10–3600 | Efter så mange sekunder uden berøring (eller tastetryk) vender kiosken tilbage til sin første side. 0 = fra. Standard fra. |
idleResetClearData | boolesk | true / false | Rydder også cookies og webstedsdata ved nulstilling. Standard true. |
playlist | array af dictionaries | type, url, seconds, muted | Afspilningslistetilstand: sider, fotos og videoer efter tur i en løkke (op til 50). type: page, image eller video; seconds: 3–3600 (0 for en video = til slutningen); muted: true slår lyden fra på en video. Fotos og videoer hentes og gemmes på iPad'en, så de afspilles uden forsinkelse. Erstatter kioskURL. Tom array = klassisk kiosk. |
closedBrightness | heltal | 0–100 | Skærmens lysstyrke, når der er lukket (procent). Standard 5. |
closedMedia | dictionary | type, url | Et foto eller en video, der vises, når der er lukket: {type: image eller video, url}. Det hentes og gemmes på iPad'en; en video gentages. Tom dictionary = standard lukket-skærm. |
bridgeEnabled | boolesk | true / false | JavaScript-broen (window.Kioskys.scan, beep). Standard true. |
disablePageZoom | boolesk | true / false | Blokerer sidezoom: knib, dobbelttryk og sidens viewport. Standard true. |
scannerCamera | streng | front, back | Kamera, der bruges af Kioskys.scan(). Standard front. |
energySaverBrightness | heltal | 0–100 | Skærmens lysstyrke (procent), når strømbesparelse har dæmpet skærmen. Standard 5. Hæv den, hvis du bruger en pauseskærm. |
screensaverEnabled | boolesk | true / false | Pauseskærm: når strømbesparelse dæmper skærmen, vises et foto eller en video i stedet for kiosken; et tryk bringer kiosken tilbage. Den har ingen egen timer eller lysstyrke. Standard fra (slås til af sig selv, hvis du sender screensaverMedia uden denne nøgle). |
screensaverMedia | dictionary | type, url | Pauseskærmens foto eller video: {type: image eller video, url}. Hentes og gemmes på iPad’en; en video gentages uden lyd. Tom dictionary = intet indhold (pauseskærmen starter ikke). |
customCSS | streng | ≤ 100 000 | CSS, der føjes til hver side på kioskwebstedet (og på domænerne i allowedHosts), ikke til tredjepartssider, som webstedet omdirigerer til. Anvendes, før siden vises. |
customJS | streng | ≤ 100 000 | JavaScript, der køres på hver side på kioskwebstedet (og på domænerne i allowedHosts), når den er indlæst; window.Kioskys er tilgængelig. Fejl havner i sidens konsol. Med customJS bestemmer din MDM, hvad der kører i kiosken: skriv det som koden på dit eget websted. |
Godt at vide
- Tal og booleske værdier sendt som strenge ("10", "true") accepteres. Ugyldige værdier ignoreres og rapporteres, de ødelægger aldrig appen.
- settingsPIN står i klartekst i profilen (administratorer i MDM kan se den). Appen gemmer den ikke på enheden.
- Ændringer i MDM anvendes, mens appen er åben; en ny adresse genindlæser siden.
- Appen rapporterer sin status i com.apple.feedback.managed (version, adresse, side indlæst, status for tilladelser til kamera og lokalitet, konfigurationsproblemer).
- Kioskys holder iPad'en vågen, mens appen er i forgrunden. For at forhindre, at nogen forlader appen, skal du bruge Single App Mode.
- Fem hurtige tryk i det øverste venstre hjørne åbner indstillingerne igen (skrivebeskyttet, hvis allowUserConfiguration er false; en eventuel settingsPIN spørges der om først).
- De samme nøgler virker også uden MDM: siden QR-konfigurator omdanner dem til en QR-kode, der kopierer indstillingerne til en iPad. Det, en MDM angiver, gælder altid, og brugeren kan ikke ændre det.
Færdige filer
Profilerne har allerede Bundle ID app.consulenza.kioskys. Opret nye UUID'er (uuidgen) før brug. Kommentarerne i filerne er på engelsk.
- Appkonfiguration (alle nøgler)
- Profil til Single App Mode (MDM låser iPad'en til Kioskys)
- Profil til Autonomous Single App Mode (appen låser sig selv)
Eksempelkonfiguration
<?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>