codenamephp / googlesecretsmanager
此软件包最新版本(1.0.0)没有可用的许可信息。
在NEOS CMS中使用Google Secrets Manager中的密钥
1.0.0
2022-12-10 23:53 UTC
Requires
- php: ^8.1
- google/cloud-secret-manager: ^1.9
- neos/flow: ~8.1.0 || ~8.2.0
Requires (Dev)
- neos/buildessentials: ~8.1.0 || ~8.2.0
- phpunit/phpunit: ^9.5
- roave/security-advisories: dev-latest
This package is auto-updated.
Last update: 2024-09-08 03:13:08 UTC
README
安装
最简单的方式是通过composer。只需在您的命令行中运行composer require codenamephp/neos.googleSecretsManager
,它将为您安装最新版本。
使用
只需安装此软件包。它将自动注册并挂钩到设置加载,根据您的配置替换设置。
配置
配置通过GoogleSecretsManager.yaml
文件完成。以下示例显示了示例配置
CodenamePHP: GoogleSecretsManager: credentials: '%FLOW_PATH_ROOT%/path-to-google-auth.json' project: 'my project' secrets: db_password: path: Neos.Flow.persistence.backendOptions.password db_user: Neos.Flow.persistence.backendOptions.user
所有配置都在CodenamePHP.GoogleSecretsManager
键下完成。
属性
enabled
类型: 布尔值
一个布尔值用于打开或关闭替换。如果您想在开发中禁用替换,这很有用。
credentials
类型: 字符串
键credentials
是google auth json文件的路径或解码后的json本身。您可以从Google云控制台获取此文件。也可以省略,以便客户端在环境变量中查找凭据。
确保凭据可以访问密钥管理器和每个密钥的有效负载。
project
类型: 字符串
project
键是要访问的项目名称。这是在Google云控制台中看到的名称,并且可以针对每个密钥进行覆盖,以便某些密钥在不同的项目中。
secrets
类型: 数组
键secrets
是密钥的数组。键是Google密钥管理器中密钥的名称,具有长和短形式
长形式
类型: 对象
在长形式中,密钥是一个具有以下属性的对象
path
- 设置数组中设置的路径。这可以是点分隔的嵌套设置的路径。如果设置不存在,它将被创建。project (可选)
- 使用此密钥的项目。如果没有设置,将使用全局项目。name (可选)
- Google密钥管理器中密钥的名称。如果省略,密钥的键用作名称。version (可选)
- 要加载的密钥版本。这是可选的,默认为latest
。这可以用于加载旧版本的密钥。
短形式
类型: 字符串
在短形式中,值是要替换的设置的路径。路径是点分隔的设置路径。