lucasmichot/laraveldotenv

Easily set environment variables to your Laravel project, speed-up deployment with per-environment settings

1.0.7 2014-01-22 15:22 UTC

README

A very simple utility to set a environment variables file for your Laravel project.

Latest Stable Version Total Downloads

Requiring / Loading

Require this package in your composer.json and run composer update. Or run composer require lucasmichot/laravel-ide-laraveldotenv:dev-master directly.

"require": {
    "lucasmichot/laraveldotenv": "dev-master"
}

After running composer update, add the LaraveldotenvServiceProvider at the bottom of the Providers array in app/config/app.php:

'providers' => array(
    //  ...
    'Lucasmichot\Laraveldotenv\LaraveldotenvServiceProvider',
),
````

## Usage

Place a file called `.env` at the root of your Laravel project folder, so that `.env` and `server.php` files are in the same folder.

You can put all the required environment variable with this `.env` file, respecting the following syntax: `ENV_KEY=ENV_VALUE`. In this example we set environment variables for MySQL database configuration and access:

Content of `.env` file:

````ìni
DB_HOST=localhost
DB_NAME=database-name
DB_USER=root
DB_PASS=password
````

Keys and values are automatically recognized and processed so than you could even write your `.env` file this way and get the same result as above:

````ìni
DB_HOST   =    localhost
DB_NAME=  "database-name"
DB_USER="root"

DB_PASS=    password
````


Then in your `database.php` config file, you can use the existing variables in `$_ENV` array:

````php
'mysql' => array(
    'driver'    => 'mysql',
    'host'      => $_ENV['DB_HOST'],
    'database'  => $_ENV['DB_NAME'],
    'username'  => $_ENV['DB_USER'],
    'password'  => $_ENV['DB_PASS'],
    'charset'   => 'utf8',
    'collation' => 'utf8_unicode_ci',
    'prefix'    => '',
),
````

#### Note

Keep in mind that this `.env` file must shall not be committed in your repository and must be excluded from release archive. 
Ensure to add `.env` to your `.gitignore` file.

To ensure this file will not be available in the the release archive, simply add `.env export-ignore` to your `.gitattributes` file.

## Todo

- Add tests.

## License

Released under the MIT License - see `LICENSE.txt` for details.