Web App Manifest

The manifest section of the tenant's configuration file defines the tenant's web app manifest. This manifest provides browsers with important metadata about your web application that enables installation on devices and a more app-like experience.

The content of the manifest section is used verbatim as the manifest that is served to the browser.

Required Properties

Include these essential properties in your manifest:

• name: The full name of your application (e.g., "My Company Portal")
• short_name: A shorter name for app icons (e.g., "Portal")
• start_url: The URL that loads when the app is launched
• display: How the application should appear (options: fullscreen, standalone, minimal-ui, browser)
• icons: Array of icon objects specifying image files in different sizes

Example Configuration

"manifest": {
  "name": "Customer Support Portal",
  "short_name": "Support",
  "start_url": "/dashboard",
  "display": "standalone",
  "background_color": "#ffffff",
  "theme_color": "#0078d4",
  "icons": [
    {
      "src": "/icons/icon-192.png",
      "sizes": "192x192",
      "type": "image/png"
    },
    {
      "src": "/icons/icon-512.png",
      "sizes": "512x512",
      "type": "image/png"
    }
  ]
}

Best Practices

1. Provide multiple icon sizes to ensure compatibility across devices
2. Set appropriate display mode based on your application's needs
3. Choose contrasting theme_color and background_color values
4. Test your manifest with Lighthouse or similar tools

The manifest generation process automatically adds the appropriate <link> tag to your HTML to reference the manifest file.