Extends the proven & trusted foundation of phpdotenv, with a .env.vault
file.
The extended standard lets you load encrypted secrets from your .env.vault
file in production (and other) environments. Brought to you by the same people that pioneered dotenv-nodejs.
$ composer require dotenv-org/phpdotenv-vault
Development usage works just like phpdotenv.
Add your application configuration to your .env
file in the root of your project:
# .env
S3_BUCKET="dotenv"
SECRET_KEY="souper_seekret_key"
As early as possible in your application bootstrap process, load .env:
use DotenvVault\DotenvVault;
require 'vendor/autoload.php';
$dotenv = DotenvVault::createImmutable(__DIR__, '.env.vault');
$dotenv->load(); # take environment variables from .env.vault
When your application loads, these variables will be available in $_ENV
or $_SERVER
:
$s3_bucket = $_ENV['S3_BUCKET'];
echo $s3_bucket;
Encrypt your environment variables by doing:
npx dotenv-vault local build
This will create an encrypted .env.vault
file along with a .env.keys
file containing the encryption keys. Set the DOTENV_KEY
environment variable by copying and pasting the key value from the .env.keys
file onto your server or cloud provider. For example in heroku:
heroku config:set DOTENV_KEY=<key string from .env.keys>
Commit your .env.vault file safely to code and deploy. Your .env.vault fill be decrypted on boot, its environment variables injected, and your app work as expected.
Note that when the DOTENV_KEY
environment variable is set, environment settings will always be loaded from the .env.vault
file in the project root. For development use, you can leave the DOTENV_KEY
environment variable unset and fall back on the dotenv
behaviour of loading from .env
.
You have two options for managing multiple environments - locally managed or vault managed - both use dotenv-vault.
Locally managed never makes a remote API call. It is completely managed on your machine. Vault managed adds conveniences like backing up your .env file, secure sharing across your team, access permissions, and version history. Choose what works best for you.
Create a .env.production
file in the root of your project and put your production values there.
# .env.production
S3_BUCKET="PRODUCTION_S3BUCKET"
SECRET_KEY="PRODUCTION_SECRETKEYGOESHERE"
Rebuild your .env.vault
file.
npx dotenv-vault local build
View your .env.keys
file. There is a production DOTENV_KEY
that pairs with the DOTENV_VAULT_PRODUCTION
cipher in your .env.vault
file.
Set the production DOTENV_KEY
on your server, recommit your .env.vault
file to code, and deploy. That's it!
Your .env.vault fill be decrypted on boot, its production environment variables injected, and your app work as expected.
Sync your .env file. Run the push command and follow the instructions. learn more
$ npx dotenv-vault push
Manage multiple environments with the included UI. learn more
$ npx dotenv-vault open
Build your .env.vault
file with multiple environments.
$ npx dotenv-vault build
Access your DOTENV_KEY
.
$ npx dotenv-vault keys
Set the production DOTENV_KEY
on your server, recommit your .env.vault
file to code, and deploy. That's it!
Dotenv Vault gracefully falls back to phpdotenv when DOTENV_KEY
is not set. This is the default for development so that you can focus on editing your .env
file and save the build
command until you are ready to deploy those environment variables changes.
No. We strongly recommend against committing your .env
file to version control. It should only include environment-specific values such as database passwords or API keys. Your production database should have a different password than your development database.
Yes. It is safe and recommended to do so. It contains your encrypted envs, and your vault identifier.
No. It is the key that unlocks your encrypted environment variables. Be very careful who you share this key with. Do not let it leak.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
See CHANGELOG.md
BSD-3