|
| 1 | +=============== |
| 2 | +Encryption data |
| 3 | +=============== |
| 4 | + |
| 5 | +.. |
| 6 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 7 | + !! This file is generated by oca-gen-addon-readme !! |
| 8 | + !! changes will be overwritten. !! |
| 9 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 10 | + !! source digest: sha256:944425b96b37d35d105f21f5a507a4b36c390de014d97f62379963d72f3d96ad |
| 11 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 12 | +
|
| 13 | +.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png |
| 14 | + :target: https://odoo-community.org/page/development-status |
| 15 | + :alt: Production/Stable |
| 16 | +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png |
| 17 | + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html |
| 18 | + :alt: License: AGPL-3 |
| 19 | +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--env-lightgray.png?logo=github |
| 20 | + :target: https://github.com/OCA/server-env/tree/18.0/data_encryption |
| 21 | + :alt: OCA/server-env |
| 22 | +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png |
| 23 | + :target: https://translation.odoo-community.org/projects/server-env-18-0/server-env-18-0-data_encryption |
| 24 | + :alt: Translate me on Weblate |
| 25 | +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png |
| 26 | + :target: https://runboat.odoo-community.org/builds?repo=OCA/server-env&target_branch=18.0 |
| 27 | + :alt: Try me on Runboat |
| 28 | + |
| 29 | +|badge1| |badge2| |badge3| |badge4| |badge5| |
| 30 | + |
| 31 | +This module allows to encrypt and decrypt data. This module is not |
| 32 | +usable by itself, it is a low level module which should work as a base |
| 33 | +for others. An example is the module server_environment_data_encryption |
| 34 | + |
| 35 | +**Table of contents** |
| 36 | + |
| 37 | +.. contents:: |
| 38 | + :local: |
| 39 | + |
| 40 | +Configuration |
| 41 | +============= |
| 42 | + |
| 43 | +To configure this module, you need to edit the main configuration file |
| 44 | +of your instance, and add a directive called ``running_env``. Commonly |
| 45 | +used values are 'dev', 'test', 'production': |
| 46 | + |
| 47 | +:: |
| 48 | + |
| 49 | + [options] |
| 50 | + running_env=dev |
| 51 | + |
| 52 | +You also need to set the encryption key(s). The main idea is to have |
| 53 | +different encryption keys for your different environment, to avoid the |
| 54 | +possibility to retrieve crucial information from the production |
| 55 | +environment in a developement environment, for instance. So, if your |
| 56 | +running environment is 'dev': |
| 57 | + |
| 58 | +:: |
| 59 | + |
| 60 | + [options] |
| 61 | + encryption_key_dev=fyeMIx9XVPBBky5XZeLDxVc9dFKy7Uzas3AoyMarHPA= |
| 62 | + |
| 63 | +In the configuration file of your production environment, you may want |
| 64 | +to configure all your other environments encryption key. This way, from |
| 65 | +production you can encrypt and decrypt data for all environments. |
| 66 | + |
| 67 | +You can generate keys with python -c 'from cryptography.fernet import |
| 68 | +Fernet; print(Fernet.generate_key())'. |
| 69 | + |
| 70 | +Known issues / Roadmap |
| 71 | +====================== |
| 72 | + |
| 73 | +For now the encryption is dependent on the environment. It has been |
| 74 | +designed to store the same kind of data with different values depending |
| 75 | +on the environement (dev, preprod, prod...). An improvement could be to |
| 76 | +split this in 2 modules. But the environment stuff is not a big |
| 77 | +constraint. |
| 78 | + |
| 79 | +Bug Tracker |
| 80 | +=========== |
| 81 | + |
| 82 | +Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-env/issues>`_. |
| 83 | +In case of trouble, please check there if your issue has already been reported. |
| 84 | +If you spotted it first, help us to smash it by providing a detailed and welcomed |
| 85 | +`feedback <https://github.com/OCA/server-env/issues/new?body=module:%20data_encryption%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. |
| 86 | + |
| 87 | +Do not contact contributors directly about support or help with technical issues. |
| 88 | + |
| 89 | +Credits |
| 90 | +======= |
| 91 | + |
| 92 | +Authors |
| 93 | +------- |
| 94 | + |
| 95 | +* Akretion |
| 96 | + |
| 97 | +Contributors |
| 98 | +------------ |
| 99 | + |
| 100 | +- Raphaël Reverdy <raphael.reverdy@akretion.com> |
| 101 | +- Florian da Costa <florian.dacosta@akretion.com> |
| 102 | + |
| 103 | +Maintainers |
| 104 | +----------- |
| 105 | + |
| 106 | +This module is maintained by the OCA. |
| 107 | + |
| 108 | +.. image:: https://odoo-community.org/logo.png |
| 109 | + :alt: Odoo Community Association |
| 110 | + :target: https://odoo-community.org |
| 111 | + |
| 112 | +OCA, or the Odoo Community Association, is a nonprofit organization whose |
| 113 | +mission is to support the collaborative development of Odoo features and |
| 114 | +promote its widespread use. |
| 115 | + |
| 116 | +.. |maintainer-florian-dacosta| image:: https://github.com/florian-dacosta.png?size=40px |
| 117 | + :target: https://github.com/florian-dacosta |
| 118 | + :alt: florian-dacosta |
| 119 | + |
| 120 | +Current `maintainer <https://odoo-community.org/page/maintainer-role>`__: |
| 121 | + |
| 122 | +|maintainer-florian-dacosta| |
| 123 | + |
| 124 | +This module is part of the `OCA/server-env <https://github.com/OCA/server-env/tree/18.0/data_encryption>`_ project on GitHub. |
| 125 | + |
| 126 | +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
0 commit comments