======================
Web Environment Ribbon
======================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:9a08035950044b08a0f55bd6ff0b05de48c9cb8abd74df63a5579dbf1510048b
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
    :target: https://odoo-community.org/page/development-status
    :alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
    :target: https://github.com/OCA/web/tree/17.0/web_environment_ribbon
    :alt: OCA/web
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/web-17-0/web-17-0-web_environment_ribbon
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=17.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

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

**Table of contents**

.. contents::
   :local:

Configuration
=============

-  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 <../static/description/configure_1.png>`__

Usage
=====

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

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_environment_ribbon%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Francesco OpenCode Apruzzese
* Tecnativa

Contributors
------------

-  Francesco Apruzzese <cescoap@gmail.com>
-  Javi Melendez <javimelex@gmail.com>
-  Antonio Espinosa <antonio.espinosa@tecnativa.com>
-  Thomas Binsfeld <thomas.binsfeld@acsone.eu>
-  Xavier Jiménez <xavier.jimenez@qubiq.es>
-  Dennis Sluijk <d.sluijk@onestein.nl>
-  Eric Lembregts <eric@lembregts.eu>

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/web <https://github.com/OCA/web/tree/17.0/web_environment_ribbon>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.