跳转到主要内容

将一些配置从数据库中移出

项目描述

Production/Stable License: LGPL-3 OCA/server-env Translate me on Weblate Try me on Runbot

此模块提供了一种在主Odoo配置文件中定义环境以及根据配置的环境从文件中读取一些配置的方法:您在主配置文件中定义环境,各种可能的配置值存储在server_environment_files辅助模块中。

server_environment_files模块是可选的,值可以通过环境变量设置,并在数据库中的默认值作为后备。

从文件中读取的配置在配置菜单下可见。如果您不在“dev”环境中,您将无法看到定义的密钥(默认为:“passw”,“key”,“secret”和“token”)中的值。

目录

安装

此模块本身作用不大。例如,mail_environment插件依赖于此插件,允许根据环境配置传入和传出邮件服务器。

您可以将配置值存储在名为 server_environment_files 的辅助模块中。您可以复制并自定义提供的 server_environment_files_sample 模块来实现此目的。或者,您可以通过环境变量 SERVER_ENV_CONFIGSERVER_ENV_CONFIG_SECRET 提供它们。

配置

要配置此模块,您需要编辑您实例的主要配置文件,并添加一个名为 running_env 的指令。常用值是 ‘dev’,‘test’,‘production’

[options]
running_env=dev

包含‘passw’键的值仅在‘dev’环境中显示。

如果您没有提供任何值,则使用 test 作为安全的默认值。

您有几种设置配置值的方法

server_environment_files

您可以在 server_environment_files 添加件中编辑您需要的设置。可以将其用作示例 server_environment_files_sample

  • 所有/大多数环境中通用的值可以使用 .ini 文件语法存储在 default/ 目录中;

  • 需要定义的每个环境都存储在其自己的目录中,可以覆盖或扩展默认值;

  • 您可以在实例的主要配置文件中覆盖或扩展值;

环境变量

您可以在环境变量 SERVER_ENV_CONFIG 和/或 SERVER_ENV_CONFIG_SECRET 中定义配置。这两个变量以完全相同的方式处理,这仅是为了部署的便利,您可以在不同的、加密的文件中隔离秘密。它们是具有与文件相同的 configparser 格式的多行环境变量。如果您在 server_environment_files 中使用了选项,则环境变量中设置的选项将覆盖它们。

环境变量中的选项不依赖于 running_env,变量的内容必须相应地设置以符合运行环境。

设置示例

一个公共文件,包含将包含公共变量的

# These variables are not odoo standard variables,
# they are there to represent what your file could look like
export WORKERS='8'
export MAX_CRON_THREADS='1'
export LOG_LEVEL=info
export LOG_HANDLER=":INFO"
export DB_MAXCONN=5

# server environment options
export SERVER_ENV_CONFIG="
[storage_backend.my_sftp]
sftp_server=10.10.10.10
sftp_login=foo
sftp_port=22200
directory_path=Odoo
"

一个加密的第二个文件,包含秘密

# This variable is not an odoo standard variable,
# it is there to represent what your file could look like
export DB_PASSWORD='xxxxxxxxx'
# server environment options
export SERVER_ENV_CONFIG_SECRET="
[storage_backend.my_sftp]
sftp_password=xxxxxxxxx
"

警告

my_sftp 必须与记录的名称匹配。如果您想要更可靠的设置,请使用 server.env.techname.mixin 并使用 tech_name 字段来引用记录。参见“用法”。

默认值

当使用 server.env.mixin 混合时,对于每个 env-computed 字段,将创建一个伴随字段 <field>_env_default。这个字段不是环境相关的。它是在配置文件/环境变量中没有设置任何密钥时使用的回退值。

当使用默认字段时,该字段在 Odoo 上可编辑。

注意:空环境键始终优先于默认字段

密钥链集成

阅读类 models/server_env_mixin.py 的文档。

用法

您可以在模型中包含一个混合,并通过覆盖 _server_env_fields 来配置 env-computed 字段。

class StorageBackend(models.Model):
    _name = "storage.backend"
    _inherit = ["storage.backend", "server.env.mixin"]

    @property
    def _server_env_fields(self):
        return {"directory_path": {}}

阅读 models/server_env_mixin.py 中的类和方法文档。

如果您想要一个技术名称来引用

class StorageBackend(models.Model):
    _name = "storage.backend"
    _inherit = ["storage.backend", "server.env.techname.mixin", "server.env.mixin"]

    [...]

已知问题/路线图

  • 无法从命令行设置环境。必须使用配置文件。

  • 该模块不允许设置低级属性,例如数据库服务器等。

  • server.env.techname.mixintech_name 字段可以利用新的可计算/可写字段选项,并消除一些 onchange / read / write 代码。

错误追踪器

错误在GitHub 问题上追踪。如有问题,请检查是否已有相关报告。如果您是第一个发现,请帮助我们解决问题,提供详细且受欢迎的反馈

请不要直接联系贡献者询问支持或技术问题。

致谢

作者

  • Camptocamp

贡献者

维护者

本模块由OCA维护。

Odoo Community Association

OCA,或Odoo社区协会,是一个非营利组织,其使命是支持Odoo功能的协作开发并推广其广泛应用。

本模块是GitHub上OCA/server-env项目的组成部分。

欢迎您贡献力量。有关如何贡献的信息,请访问https://odoo-community.org/page/Contribute

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码发行版

本版本没有可用的源分布文件。请参阅有关生成发行版存档的教程。

构建的发行版

odoo13_addon_server_environment-13.0.3.1.0-py3-none-any.whl (185.0 kB 查看哈希值)

上传时间 Python 3

由以下机构支持