nette-dotenv
![Software License][ico-license]
![Coverage Status][ico-scrutinizer]
![Total Downloads][ico-downloads], (*1)
This little extension helps you to work with environment variables in config.neon.
To make it even more convenient, this extension also variables from .env
file - a feature well known to Laravel users., (*2)
Install
Via Composer, (*3)
$ composer require wodcz/nette-dotenv
Then register extension in your config.neon
, (*4)
extensions:
env: wodCZ\NetteDotenv\DotEnvExtension
Usage
You can access any environment variable using @env.get('key', 'default')
syntax:, (*5)
services:
- App/MyConnection(@env::get('DB_HOST', '127.0.0.1'))
Environment variables are often set by a docker
, docker-compose
, or your CI server.
To make working with environment variables even easier, you can specify them in .env
file
in root directory of your application., (*6)
This file should be hidden from VCS using .gitignore
or so,
because each developer/server could require different environment configuration.
Furthermore, having .env
file with credentials in repository would be a security risk., (*7)
This is an example on how your .env
file might look like:, (*8)
DB_HOST=192.168.0.10
DB_USER=myprojuser
DB_NAME=myproj
GOOGLE_API_KEY=my_own_key_used_for_development
Have a look at vlucas/phpdotenv documentation for more comprehensive examples., (*9)
Configuration
You can change behavior of this extension using neon
configuration. Here is a list of available options with their
default values., (*10)
env:
directory: "%appDir%/../"
fileName: ".env"
overload: false
localOnly: false
prefix: false
class: \wodCZ\NetteDotenv\EnvAccessor
Change log
Please see CHANGELOG for more information on what has changed recently., (*11)
Testing
bash
$ composer test
, (*12)
Contributing
Please see CONTRIBUTING and CONDUCT for details., (*13)
Security
If you discover any security related issues, please email admin@ikw.cz instead of using the issue tracker., (*14)
Credits
License
The MIT License (MIT). Please see License File for more information., (*15)