---
title: "Configuration"
manual: "PWA Manifest"
version: "main"
permalink: "https://docs.typo3.org/permalink/woit/wit-pwamanifest:configuration@main"
source: "Configuration/Index.rst"
rendered: "2026-10-17T07:19:19+00:00"
---

# Configuration {#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](https://docs.typo3.org/permalink/woit/wit-pwamanifest:offline-support@main)

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 {#configuration-basic}

Tab **PWA Manifest**, palette **PWA Manifest name**.

![Site configuration tab "PWA Manifest"](../Images/Wit_PWAManifest.png)

-   **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 {#configuration-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.

-   **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 {#configuration-shortcuts}

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

![Site configuration tab "PWA Manifest Shortcuts"](../Images/Wit_PWAManifest_Shortcuts.png)

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

A shortcut is only added to the manifest if [WitPwamanifestShortcutsNUrl](https://docs.typo3.org/permalink/woit/wit-pwamanifest:confval-site-shortcut-url@main) is
set **and** at least one of [WitPwamanifestShortcutsNName](https://docs.typo3.org/permalink/woit/wit-pwamanifest:confval-site-shortcut-name@main) or
[WitPwamanifestShortcutsNShortName](https://docs.typo3.org/permalink/woit/wit-pwamanifest:confval-site-shortcut-short-name@main) is set.

-   **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 {#configuration-screenshots}

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

![Site configuration tab "PWA Manifest Screenshots"](../Images/Wit_PWAManifest_Screenshots.png)

In the field names below, `N` stands for `1`, `2` or `3`.
A screenshot is only added to the manifest if
[WitPwamanifestScreenshotNSrc](https://docs.typo3.org/permalink/woit/wit-pwamanifest:confval-site-screenshot-src@main) is set.

-   **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 {#configuration-example}

Chrome DevTools reports the following when fields are missing:

-   Without a screenshot with [WitPwamanifestScreenshotNFormFactor](https://docs.typo3.org/permalink/woit/wit-pwamanifest:confval-site-screenshot-form-factor@main) `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](https://docs.typo3.org/permalink/woit/wit-pwamanifest:troubleshooting@main).

## Example {#example}

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

```yaml
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'
```
