diff --git a/server_environment/README.rst b/server_environment/README.rst index d512efb..98adaaf 100644 --- a/server_environment/README.rst +++ b/server_environment/README.rst @@ -1,10 +1,26 @@ -.. image:: https://img.shields.io/badge/licence-GPL--3-blue.svg - :target: http://www.gnu.org/licenses/gpl-3.0-standalone.html - :alt: License: GPL-3 +====================================== +server configuration environment files +====================================== -================== -Server Environment -================== +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/github-OCA%2Fserver--env-lightgray.png?logo=github + :target: https://github.com/OCA/server-env/tree/11.0/server_environment + :alt: OCA/server-env +.. |badge3| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-env-11-0/server-env-11-0-server_environment + :alt: Translate me on Weblate +.. |badge4| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/254/11.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| This module provides a way to define an environment in the main Odoo configuration file and to read some configurations from files @@ -21,6 +37,11 @@ menu. If you are not in the 'dev' environment you will not be able to see the values contained in the defined secret keys (by default : '*passw*', '*key*', '*secret*' and '*token*'). +**Table of contents** + +.. contents:: + :local: + Installation ============ @@ -34,7 +55,6 @@ You can store your configuration values in a companion module called can provide them in environment variables ``SERVER_ENV_CONFIG`` and ``SERVER_ENV_CONFIG_SECRET``. - Configuration ============= @@ -51,7 +71,7 @@ environment. You have several possibilities to set configuration values: server_environment_files ------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~ You can edit the settings you need in the ``server_environment_files`` addon. The ``server_environment_files_sample`` can be used as an example: @@ -64,7 +84,7 @@ You can edit the settings you need in the ``server_environment_files`` addon. Th file of your instance; Environment variable --------------------- +~~~~~~~~~~~~~~~~~~~~ You can define configuration in the environment variable ``SERVER_ENV_CONFIG`` and/or ``SERVER_ENV_CONFIG_SECRET``. The 2 variables are handled the exact same @@ -72,7 +92,7 @@ way, this is only a convenience for the deployment where you can isolate the secrets in a different, encrypted, file. They are multi-line environment variables in the same configparser format than the files. If you used options in ``server_environment_files``, the options set in the -environment variable overrides them. +environment variable override them. The options in the environment variable are not dependent of ``running_env``, the content of the variable must be set accordingly to the running environment. @@ -110,7 +130,7 @@ A second file which is encrypted and contains secrets:: " Default values --------------- +~~~~~~~~~~~~~~ When using the ``server.env.mixin`` mixin, for each env-computed field, a companion field ``_env_default`` is created. This field is not @@ -123,12 +143,11 @@ Note: empty environment keys always take precedence over default fields Keychain integration --------------------- +~~~~~~~~~~~~~~~~~~~~ Read the documentation of the class `models/server_env_mixin.py `_. - Usage ===== @@ -148,12 +167,6 @@ by an override of ``_server_env_fields``. Read the documentation of the class and methods in `models/server_env_mixin.py `__. - -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/149/10.0 - - Known issues / Roadmap ====================== @@ -161,48 +174,52 @@ Known issues / Roadmap configuration file must be used. * the module does not allow to set low level attributes such as database server, etc. - Bug Tracker =========== -Bugs are tracked on `GitHub Issues -`_. In case of trouble, please -check there if your issue has already been reported. If you spotted it first, -help us smashing it by providing a detailed and welcomed feedback. +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= -Images ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* Camptocamp Contributors ------------- +~~~~~~~~~~~~ +* Florent Xicluna (Wingo) +* Nicolas Bessi * Alexandre Fayolle * Daniel Reis -* Florent Xicluna -* Guewen Baconnier * Holger Brunn -* Joël Grand-Guillaume -* Nicolas Bessi -* Wingo -* Yannick Vaucher +* Leonardo Pistone +* Adrien Peiffer +* Thierry Ducrest +* Guewen Baconnier +* Thomas Binfeld +* Stéphane Bidoul +Maintainers +~~~~~~~~~~~ -Maintainer ----------- +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - 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. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/server-env `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/server_environment_files_sample/README.rst b/server_environment_files_sample/README.rst index e8d9dd0..d6ffebf 100644 --- a/server_environment_files_sample/README.rst +++ b/server_environment_files_sample/README.rst @@ -1,15 +1,35 @@ -.. image:: https://img.shields.io/badge/licence-GPL--3-blue.svg - :target: http://www.gnu.org/licenses/gpl-3.0-standalone.html - :alt: License: GPL-3 +================================================================ +Example server configuration environment files repository module +================================================================ -================================= -server environment files (sample) -================================= +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/github-OCA%2Fserver--env-lightgray.png?logo=github + :target: https://github.com/OCA/server-env/tree/11.0/server_environment_files_sample + :alt: OCA/server-env +.. |badge3| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-env-11-0/server-env-11-0-server_environment_files_sample + :alt: Translate me on Weblate +.. |badge4| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/254/11.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| This is an example module to be used for `server_environment_files`. Check that module's README for more information. +**Table of contents** + +.. contents:: + :local: Installation ============ @@ -18,54 +38,45 @@ Do not install this module as is. Copy it to a directory in your addons-path and rename it to `server_environment_files`, then edit the various configurations. -Usage -===== - This module is not testable on runbot (see above). - - Bug Tracker =========== -Bugs are tracked on `GitHub Issues -`_. In case of trouble, please -check there if your issue has already been reported. If you spotted it first, -help us smashing it by providing a detailed and welcomed feedback. +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= -Images ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* Camptocamp Contributors ------------- +~~~~~~~~~~~~ -* Alexandre Fayolle -* Daniel Reis -* Florent Xicluna -* Guewen Baconnier -* Holger Brunn -* Joël Grand-Guillaume +* Florent Xicluna (Wingo) * Nicolas Bessi -* Wingo -* Yannick Vaucher +Maintainers +~~~~~~~~~~~ -Maintainer ----------- +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - 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. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/server-env `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.