abdallah
/
server-env
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[UPD] README.rst

This commit is contained in:
OCA-git-bot 2019-10-10 20:36:00 +00:00
parent 0288100b9c
commit ef0d6a7bd3
2 changed files with 99 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
server_environment/README.rst
View File

@ -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 server configuration environment files
:alt: License: GPL-3 ======================================
================== .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
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 This module provides a way to define an environment in the main Odoo
configuration file and to read some configurations from files 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 see the values contained in the defined secret keys
(by default : '*passw*', '*key*', '*secret*' and '*token*'). (by default : '*passw*', '*key*', '*secret*' and '*token*').
**Table of contents**
.. contents::
:local:
Installation 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 can provide them in environment variables ``SERVER_ENV_CONFIG`` and
``SERVER_ENV_CONFIG_SECRET``. ``SERVER_ENV_CONFIG_SECRET``.
Configuration Configuration
============= =============
@ -51,7 +71,7 @@ environment.
You have several possibilities to set configuration values: You have several possibilities to set configuration values:
server_environment_files server_environment_files
------------------------ ~~~~~~~~~~~~~~~~~~~~~~~~
You can edit the settings you need in the ``server_environment_files`` addon. The You can edit the settings you need in the ``server_environment_files`` addon. The
``server_environment_files_sample`` can be used as an example: ``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; file of your instance;
Environment variable Environment variable
-------------------- ~~~~~~~~~~~~~~~~~~~~
You can define configuration in the environment variable ``SERVER_ENV_CONFIG`` 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 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 secrets in a different, encrypted, file. They are multi-line environment variables
in the same configparser format than the files. in the same configparser format than the files.
If you used options in ``server_environment_files``, the options set in the 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 options in the environment variable are not dependent of ``running_env``,
the content of the variable must be set accordingly to the running environment. 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 Default values
-------------- ~~~~~~~~~~~~~~
When using the ``server.env.mixin`` mixin, for each env-computed field, a When using the ``server.env.mixin`` mixin, for each env-computed field, a
companion field ``<field>_env_default`` is created. This field is not companion field ``<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 Keychain integration
-------------------- ~~~~~~~~~~~~~~~~~~~~
Read the documentation of the class `models/server_env_mixin.py Read the documentation of the class `models/server_env_mixin.py
<models/server_env_mixin.py>`_. <models/server_env_mixin.py>`_.
Usage 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 Read the documentation of the class and methods in `models/server_env_mixin.py
<models/server_env_mixin.py>`__. <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 Known issues / Roadmap
====================== ======================
@ -161,48 +174,52 @@ Known issues / Roadmap
configuration file must be used. configuration file must be used.
* the module does not allow to set low level attributes such as database server, etc. * the module does not allow to set low level attributes such as database server, etc.
Bug Tracker Bug Tracker
=========== ===========
Bugs are tracked on `GitHub Issues Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-env/issues>`_.
<https://github.com/OCA/server-tools/issues>`_. In case of trouble, please In case of trouble, please check there if your issue has already been reported.
check there if your issue has already been reported. If you spotted it first, If you spotted it first, help us smashing it by providing a detailed and welcomed
help us smashing it by providing a detailed and welcomed feedback. `feedback <https://github.com/OCA/server-env/issues/new?body=module:%20server_environment%0Aversion:%2011.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 Credits
======= =======
Images Authors
------ ~~~~~~~
* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_. * Camptocamp
Contributors Contributors
------------ ~~~~~~~~~~~~
* Florent Xicluna (Wingo) <florent.xicluna@gmail.com>
* Nicolas Bessi <nicolas.bessi@camptocamp.com>
* Alexandre Fayolle <alexandre.fayolle@camptocamp.com> * Alexandre Fayolle <alexandre.fayolle@camptocamp.com>
* Daniel Reis <dgreis@sapo.pt> * Daniel Reis <dgreis@sapo.pt>
* Florent Xicluna <florent.xicluna@gmail.com>
* Guewen Baconnier <guewen.baconnier@camptocamp.com>
* Holger Brunn <hbrunn@therp.nl> * Holger Brunn <hbrunn@therp.nl>
* Joël Grand-Guillaume <joel.grandguillaume@camptocamp.com> * Leonardo Pistone <leonardo.pistone@camptocamp.com>
* Nicolas Bessi <nicolas.bessi@camptocamp.com> * Adrien Peiffer <adrien.peiffer@acsone.com>
* Wingo * Thierry Ducrest <thierry.ducrest@camptocamp.com>
* Yannick Vaucher <yannick.vaucher@camptocamp.com> * Guewen Baconnier <guewen.baconnier@camptocamp.com>
* Thomas Binfeld <thomas.binsfeld@acsone.eu>
* Stéphane Bidoul <stefane.bidoul@acsone.com>
Maintainers
~~~~~~~~~~~
Maintainer This module is maintained by the OCA.
----------
.. image:: https://odoo-community.org/logo.png .. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association :alt: Odoo Community Association
:target: https://odoo-community.org :target: https://odoo-community.org
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and mission is to support the collaborative development of Odoo features and
promote its widespread use. promote its widespread use.
To contribute to this module, please visit https://odoo-community.org. This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/11.0/server_environment>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

75
server_environment_files_sample/README.rst
View File

@ -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 Example server configuration environment files repository module
:alt: License: GPL-3 ================================================================
================================= .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
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 This is an example module to be used for
`server_environment_files`. Check that module's README for more `server_environment_files`. Check that module's README for more
information. information.
**Table of contents**
.. contents::
:local:
Installation 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 addons-path and rename it to
`server_environment_files`, then edit the various configurations. `server_environment_files`, then edit the various configurations.
Usage
=====
This module is not testable on runbot (see above). This module is not testable on runbot (see above).
Bug Tracker Bug Tracker
=========== ===========
Bugs are tracked on `GitHub Issues Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-env/issues>`_.
<https://github.com/OCA/server-tools/issues>`_. In case of trouble, please In case of trouble, please check there if your issue has already been reported.
check there if your issue has already been reported. If you spotted it first, If you spotted it first, help us smashing it by providing a detailed and welcomed
help us smashing it by providing a detailed and welcomed feedback. `feedback <https://github.com/OCA/server-env/issues/new?body=module:%20server_environment_files_sample%0Aversion:%2011.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 Credits
======= =======
Images Authors
------ ~~~~~~~
* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_. * Camptocamp
Contributors Contributors
------------ ~~~~~~~~~~~~
* Alexandre Fayolle <alexandre.fayolle@camptocamp.com> * Florent Xicluna (Wingo) <florent.xicluna@gmail.com>
* Daniel Reis <dgreis@sapo.pt>
* Florent Xicluna <florent.xicluna@gmail.com>
* Guewen Baconnier <guewen.baconnier@camptocamp.com>
* Holger Brunn <hbrunn@therp.nl>
* Joël Grand-Guillaume <joel.grandguillaume@camptocamp.com>
* Nicolas Bessi <nicolas.bessi@camptocamp.com> * Nicolas Bessi <nicolas.bessi@camptocamp.com>
* Wingo
* Yannick Vaucher <yannick.vaucher@camptocamp.com>
Maintainers
~~~~~~~~~~~
Maintainer This module is maintained by the OCA.
----------
.. image:: https://odoo-community.org/logo.png .. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association :alt: Odoo Community Association
:target: https://odoo-community.org :target: https://odoo-community.org
This module is maintained by the OCA.
OCA, or the Odoo Community Association, is a nonprofit organization whose OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and mission is to support the collaborative development of Odoo features and
promote its widespread use. promote its widespread use.
To contribute to this module, please visit https://odoo-community.org. This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/11.0/server_environment_files_sample>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.