Migrating From V1

Automatic Upgrade

EnvKey v1 now includes an upgrade feature that automatically moves your organization over to v2. It is no longer necessary to re-invite users or generate new ENVKEYs. If you're the owner of the organization, you'll see a bar across the bottom of the EnvKey v1 app (version 1.5.0 or later) prompting you to upgrade. Follow the in-app instructions from there to upgrade your org in a few minutes (or less).

Upgrading language libraries

After your upgrade finishes, you'll also need to upgrade up any EnvKey client libraries to their latest 2.x.x versions (this includes envkey-source in addition to any language-specific libraries).

1.x.x libraries will continue working with your v1 ENVKEYs in the meantime, so you can do this gradually without worrying about downtime, but changes you make in v2 won't be picked up until you upgrade client libraries.

🚧

envkey-source v1 → v2

Note that if you already have envkey-source v1 installed locally when you install EnvKey v2 and start the EnvKey UI, envkey-source will be installed as envkey-source-v2 instead of envkey-source in order to avoid overwriting the v1 binary and breaking any of your v1-based workflows. You can also use the es alias, which be installed as long as it isn't currently in your $PATH for some other purpose.

🚧

Passing an ENVKEY to envkey-source as an argument

While we have tried to maintain backward compatibility for the envkey-source tool between v1 and v2, one exception is that an ENVKEY can no longer be passed to envkey-source as an argument in v2. Instead, it should be set as an environment variable.

So if were doing this:

eval "$(envkey-source YOUR-ENVKEY)"

You'll need to do this instead in v2:

ENVKEY=YOUR-ENVKEY eval "$(envkey-source)"

V1 Sunset

EnvKey v1 will have a soft shutdown on Friday, April 28th 2023. This means that v1 ENVKEYs will continue to work, but users won't be able to make changes or take actions in their organization until they upgrade to v2 (which takes a few minutes at most).