Configuration

All settings are stored in the site configuration (config/sites/<your-site>/config.yaml). Edit them in the backend module Sites > Setup (TYPO3 v14). The extension adds four tabs:

PWA Manifest – basic data and icons
PWA Manifest Shortcuts – up to three shortcuts
PWA Manifest Screenshots – up to three screenshots
PWA Offline / Service Worker – see Offline support / service worker

Shortcuts and screenshots are provided as three fixed field groups each.

Empty fields are omitted from the manifest. If no field is filled, the manifest is an empty JSON array ([]).

Basic manifest data

Tab PWA Manifest, palette PWA Manifest name.

Site configuration tab "PWA Manifest" — Basic manifest data and icons

Name	Type
WitPwamanifestShortName	string
WitPwamanifestName	string
WitPwamanifestStartUrl	string
WitPwamanifestScope	string
WitPwamanifestId	string
WitPwamanifestDisplay	string
WitPwamanifestbackgroundColor	string (color)
WitPwamanifestThemeColor	string (color)
WitPwamanifestDescription	string
WitPwamanifestSmallIconPath	string
WitPwamanifestSmallIconType	string
WitPwamanifestSmallIconSize	string
WitPwamanifestBigIconPath	string
WitPwamanifestBigIconType	string
WitPwamanifestBigIconSize	string
WitPwamanifestShortcutsNName	string
WitPwamanifestShortcutsNShortName	string
WitPwamanifestShortcutsNDescription	string
WitPwamanifestShortcutsNUrl	string (link)
WitPwamanifestShortcutsNIconSrc	string
WitPwamanifestShortcutsNIconSizes	string
WitPwamanifestScreenshotNSrc	string
WitPwamanifestScreenshotNType	string
WitPwamanifestScreenshotNSize	string
WitPwamanifestScreenshotNFormFactor	string

WitPwamanifestShortName

Type: string

Label Short Name. Manifest member short_name.

WitPwamanifestName

Type: string

Label Name. Manifest member name.

WitPwamanifestStartUrl

Type: string

Label Start Url. Manifest member start_url. Also used as offline fallback when no offline page is set.

WitPwamanifestScope

Type: string

Label Scope. Manifest member scope.

WitPwamanifestId

Type: string

Label Id. Manifest member id.

WitPwamanifestDisplay

Type: string

Label Display. Manifest member display. Allowed values: standalone, fullscreen, minimal-ui, browser.

WitPwamanifestbackgroundColor

Type: string (color)

Label Background Color (color picker). Manifest member background_color.

WitPwamanifestThemeColor

Type: string (color)

Label Theme Color (color picker). Manifest member theme_color.

WitPwamanifestDescription

Type: string

Label Description. Manifest member description.

Icons

Tab PWA Manifest, palette PWA Manifest icons. Both icons are written to the manifest member icons. An icon is only added if its path is set.

Name	Type
WitPwamanifestShortName	string
WitPwamanifestName	string
WitPwamanifestStartUrl	string
WitPwamanifestScope	string
WitPwamanifestId	string
WitPwamanifestDisplay	string
WitPwamanifestbackgroundColor	string (color)
WitPwamanifestThemeColor	string (color)
WitPwamanifestDescription	string
WitPwamanifestSmallIconPath	string
WitPwamanifestSmallIconType	string
WitPwamanifestSmallIconSize	string
WitPwamanifestBigIconPath	string
WitPwamanifestBigIconType	string
WitPwamanifestBigIconSize	string
WitPwamanifestShortcutsNName	string
WitPwamanifestShortcutsNShortName	string
WitPwamanifestShortcutsNDescription	string
WitPwamanifestShortcutsNUrl	string (link)
WitPwamanifestShortcutsNIconSrc	string
WitPwamanifestShortcutsNIconSizes	string
WitPwamanifestScreenshotNSrc	string
WitPwamanifestScreenshotNType	string
WitPwamanifestScreenshotNSize	string
WitPwamanifestScreenshotNFormFactor	string

WitPwamanifestSmallIconPath

Type: string

Label Small icon path. Icon src, example: fileadmin/woit_pwamanifest/192x192.png.

WitPwamanifestSmallIconType

Type: string

Label Small icon type. Icon type, example: image/png.

WitPwamanifestSmallIconSize

Type: string

Label Small icon size. Icon sizes, example: 192x192.

WitPwamanifestBigIconPath

Type: string

Label Big icon path. Icon src, example: fileadmin/woit_pwamanifest/548x548.png.

WitPwamanifestBigIconType

Type: string

Label Big icon type. Icon type, example: image/png.

WitPwamanifestBigIconSize

Type: string

Label Big icon size. Icon sizes, example: 548x548.

Shortcuts

Tab PWA Manifest Shortcuts, palettes PWA Manifest Shortcut 1 to PWA Manifest Shortcut 3. Written to the manifest member shortcuts.

In the field names below, N stands for 1, 2 or 3.

A shortcut is only added to the manifest if WitPwamanifestShortcutsNUrl is set and at least one of WitPwamanifestShortcutsNName or WitPwamanifestShortcutsNShortName is set.

Name	Type
WitPwamanifestShortName	string
WitPwamanifestName	string
WitPwamanifestStartUrl	string
WitPwamanifestScope	string
WitPwamanifestId	string
WitPwamanifestDisplay	string
WitPwamanifestbackgroundColor	string (color)
WitPwamanifestThemeColor	string (color)
WitPwamanifestDescription	string
WitPwamanifestSmallIconPath	string
WitPwamanifestSmallIconType	string
WitPwamanifestSmallIconSize	string
WitPwamanifestBigIconPath	string
WitPwamanifestBigIconType	string
WitPwamanifestBigIconSize	string
WitPwamanifestShortcutsNName	string
WitPwamanifestShortcutsNShortName	string
WitPwamanifestShortcutsNDescription	string
WitPwamanifestShortcutsNUrl	string (link)
WitPwamanifestShortcutsNIconSrc	string
WitPwamanifestShortcutsNIconSizes	string
WitPwamanifestScreenshotNSrc	string
WitPwamanifestScreenshotNType	string
WitPwamanifestScreenshotNSize	string
WitPwamanifestScreenshotNFormFactor	string

WitPwamanifestShortcutsNName

Type: string

Label Name (required). Shortcut name.

WitPwamanifestShortcutsNShortName

Type: string

Label Short name. Shortcut short_name.

WitPwamanifestShortcutsNDescription

Type: string

Label Description. Shortcut description.

WitPwamanifestShortcutsNUrl

Type: string (link)

Label URL (required). Link to a TYPO3 page or an external URL (link browser). Rendered as absolute URL into shortcut url.

WitPwamanifestShortcutsNIconSrc

Type: string

Label Icon source. Shortcut icon src, example: fileadmin/woit_pwamanifest/192x192.png.

WitPwamanifestShortcutsNIconSizes

Type: string

Label Icon sizes. Shortcut icon sizes, example: 192x192.

Screenshots

Tab PWA Manifest Screenshots, palettes PWA Manifest Screenshot 1 to PWA Manifest Screenshot 3. Written to the manifest member screenshots.

In the field names below, N stands for 1, 2 or 3. A screenshot is only added to the manifest if WitPwamanifestScreenshotNSrc is set.

Name	Type
WitPwamanifestShortName	string
WitPwamanifestName	string
WitPwamanifestStartUrl	string
WitPwamanifestScope	string
WitPwamanifestId	string
WitPwamanifestDisplay	string
WitPwamanifestbackgroundColor	string (color)
WitPwamanifestThemeColor	string (color)
WitPwamanifestDescription	string
WitPwamanifestSmallIconPath	string
WitPwamanifestSmallIconType	string
WitPwamanifestSmallIconSize	string
WitPwamanifestBigIconPath	string
WitPwamanifestBigIconType	string
WitPwamanifestBigIconSize	string
WitPwamanifestShortcutsNName	string
WitPwamanifestShortcutsNShortName	string
WitPwamanifestShortcutsNDescription	string
WitPwamanifestShortcutsNUrl	string (link)
WitPwamanifestShortcutsNIconSrc	string
WitPwamanifestShortcutsNIconSizes	string
WitPwamanifestScreenshotNSrc	string
WitPwamanifestScreenshotNType	string
WitPwamanifestScreenshotNSize	string
WitPwamanifestScreenshotNFormFactor	string

WitPwamanifestScreenshotNSrc

Type: string

Label Screenshot source. Screenshot src.

WitPwamanifestScreenshotNType

Type: string

Label Screenshot type. Screenshot type, example: image/png.

WitPwamanifestScreenshotNSize

Type: string

Label Screenshot size. Screenshot sizes, example: 192x192.

WitPwamanifestScreenshotNFormFactor

Type: string

Label Form factor. Screenshot form_factor. Allowed values: wide, narrow.

Browser requirements

Chrome DevTools reports the following when fields are missing:

Without a screenshot with WitPwamanifestScreenshotNFormFactor wide, the richer install UI is not available on desktop.
Without a screenshot with form factor narrow (or none set), the richer install UI is not available on mobile.
At least one square icon is required. Paths must be reachable from the browser, see Troubleshooting.

Example

config/sites/<your-site>/config.yaml (excerpt)

WitPwamanifestShortName: 'Example'
WitPwamanifestName: 'Example Website'
WitPwamanifestStartUrl: '/'
WitPwamanifestScope: '/'
WitPwamanifestDisplay: standalone
WitPwamanifestbackgroundColor: '#ffffff'
WitPwamanifestThemeColor: '#004a99'
WitPwamanifestSmallIconPath: 'fileadmin/woit_pwamanifest/192x192.png'
WitPwamanifestSmallIconType: 'image/png'
WitPwamanifestSmallIconSize: '192x192'
WitPwamanifestBigIconPath: 'fileadmin/woit_pwamanifest/548x548.png'
WitPwamanifestBigIconType: 'image/png'
WitPwamanifestBigIconSize: '548x548'