EpicEnv

一个史诗级环境管理器，用于修复 git 协作者之间的本地环境变量管理问题。

它类似于 Python 虚拟环境，但用于管理环境变量。

所有环境都在 git 中加密和管理，通过邀请系统提供基本权限。

目前仅支持 macOS 和 Linux

<!-- TOC -->

• EpicEnv
  • 快速开始
    • 安装 EpicEnv
    • 初始化 EpicEnv
    • 添加共享环境变量
    • 添加个人环境变量
    • 邀请协作者
    • 激活环境
    • 停用环境
    • 提交 .epicenv 目录
    • 删除变量
  • 动机
  • 安全性
    • 加密
    • 防止个人变量被全局添加
    • 轮换密钥

<!-- TOC -->

快速开始

安装 EpicEnv

go install github.com/danthegoodman1/epicenv@latest

初始化 EpicEnv

在项目目录中运行：

epicenv init

这将引导您创建一个 EpicEnv 环境。您可以使用不同的环境将本地环境链接到不同的基础设施，如暂存环境和生产环境。

这将创建一个 .epicenv 目录，并将 .epicenv/*/personal 添加到您的 .gitignore 中。

添加共享环境变量

您可以通过以下方式添加单个变量：

epicenv set KEY VALUE -e myenv

您也可以再次运行此命令来替换值。

小贴士：在输入命令前加一个空格，可以防止命令被添加到 shell 历史记录中（从而防止泄露）。您也可以使用 -i 让命令从标准输入中提示输入

您还可以导入现有的 .env 文件：

epicenv import PATH

如果一行以 #personal 结尾，例如：

shared_thing="这个值是共享的"
personal_thing="这个值是个人的" #personal

那么它将自动被添加为个人变量。如果您有一个包含许多混合共享和个人环境变量的现有 .env 文件要导入，这将非常方便。EpicEnv 在导入个人值时会记录日志。

导入将覆盖现有值，使用下面提到的个人标志冲突规则。

添加个人环境变量

对于数据库或 AWS 凭证等信息，您需要使用（并强制使用）本地凭证。

epicenv set KEY VALUE -e myenv -p

这将把环境变量标记为个人变量，防止它被提交到 git。

如果有人在未设置自己的个人值的情况下激活环境，他们将在控制台中看到一个警告，通知他们缺少部分环境。

如果他们试图将个人环境变量写为共享环境变量（省略 -p），EpicEnv 会识别出这一点并假设他们的意图是个人变量，同时发出警告（详见安全性部分）。

如果他们试图将共享环境变量写为个人变量，操作将被拒绝，并要求用户使用 rm 命令将变量更改为个人变量。

邀请协作者

协作者通过其 GitHub 用户名被邀请。他们的账户中必须至少添加了一个 RSA 密钥，可以在 github.com/{username}.keys 查看。

epicenv invite danthegoodman1

您可以使用以下命令取消邀请：

epicenv uninvite danthegoodman1

这将重新加密所有值，移除他们的访问权限。

注意，如果有人离开您的团队，您仍然需要轮换您的密钥！

激活环境

source .epicenv/myenv/activate

您的本地 shell 将解密变量并将它们加载到环境中！

当从 GitHub 拉取更改时，您也可以运行此命令来更新本地环境。

停用环境

您可以停用环境，这将使环境变量恢复到之前的状态（之前的值或未设置）。

deactivate

如果您已经在一个环境中，当您切换或刷新时，deactivate 将自动运行。

提交 .epicenv 目录

git add .epicenv/*
git commit -m "添加 epicenv"

删除变量

您可以使用以下命令删除全局和个人变量：

epicenv rm KEY -e myenv

动机

当多人在一个生产系统上工作时，本地环境管理往往比较混乱。

对于 Kubernetes，有像 kubeseal 这样的优秀管理系统可以将加密的密钥直接保存在 git 中，但类似的本地环境管理工具却很缺乏。

考虑到每个开发者都有（或至少应该有）自己特定的环境值，如数据库凭证，团队成员很容易在保持项目本地运行所需的环境变量更新方面落后。

这种情况会逐渐失控，最终每个人都在争抢暂存部署作为他们的开发环境，而且已经 8 个月没有人在本地运行过服务了。

EpicEnv 旨在解决这个问题。

EpicEnv 将您的环境加密存储在 git 中，并在激活环境时解密它们。您可以共享可以共享的变量，并在需要时替换开发者特定的（"个人"）变量（例如 DB 或 AWS 凭证）。

环境变量使用在您的 github.com/{username}.keys 中找到的 RSA 密钥进行加密，您可以"邀请"协作者加入环境。

git 中的所有内容都是加密的，没有人需要管理本地 .env 文件或防止它们被提交。

这对于直播的人来说也很棒，因为他们永远不用担心不小心打开 .env 文件，向观众泄露生产环境的秘密 >.<

事实上，能够直播 Tangia 开发的能力就是这个想法的起源，因为我（过去）在本地 .env 文件中解密了非常敏感的环境变量 😬

安全性

加密

变量使用 AES GCM 模式加密，对称密钥使用每个协作者的 RSA 密钥加密。

防止个人变量被全局添加

如果您尝试对标记为个人的变量使用 epicenv set，该设置将更新个人变量，而不是添加到全局变量中，以防止通过 git 泄露个人值。

当这种情况发生时，将会发出警告。

要将个人变量变为共享变量，首先使用 rm 删除个人变量，然后再次将其设置为共享变量。反之亦然，要将共享变量变为个人变量也是如此。

轮换密钥

当您取消邀请协作者时，我们明确不更改环境变量解密的对称密钥，以强制您在团队成员离开时轮换密钥！！！！！！！！！