OdooWiki OCA HUB

Web Environment Ribbon

web_environment_ribbon folder_open OCA/web open_in_new
Web License: AGPL-3

Mark a Test Environment with a red ribbon on the top left corner in every page

auto_awesome What this module does

AI-generated from the code · Odoo 20.0

Displays a colored ribbon in the top corner of every Odoo page to mark a test or non-production environment. The ribbon text and colors are configurable through system parameters.

This module adds a visual marker so users can immediately tell they are working in a test database rather than production.

  • A ribbon appears on every backend page, showing the text configured in the system parameter ribbon.name. By default it shows "TEST" followed by the database name.
  • The ribbon text color comes from ribbon.color and its background color from ribbon.background.color; both are system parameters that can be changed by an administrator.
  • The database name is automatically inserted into the ribbon text where the placeholder is used, so different test databases are easy to distinguish.
  • The ribbon is hidden if no name is configured, and invalid color values are ignored so the default styling remains.
  • The module works entirely in the web client and does not add menus, buttons, or reports; it only reads configuration values through the web.environment.ribbon.backend model and renders the ribbon when the web client is ready.

It touches the web client interface and the system parameters area (ir.config_parameter), and is intended for administrators who want a clear visual warning on non-production environments.

Depends on

web
Models and fields (1)
  • web.environment.ribbon.backend · new model

Text generated by AI (DeepSeek) from reading the Odoo 20.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: 9 confirmed, 0 with no information of 9 versions.

terminal Installation and usage

OCA documentation · Odoo 20.0

Configuration

Source · Odoo 20.0
  • You can change the ribbon's name ("TEST") by editing the default system parameter "ribbon.name" (in the menu Settings \> Technical \> Parameters \> System Parameters) To hide the ribbon, set this parameter to "False" or delete it and refresh the page.
  • You can customize the ribbon color and background color through system parameters: "ribbon.color", "ribbon.background.color". Fill with valid CSS colors or just set to "False" to use default values.
  • You can add the database name in the ribbon by adding "{db_name}" in the system parameter "ribbon.name". configure_1

Usage

Source · Odoo 20.0

To use this module, you need only to install it. After installation, a red ribbon will be visible on top left corner of every Odoo backend page

No verified information in OCA: Installation.

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.