Language Guides


ⓘ This guide assumes you are already familiar with dotenv-kotlin. It extends it with dotenv-vault-kotlin.

🌱 Install

Add jitpack repository to your build.gradle or build.gradle.kts and require the com.github.dotenv-org:dotenv-vault-kotlin:x.x.x implementation dependency.

// build.gradle
repositories {
    maven { url '' }

dependencies {
    implementation 'com.github.dotenv-org:dotenv-vault-kotlin:0.0.2'


// build.gradle.kts
repositories {
    maven { url = uri("") }

dependencies {

🏗️ Usage (.env)

Development usage works just like dotenv-kotlin.

Add your application configuration to your .env file in the root of your project:


As early as possible in your application code, load .env:

import org.dotenv.vault.dotenvVault

val dotenv = dotenvVault()

🚀 Deploying (.env.vault)

Install dotenv-vault.

See install instructions at

Then encrypt your environment variables by doing:

$ 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=

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.

🌴 Manage Multiple Environments

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.

💻 Locally Managed

Create a .env.production file in the root of your project and put your production values there.

# .env.production

Rebuild your .env.vault file.

$ dotenv-vault local build

Check your .env.keys file. There is a production DOTENV_KEY that coincides with the additional 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!

🔐 Vault Managed

Sync your .env file. Run the push command and follow the instructions. learn more

$ dotenv-vault push

Manage multiple environments with the included UI. learn more

$ dotenv-vault open

Build your .env.vault file with multiple environments.

$ dotenv-vault build

Access your DOTENV_KEY.

$ dotenv-vault keys

Set the production DOTENV_KEY on your server, recommit your .env.vault file to code, and deploy. That's it!


What happens if DOTENV_KEY is not set?

godotenvvault gracefully falls back to godotenv 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.

Should I commit my .env file?

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.

Should I commit my .env.vault file?

Yes. It is safe and recommended to do so. It contains your encrypted envs, and your vault identifier.

Can I share the DOTENV_KEY?

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.