README

Manage multiple .env files in Laravel with automatic encryption to embed and share your .env files in your repository.

Installation
Basic usage
Encryption
Automatic encryption
Different env files per GIT branches

Installation

You can install the package via composer:

composer require ibrostudio/laravel-multenv

Publish the config file with:

php artisan vendor:publish --tag="multenv-config"

This is the contents of the published config file:

return [
    '.env.primary' => ['encrypt' => true],
    '.env.custom' => ['encrypt' => false],
];

You define which .env files you want to manage:

a primary .env file, with all variables
then, you can add one (or more) entries to override variables

Basic usage

At the root of your project, create all files defined in the config and populate them with variables.

Add them to your .gitignore:

.env.primary
.env.custom

.env*

Then run:

php artisan multenv:merge

It generates the final .env file, merging variables from all configured .env files.

Encryption

You can encrypt some .env files to embed them securely in your repo.

Generate encryption key

php artisan multenv:key

Add it to your .gitignore:

.multenv

Don't commit your .multenv key in your repo, it is a security risk.

If you work with people on the repo, share manually the key, IT HAS TO BE SAME for everyone.

Configure the files to encrypt

In config/multenv.php, define each file to encrypt with the setting to true

'.env.primary' => ['encrypt' => true]

Encrypt

php artisan multenv:encrypt

If you use .env in your .gitignore, add after:

.env*
!.env.*.encrypted

Decrypt

php artisan multenv:decrypt

Automatic encryption

You can define some git hooks to automate the processes:

1. Merge, encrypt and commit

Create (or modify) a file called pre-push in .git/hooks and add in it:

#!/bin/sh

echo "---- PRE PUSH ----"
php artisan multenv:encrypt
git add .env.*.encrypted
git commit -m 'Auto embed encrypted env files'
echo "--- PRE PUSH END ---"

Make it executable:

chmod +x pre-push

2. Decrypt and merge

Create (or modify) a file called post-merge in .git/hooks and add in it:

#!/bin/sh

echo "---- POST MERGE ----"
php artisan multenv:decrypt
php artisan multenv:merge
echo "--- POST MERGE END ---"

Make it executable:

chmod +x post-merge

Different env files per GIT branches

Modify the configuration as following, adding a pattern entry:

return [
    '.env.primary' => ['encrypt' => true, 'pattern' => 'branch-*'],
    '.env.custom' => ['encrypt' => false],
];

Then, at the root of your project, create env branches files with names based on the pattern.

Example : .env.branch-main

Populate them with variables and use methods like described previously.

If you want/need to keep safe between branches, use a different multenv key for each branch.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

License

The MIT License (MIT). Please see License File for more information.

ibrostudio / laravel-multenv

Maintainers

Details