OdooWiki OCA HUB

Progressive web application

web_pwa_oca folder_open OCA/web open_in_new
Website License: LGPL-3

Make Odoo an installable Progressive Web Application.

Progressive Web Apps provide an installable, app-like experience on desktop and mobile that are built and delivered directly via the web. They're web apps that are fast and reliable. And most importantly, they're web apps that work in any browser. If you're building a web app today, you're already on the path towards building a Progressive Web App.

  • Developers Info.

The service worker is contructed using 'Odoo Class' to have the same class inheritance behaviour that in the 'user pages'. Be noticed that 'Odoo Bootstrap' is not supported so, you can't use 'require' here.

All service worker content can be found in 'static/src/js/worker'. The management between 'user pages' and service worker is done in 'pwa_manager.js'.

The purpose of this module is give a base to make PWA applications.

auto_awesome What this module does

AI-generated from the code · Odoo 16.0

Lets you turn your Odoo database into an installable Progressive Web App, with your own app name, icon and colours configured from Settings.

This module makes Odoo installable as an app on phones, tablets and desktops directly from the browser, without an app store.

Where it appears in Odoo: - A new "Progressive Web App" section is added to the General Settings screen (after the Emails block). There you can set the app Name, Short Name, Background Color, Theme Color and upload an Icon. - The web client automatically registers a service worker and adds the manifest link, so browsers offer to install Odoo as an app.

Business rules and automatic behaviour: - The icon must be SVG or PNG and no larger than 2 MB; PNG icons must be at least 512x512 pixels, otherwise Odoo shows an error and refuses to save. - When a PNG icon is saved, Odoo automatically generates resized copies (128, 144, 152, 192, 256 and 512 pixels) used by the app manifest and by Apple devices. - If no custom icon is set, a set of default Odoo icons is used. - Default values are provided: name "Odoo PWA", short name "Odoo", and background/theme colour #2E69B5. - When Odoo runs as an installed app, it is treated as a mobile device, which affects how the interface is displayed.

Areas touched: the settings screen (res.config.settings), system parameters and attachments that store the app name, colours and icons, and the main web client layout.

Depends on

webmail
Models and fields (1)
  • res.config.settings · extends an existing modelpwa_icon (Icon), pwa_name (Progressive Web App Name), pwa_short_name (Progressive Web App Short Name), pwa_theme_color (Theme Color), pwa_background_color (Background Color)

Text generated by AI (DeepSeek) from reading the Odoo 16.0 code on GitHub; it may contain mistakes, so check the code before deciding. View the code on GitHub

Availability by version

Reviewed: 2026-11-03
Confirmed (verified in repository and branch) Estimated (unverified) No information

Confirmation status: 5 confirmed, 4 with no information of 9 versions.

terminal Installation and usage

OCA documentation · Odoo 16.0

Installation

Source · Odoo 16.0

After having installed this module, browsing your odoo on mobile you will be able to install it as a PWA.

It is strongly recommended to use this module with a responsive layout, like the one provided by web_responsive.

This module is intended to be used by Odoo back-end users (employees).

When a Progressive Web App is installed, it looks and behaves like all of the other installed apps. It launches from the same place that other apps launch. It runs in an app without an address bar or other browser UI. And like all other installed apps, it's a top level app in the task switcher.

In Chrome, a Progressive Web App can either be installed through the three-dot context menu.

In case you previously installed web_pwa, run the following steps with odoo shell, after having installed openupgradelib:

>>> from openupgradelib import openupgrade >>> openupgrade.update_module_names(env.cr, [('web_pwa', 'web_pwa_oca')], merge_modules=False) >>> env.cr.commit()

Configuration

Source · Odoo 16.0

This module allows you to set the following parameters under settings to customize the appearance of the application

  • PWA Name (defaults to "Odoo PWA")
  • PWA Short Name (defaults to "Odoo PWA")
  • PWA Icon (SVG) (defaults to "/web_pwa_oca/static/img/icons/odoo-logo.svg")

To configure your PWA:

  • Go to Settings > General Settings > Progressive Web App.
  • Set the parameters (Note: Icon must be a SVG file)
  • Save

Usage

Source · Odoo 16.0

To use your PWA:

  • Open the Odoo web app using a supported browser (See https://caniuse.com/?search=A2HS)
  • Open the browser options
  • Click on 'Add to Home screen' (or 'Install' in other browsers)

** Maybe you need refresh the page to load the service worker after using the option.

info

Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.