Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/geosot/laravel-enveditor
An alternative approach for .env files handling (UI icluded)
https://github.com/geosot/laravel-enveditor
env-backup gui laravel laravel-5-package laravel-env-editor vuejs2
Last synced: 7 days ago
JSON representation
An alternative approach for .env files handling (UI icluded)
- Host: GitHub
- URL: https://github.com/geosot/laravel-enveditor
- Owner: GeoSot
- License: mit
- Created: 2018-10-24T21:56:33.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-16T13:45:35.000Z (8 months ago)
- Last Synced: 2024-05-01T14:31:45.721Z (8 months ago)
- Topics: env-backup, gui, laravel, laravel-5-package, laravel-env-editor, vuejs2
- Language: PHP
- Homepage:
- Size: 375 KB
- Stars: 78
- Watchers: 4
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/geo-sot/laravel-env-editor)
[](https://packagist.org/packages/geo-sot/laravel-env-editor)
[](https://coveralls.io/github/GeoSot/Laravel-EnvEditor)
[](https://www.codacy.com/manual/geo.sotis/Laravel-EnvEditor?utm_source=github.com&utm_medium=referral&utm_content=GeoSot/Laravel-EnvEditor&utm_campaign=Badge_Grade)
[](https://codeclimate.com/github/GeoSot/Laravel-EnvEditor/maintainability)
[](https://packagist.org/packages/geo-sot/laravel-env-editor)
# Laravel .env Editor (plus GUI)
This Package allows to manage Laravel .env file values on the Fly (add, edit, delete keys), upload another .env or create backups
Management can be done through the user interface, or programmatically by using the `EnvEditor` Facade, without breaking the files structure.
The inspiration for this package was, [Brotzka/laravel-dotenv-editor](https://github.com/Brotzka/laravel-dotenv-editor).
* [Installation](#installation)
* [Available Methods](#available_methods)
* [User Interface](#user_interface)
1. Install package
```bash
composer require geo-sot/laravel-env-editor
```
2. Publish assets
```bash
php artisan vendor:publish --provider=GeoSot\EnvEditor\ServiceProvider
```
This will publish all files:
* config -> env-editor.php
* views -> resources/views/vendor/env-editor/..
* lang -> resources/lang/vendor/env-editor.php
Or publish specific tags
```bash
//Publish specific tag
php artisan vendor:publish --tag=config
php artisan vendor:publish --tag=translations
php artisan vendor:publish --tag=views
//Publish specific Tag from this Vendor
php artisan vendor:publish --provider=GeoSot\EnvEditor\ServiceProvider --tag=config
```
## Available Methods:
>* getEnvFileContent
>* keyExists
>* getKey
>* addKey
>* editKey
>* deleteKey
>* getAllBackUps
>* upload
>* backUpCurrent
>* getFilePath
>* deleteBackup
>* restoreBackUp
Example
```php
EnvEditor::getEnvFileContent($fileName='')
// Return The .env Data as Collection.
// If FileName Is provided it searches inside backups Directory and returns these results
EnvEditor::keyExists($key)
// Search key existance in .env
EnvEditor::getKey(string $key, $default = null)
// Get key value from .env,
EnvEditor::addKey($key, $value, array $options = [])
// Adds new Key in .env file
// As options can pass ['index'=>'someNumericIndex'] in order to place the new key after an other and not in the end,
// or ['group'=>'MAIL/APP etc'] to place the new key oat the end of the group
EnvEditor::editKey($key, $value)
// Edits existing key value
EnvEditor::deleteKey($key)
EnvEditor::getAllBackUps()
// Returns all Backup files as collection with some info like, created_date, content etc.
EnvEditor::upload(UploadedFile $uploadedFile, $replaceCurrentEnv)
// Gets an UploadedFile and stores it as backup or as current .env
EnvEditor::backUpCurrent()
// Backups current .env
EnvEditor::getFilePath($fileName = '')
// Returns the full path of a backup file.
// If $fileName is empty returns the full path of the .env file
EnvEditor::deleteBackup($fileName)
EnvEditor::restoreBackUp()
```
**Note:** user interface is disabled be default. You can enable it by changing the configuration option `env-editor.route.enable`
User Interface Contains three Tabs
- [Current .env](#current_env)
* [Add new Key](#add_key)
* [Edit Key](#edit_key)
* [Delete new Key](#delete_key)
- [Backups](#backups)
* [Backups Index](#backups_index)
* [Backup file details](#backup_file_details)
- [Upload](#upload)
### Current .env
#### Add new key
#### Edit key
#### Delete key
### Backups
#### Backups Index
#### Backup file details
### Upload
