envkey / envkey-php
自动同步环境变量。使用端到端加密保护机密信息。
Requires (Dev)
- phpunit/phpunit: ^10.1
README
将 EnvKey 集成到您的 PHP 项目中,以安全自动地同步 API 密钥、凭据和其他配置,以便开发人员和服务器。
此存储库在两个位置镜像
安装
$ composer require envkey/envkey-php
使用
如果您尚未下载和安装 EnvKey,请从我们的 网站 下载并安装,然后创建一个新的组织。接下来,遵循 ~1 分钟的 集成快速入门,使用 .envkey
文件(用于连接开发)或生成服务器的 ENVKEY
(用于连接服务器)初始化应用程序。
确保在应用程序的入口点包含 composer 自动加载器。
require_once 'vendor/autoload.php'; // Include the Composer autoloader
现在,您可以使用 getenv('VARIABLE_NAME')
访问所有 EnvKey 变量。
$stripe = new \Stripe\StripeClient(getenv('STRIPE_SECRET_KEY'));
错误
如果缺少或无效的 ENVKEY
,此包将引发错误。
覆盖变量
此包不会覆盖现有的环境变量或您从加载 ENVKEY
的 .env
文件中设置的附加变量。这对于自定义其他情况下共享相同配置的环境很有用。您还可以使用 分支或本地覆盖 来实现此目的。
PHP 请求模型/延迟
与其他预期长期运行服务器进程的 EnvKey 语言库不同,此库是为 PHP 的短暂请求进程设计的。该库在后台进程中将加密配置缓存在 RAM 中,并在首次在服务器上加载 EnvKey 后,后续请求将从此缓存中加载配置,有效实现零延迟(小于 1 毫秒)。
离线工作
如前所述,此包将加密配置缓存在 RAM 中。即使断开互联网连接,您的配置仍然可用(尽管可能不是最新的)。当重新建立连接时,将立即加载最新的配置。
envkey-source
使用此类特定语言的库是集成 EnvKey 的最快和最简单的方法。尽管如此,此库包装的 envkey-source 可执行文件,在直接从命令行使用时提供了额外的选项和功能。如果您需要额外的灵活性并且它适用于您的用例,请考虑直接使用 envkey-source。
x509 错误/CA 证书
在类似于 Alpine Linux 的精简操作系统上,当尝试加载配置时,您可能会遇到 x509: 由未知机构签发的证书
错误。您可以通过确保安装了 ca-certificates
依赖项来修复它。在 Alpine 上,您需要运行
apk add --no-cache ca-certificates
进一步阅读
有关 EnvKey 的一般信息
阅读 文档。
阅读 集成快速入门。
阅读 安全和密码学概述。
需要帮助吗?有问题、反馈或建议?
提交一个 问题,开始一个 讨论,或者给我们发邮件: support@envkey.com。