Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bnomei/kirby3-dotenv
Kirby Plugin for environment variables from .env files
https://github.com/bnomei/kirby3-dotenv
dotenv dotenv-loader enviroment-variables kirby kirby-cms kirby-plugin
Last synced: 4 days ago
JSON representation
Kirby Plugin for environment variables from .env files
- Host: GitHub
- URL: https://github.com/bnomei/kirby3-dotenv
- Owner: bnomei
- License: mit
- Created: 2018-12-18T14:26:11.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-27T15:12:16.000Z (25 days ago)
- Last Synced: 2024-12-11T21:23:16.530Z (11 days ago)
- Topics: dotenv, dotenv-loader, enviroment-variables, kirby, kirby-cms, kirby-plugin
- Language: PHP
- Homepage: https://forum.getkirby.com/t/kirby3-dotenv-load-enviroment-variables-from-env-files/23578
- Size: 249 KB
- Stars: 35
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Kirby DotEnv
[](https://getkirby.com)
[](https://codeclimate.com/github/bnomei/kirby3-dotenv)
[](https://codeclimate.com/github/bnomei/kirby3-dotenv/issues)
[](https://discordapp.com/users/bnomei)
[](https://www.buymeacoffee.com/bnomei)
Kirby Plugin for environment variables from .env files
## Installation
- unzip [master.zip](https://github.com/bnomei/kirby3-dotenv/archive/master.zip) as folder `site/plugins/kirby3-dotenv`
or
- `git submodule add https://github.com/bnomei/kirby3-dotenv.git site/plugins/kirby3-dotenv` or
- `composer require bnomei/kirby3-dotenv`
## Usage
Create a `.env` file in the root of your Kirby installation. Within your Kirby project you can access the environment variables using various PHP helper functions.
### in production or with default environment
Based on an environment like
- `/site/config/config.php` Kirby configuration file and given a
- `/.env` file.
**/.env**
```dotenv
APP_MODE=production
APP_DEBUG=false
ALGOLIA_APIKEY=12d7331a21d8a28b3069c49830f463e833e30f6d
KIRBY_API_USER=bnomei
KIRBY_API_PW=52d3a0edcc78be6c5645fdb7568f94d3d83d1c2a
```
```php
getenv('ALGOLIA_APIKEY'); // 12d7331...
echo $page->env('ALGOLIA_APIKEY'); // 12d7331...
echo site()->getenv('ALGOLIA_APIKEY'); // 12d7331...
echo site()->env('ALGOLIA_APIKEY'); // 12d7331...
```
### on local or staging test server
You can also create files to have different settings for different environments.
The plugin will try to automatically load the correct file based on the environment.
Based on an environment like
- http://dotenv.test matching a
- `/site/config/config.dotenv.test.php` Kirby configuration file and given a
- `/.env.dotenv.test` file.
**/.env.dotenv.test**
```dotenv
APP_MODE=staging
APP_DEBUG=true
ALGOLIA_APIKEY=950306d052ec893b467f2ca088daf2964b9f9530
KIRBY_API_USER=notBnomei
KIRBY_API_PW=37e30ad867ff3a427317dcd1852abbd692b39ffc
```
```php
false,
// some plugins support callbacks for sensitive data options
'bnomei.seobility.apikey' => function() {
return env('SEOBILITY_APIKEY');
},
// alternatively you can use the `ready` option
// https://getkirby.com/docs/reference/system/options/ready
'ready' => function() {
return [
'debug' => env('APP_DEBUG', false),
'email' => [
'transport' => [
'type' => 'smtp',
'host' => 'smtp.postmarkapp.com',
'port' => 587,
'security' => true,
'auth' => true,
'username' => env('POSTMARK_USERNAME'),
'password' => env('POSTMARK_PASSWORD'),
],
],
];
}
];
```
### Manually load the .env file in the config file
If you still decide you need to use the values from the `.env` files in the config files of Kirby directly, you can manually initialize the loading of these like so:
**/site/config/config.php**
```php
env('APP_DEBUG', false),
//...
];
```
You can provide a custom options as an array to that function if you want to force loading a specific directory or file.
## Other Environment Variables Sources
If you set environment variables in your server configuration these will be available as well.
> [!WARNING]
> This plugin will load environment variables from `.env` files and potentially overwrite existing environment
> variables.
## In the CLI
When running Kirby commands in the CLI make sure you prefix the command with the environment variable for the HOST you want to use.
```sh
env KIRBY_HOST=dotenv.test kirby my:command
```
## Similar Plugins
- [beebmx/kirby-env](https://github.com/beebmx/kirby-env)
- [johannschopplich/kirby-extended](https://github.com/johannschopplich/kirby-extended)
## Settings
| bnomei.dotenv. | Default | Description |
|----------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
| dir | `callback` | returning `kirby()->roots()->index().` When installing Kirby 3 with Composer use a `function() { return realpath(kirby()->roots()->index() . '/../'); }` |
| file | `.env` | |
| environment | `callback` | auto-detection for the current environment |
| required | `callback or []` | You can define required variables in the settings using an array. If any of these is missing a `RuntimeException` will be thrown. |
| setup | `callback` | perform additional tasks on raw dotenv class instance |
## Dependencies
- [vlucas/phpdotenv](https://github.com/vlucas/phpdotenv)
## Disclaimer
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it
in a production environment. If you find any issues,
please [create a new issue](https://github.com/bnomei/kirby3-dotenv/issues/new).
## License
[MIT](https://opensource.org/licenses/MIT)
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or
any other form of hate speech.
## Credits
based on K2 version of
- https://github.com/jevets/kirby-phpdotenv