Alexandre Fayolle
9 years ago
committed by
Alexandre Fayolle
6 changed files with 211 additions and 77 deletions
-
4.travis.yml
-
125server_environment/README.rst
-
59server_environment/__openerp__.py
-
2server_environment/serv_config.xml
-
75server_environment_files_sample/README.rst
-
21server_environment_files_sample/__openerp__.py
@ -0,0 +1,125 @@ |
|||||
|
.. 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 environment |
||||
|
================== |
||||
|
|
||||
|
This module provides a way to define an environment in the main Odoo |
||||
|
configuration file and to read some configurations from files |
||||
|
depending on the configured environment: you define the environment in |
||||
|
the main configuration file, and the values for the various possible |
||||
|
environments are stored in the `server_environment_files` companion |
||||
|
module. |
||||
|
|
||||
|
All the settings will be read only and visible under the Configuration |
||||
|
menu. If you are not in the 'dev' environment you will not be able to |
||||
|
see the values contained in keys named '*passw*'. |
||||
|
|
||||
|
Installation |
||||
|
============ |
||||
|
|
||||
|
By itself, this module does little. See for instance the |
||||
|
`mail_environment` addon which depends on this one to allow configuring |
||||
|
the incoming and outgoing mail servers depending on the environment. |
||||
|
|
||||
|
To install this module, you need to provide a companion module called |
||||
|
`server_environment_files`. You can copy and customize the provided |
||||
|
`server_environment_files_sample` module for this purpose. |
||||
|
|
||||
|
|
||||
|
Configuration |
||||
|
============= |
||||
|
|
||||
|
To configure this module, you need to edit the main configuration file |
||||
|
of your instance, and add a directive called `running_env`. Commonly |
||||
|
used values are 'dev', 'test', 'production':: |
||||
|
|
||||
|
[options] |
||||
|
running_env=dev |
||||
|
|
||||
|
You should then edit the settings you need in the |
||||
|
`server_environment_files` addon. The |
||||
|
`server_environment_files_sample` can be used as an example: |
||||
|
|
||||
|
* values common to all / most environments can be stored in the |
||||
|
`default/` directory using the .ini file syntax |
||||
|
* each environment you need to define is stored in its own directory |
||||
|
and can override or extend default values. Values associated to keys |
||||
|
containing 'passw' are only displayed in the 'dev' environment. |
||||
|
|
||||
|
Usage |
||||
|
===== |
||||
|
|
||||
|
To use this module, in your code, you can follow this example:: |
||||
|
|
||||
|
from openerp.addons.server_environment import serv_config |
||||
|
for key, value in serv_config.items('external_service.ftp'): |
||||
|
print (key, value) |
||||
|
|
||||
|
serv_config.get('external_service.ftp', 'tls') |
||||
|
|
||||
|
|
||||
|
|
||||
|
.. 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/9.0 |
||||
|
|
||||
|
|
||||
|
Known issues / Roadmap |
||||
|
====================== |
||||
|
|
||||
|
* it is not possible to set the environment from the command line. A |
||||
|
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 |
||||
|
<https://github.com/OCA/server-tools/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 |
||||
|
<https://github.com/OCA/ |
||||
|
server-tools/issues/new?body=module:%20 |
||||
|
server_environment%0Aversion:%20 |
||||
|
9.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. |
||||
|
|
||||
|
Credits |
||||
|
======= |
||||
|
|
||||
|
Images |
||||
|
------ |
||||
|
|
||||
|
* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_. |
||||
|
|
||||
|
Contributors |
||||
|
------------ |
||||
|
|
||||
|
* Alexandre Fayolle <alexandre.fayolle@camptocamp.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> |
||||
|
* Wingo |
||||
|
* Yannick Vaucher <yannick.vaucher@camptocamp.com> |
||||
|
|
||||
|
|
||||
|
Maintainer |
||||
|
---------- |
||||
|
|
||||
|
.. 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. |
@ -0,0 +1,75 @@ |
|||||
|
.. 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 environment files (sample) |
||||
|
================================= |
||||
|
|
||||
|
This is an example module to be used for |
||||
|
`server_environment_files`. Check that module's README for more |
||||
|
information. |
||||
|
|
||||
|
|
||||
|
Installation |
||||
|
============ |
||||
|
|
||||
|
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 |
||||
|
<https://github.com/OCA/server-tools/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 |
||||
|
<https://github.com/OCA/ |
||||
|
server-tools/issues/new?body=module:%20 |
||||
|
server_environment%0Aversion:%20 |
||||
|
9.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. |
||||
|
|
||||
|
Credits |
||||
|
======= |
||||
|
|
||||
|
Images |
||||
|
------ |
||||
|
|
||||
|
* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_. |
||||
|
|
||||
|
Contributors |
||||
|
------------ |
||||
|
|
||||
|
* Alexandre Fayolle <alexandre.fayolle@camptocamp.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> |
||||
|
* Wingo |
||||
|
* Yannick Vaucher <yannick.vaucher@camptocamp.com> |
||||
|
|
||||
|
|
||||
|
Maintainer |
||||
|
---------- |
||||
|
|
||||
|
.. 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. |
Write
Preview
Loading…
Cancel
Save
Reference in new issue