将一些配置从数据库中移出
项目描述
此模块提供了一种在主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 中定义配置。这两个变量以完全相同的方式处理,这只是为了方便部署,您可以将在不同的、加密的文件中隔离秘密。它们是多行环境变量,格式与文件相同。如果您在 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.mixin 的 tech_name 字段可以利用计算/可写字段的新选项,从而消除一些 onchange / read / write 代码。
错误跟踪器
错误在 GitHub Issues 上跟踪。如果遇到问题,请检查您的错误是否已被报告。如果您首先发现它,请通过提供详细且受欢迎的 反馈 来帮助我们将其击败。
请勿直接联系贡献者以获取支持或帮助解决技术问题。
致谢
贡献者
弗洛伦特·西克卢纳(Wingo)<florent.xicluna@gmail.com>
尼古拉斯·贝西 <nicolas.bessi@camptocamp.com>
亚历山大·法约勒 <alexandre.fayolle@camptocamp.com>
丹尼尔·里斯 <dgreis@sapo.pt>
霍尔格·布鲁恩 <hbrunn@therp.nl>
莱昂纳多·皮斯托内 <leonardo.pistone@camptocamp.com>
阿德里安·皮费尔 <adrien.peiffer@acsone.com>
蒂埃里·杜克雷斯特 <thierry.ducrest@camptocamp.com>
居文·贝康尼尔 <guewen.baconnier@camptocamp.com>
托马斯·宾费尔德 <thomas.binsfeld@acsone.eu>
斯蒂芬·比多 <stefane.bidoul@acsone.com>
西蒙内·奥西 <simahawk@gmail.com>
维护者
本模块由OCA维护。
OCA,或Odoo社区协会,是一个非营利组织,其使命是支持Odoo功能的协作开发并推广其广泛应用。
本模块是GitHub上的OCA/server-env项目的一部分。
欢迎您贡献力量。要了解如何贡献,请访问https://odoo-community.org/page/Contribute。
项目详情
哈希 对于 odoo12_addon_server_environment-12.0.2.0.8-py3-none-any.whl
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 7fba986e3ab95a6586947fe2a2b4ffd0a94e2fc7020b9593da797b2b2c38267b |
|
MD5 | 94c20ed7405c8c806610c7535f423b76 |
|
BLAKE2b-256 | f6fb2962e3b8d4f04abd345d27aba865aa12c111fbcb7ad54649c9fbe98bb9be |