mirror of
https://github.com/OCA/server-backend.git
synced 2025-02-18 09:52:42 +02:00
125 lines
4.5 KiB
ReStructuredText
Executable File
125 lines
4.5 KiB
ReStructuredText
Executable File
====================
|
|
Base External System
|
|
====================
|
|
|
|
..
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:979d596e293a14c1895ceb8274b304d883dccb135f90e6fc777859f7a3db3ef6
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
.. |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-LGPL--3-blue.png
|
|
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
|
|
:alt: License: LGPL-3
|
|
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github
|
|
:target: https://github.com/OCA/server-backend/tree/12.0/base_external_system
|
|
:alt: OCA/server-backend
|
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
|
:target: https://translation.odoo-community.org/projects/server-backend-12-0/server-backend-12-0-base_external_system
|
|
: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/server-backend&target_branch=12.0
|
|
:alt: Try me on Runboat
|
|
|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
|
|
|
This module provides an interface/adapter mechanism for the definition of remote
|
|
systems.
|
|
|
|
Note that this module stores everything in plain text. In the interest of security,
|
|
it is recommended you use another module (such as `keychain` or `red_october` to
|
|
encrypt things like the password and private key). This is not done here in order
|
|
to not force a specific security method.
|
|
|
|
**Table of contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Configuration
|
|
=============
|
|
|
|
Configure external systems in Settings => Technical => External Systems
|
|
|
|
Usage
|
|
=====
|
|
|
|
The credentials for systems are stored in the ``external.system`` model, and are to
|
|
be configured by the user. This model is the unified interface for the underlying
|
|
adapters.
|
|
|
|
Using the Interface
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
Given an ``external.system`` singleton called ``external_system``, you would do the
|
|
following to get the underlying system client:
|
|
|
|
.. code-block:: python
|
|
|
|
with external_system.client() as client:
|
|
client.do_something()
|
|
|
|
The client will be destroyed once the context has completed. Destruction takes place
|
|
in the adapter's ``external_destroy_client`` method.
|
|
|
|
The only unified aspect of this interface is the client connection itself. Other more
|
|
opinionated interface/adapter mechanisms can be implemented in other modules, such as
|
|
the file system interface in `OCA/server-tools/external_file_location
|
|
<https://github.com/OCA/server-tools/tree/9.0/external_file_location>`_.
|
|
|
|
Creating an Adapter
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
Modules looking to add an external system adapter should inherit the
|
|
``external.system.adapter`` model and override the following methods:
|
|
|
|
* ``external_get_client``: Returns a usable client for the system
|
|
* ``external_destroy_client``: Destroy the connection, if applicable. Does not need
|
|
to be defined if the connection destroys itself.
|
|
|
|
Bug Tracker
|
|
===========
|
|
|
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/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/server-backend/issues/new?body=module:%20base_external_system%0Aversion:%2012.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
|
|
~~~~~~~
|
|
|
|
* LasLabs
|
|
|
|
Contributors
|
|
~~~~~~~~~~~~
|
|
|
|
* Dave Lasley <dave@laslabs.com>
|
|
* Alexandre Díaz <alexandre.diaz@tecnativa.com>
|
|
|
|
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/server-backend <https://github.com/OCA/server-backend/tree/12.0/base_external_system>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|