将一些配置从数据库中移出
项目描述
此模块提供了一种在主要Odoo配置文件中定义环境的方法,并根据配置的环境从文件中读取一些配置:您在主配置文件中定义环境,而各种可能的环境外部存储在 server_environment_files 伴随模块中。
该 server_environment_files 模块是可选的,可以使用环境变量设置值,并使用数据库中的默认值作为后备。
从文件中读取的配置在“配置”菜单下可见。如果您不在“开发”环境中,您将无法看到定义的密钥(默认为:‘passw’,‘key’,‘secret’和‘token’)中的值。
目录
安装
该模块本身做得很少。例如,mail_environment 扩展依赖于此,允许根据环境配置传入和传出的邮件服务器。
您可以将配置值存储在名为 server_environment_files 的伴随模块中。您可以为此目的复制和自定义提供的 server_environment_files_sample 模块。或者,您可以通过环境变量 SERVER_ENV_CONFIG 和 SERVER_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 "
默认值
当使用 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 类和方法的相关文档。
已知问题/路线图
无法从命令行设置环境。必须使用配置文件。
该模块不允许设置低级属性,如数据库服务器等。
错误跟踪器
错误在 GitHub Issues 上跟踪。如果遇到问题,请检查是否已报告您的问题。如果是您首先发现的,请通过提供详细且受欢迎的 反馈 来帮助我们解决。
请不要直接联系贡献者以寻求支持或帮助解决技术问题。
鸣谢
贡献者
Florent Xicluna (Wingo) <florent.xicluna@gmail.com>
Nicolas Bessi <nicolas.bessi@camptocamp.com>
Alexandre Fayolle <alexandre.fayolle@camptocamp.com>
Daniel Reis <dgreis@sapo.pt>
Holger Brunn <hbrunn@therp.nl>
Leonardo Pistone <leonardo.pistone@camptocamp.com>
Adrien Peiffer <adrien.peiffer@acsone.com>
Thierry Ducrest <thierry.ducrest@camptocamp.com>
Guewen Baconnier <guewen.baconnier@camptocamp.com>
Thomas Binfeld <thomas.binsfeld@acsone.eu>
Stéphane Bidoul <stefane.bidoul@acsone.com>
维护者
本模块由OCA维护。
OCA,或Odoo社区协会,是一个非营利组织,其使命是支持Odoo功能的协作开发并推广其广泛应用。
本模块是GitHub上OCA/server-env项目的一部分。
欢迎您贡献。要了解如何贡献,请访问https://odoo-community.org/page/Contribute。
项目详情
哈希值 for odoo11_addon_server_environment-11.0.2.0.3-py2.py3-none-any.whl
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 9645fc08959412aaf1e33181bab236cb9b62227d8a0d2fd5c06da35cc7f6655f |
|
MD5 | fbdadde3d0d50222423a96b6ff86228f |
|
BLAKE2b-256 | 9ab4441de46cadf9f0b4fea50ef143cb8ae54128075fcfc139e52dfcd4cad4f4 |