Skip to content

Commit fef2e09

Browse files
JulianPrieberJulianPrieber
committed
Added built in Config Editor
LittleLink Custom now includes an .env config editor. This editor can be accessed via the Admin Panel under Admin>Config. This editor allows admins to edit, backup, download and upload the .env configuration file. All in all, the new feature, allows users to more easily edit the configuration file, contributing to my goal of making LittleLink Custom easier to use. Read more about this topic on the Blog https://blog.littlelink-custom.com/built-in-config-editor
1 parent 9bdf937 commit fef2e09

File tree

14 files changed

+927
-47
lines changed

14 files changed

+927
-47
lines changed

‎.env‎

Lines changed: 45 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,45 @@
1-
APP_NAME="LittleLink Custom"
2-
APP_ENV=local
3-
APP_KEY=
4-
APP_DEBUG=true
5-
APP_URL=
6-
7-
LOG_CHANNEL=stack
8-
LOG_LEVEL=debug
9-
10-
DB_CONNECTION=sqlite
11-
12-
BROADCAST_DRIVER=log
13-
CACHE_DRIVER=file
14-
QUEUE_CONNECTION=sync
15-
SESSION_DRIVER=file
16-
SESSION_LIFETIME=120
17-
18-
MEMCACHED_HOST=127.0.0.1
19-
20-
REDIS_HOST=127.0.0.1
21-
REDIS_PASSWORD=null
22-
REDIS_PORT=6379
23-
24-
MAIL_MAILER=smtp
25-
MAIL_HOST=mailhog
26-
MAIL_PORT=1025
27-
MAIL_USERNAME=null
28-
MAIL_PASSWORD=null
29-
MAIL_ENCRYPTION=null
30-
MAIL_FROM_ADDRESS=null
31-
MAIL_FROM_NAME="${APP_NAME}"
32-
33-
AWS_ACCESS_KEY_ID=
34-
AWS_SECRET_ACCESS_KEY=
35-
AWS_DEFAULT_REGION=us-east-1
36-
AWS_BUCKET=
37-
38-
PUSHER_APP_ID=
39-
PUSHER_APP_KEY=
40-
PUSHER_APP_SECRET=
41-
PUSHER_APP_CLUSTER=mt1
42-
43-
MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
44-
MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
1+
#App Settings=Changes settings regarding your LittleLink Custom installation. You probably only want to change the App Name setting.
2+
#=App_Name changes the displayed name for the App in the title, for example.
3+
App_Name="LittleLink Custom"
4+
App_Key=base64:khLI7djHyA97qfrA+rfz1YUFukELiN6Bk9gQ19+9zwk=
5+
App_URL=
6+
7+
8+
#Debug Settings=Changes if your page should display a full error description instead of a generic error 500
9+
#=App_debug either true or false. You might want to change this to false after you're done installing, but it's very useful for troubleshooting.
10+
App_debug=true
11+
#=App_env either local or production. Change this to production if you set the value above to false
12+
App_env=local
13+
Log_channel=stack
14+
Log_level=debug
15+
16+
17+
#Database Settings=Should be left alone. If you wish to use mysql you'd have to seed the database again.
18+
DB_connection=sqlite
19+
20+
21+
#Mail Settings=LittleLink Custom comes with a free to use built-in SMTP server for sending mail. You can leave this setting as is, if you wish to use this service please read our terms and conditions at llc-mail.tru.io. If you do not wish to use the built-in SMTP server, change the setting below
22+
#=Mail_mailer either smtp or built-in. Make sure to change this setting if you want to add a custom SMTP server.
23+
Mail_mailer=built-in
24+
Mail_host=
25+
Mail_port=
26+
Mail_username=
27+
Mail_password=
28+
Mail_encryption=
29+
Mail_from_address=
30+
Mail_from_name="${app_name}"
31+
32+
33+
#Cache Settings=Completely optional
34+
Memcached_host=127.0.0.1
35+
Redis_host=127.0.0.1
36+
Redis_password=null
37+
Redis_port=6379
38+
39+
40+
#Miscellaneous Settings=Should be left alone if you don't know what you're doing.
41+
Broadcast_driver=log
42+
Cache_driver=file
43+
Queue_connection=sync
44+
Session_driver=file
45+
Session_lifetime=120

‎composer.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"php": "^7.3|^8.0",
99
"fideloper/proxy": "^4.4",
1010
"fruitcake/laravel-cors": "^2.0",
11+
"geo-sot/laravel-env-editor": "^1.1",
1112
"guzzlehttp/guzzle": "^7.0.1",
1213
"laravel/framework": "^8.12",
1314
"laravel/tinker": "^2.5"
@@ -58,4 +59,3 @@
5859
"minimum-stability": "dev",
5960
"prefer-stable": true
6061
}
61-

‎composer.lock‎

Lines changed: 64 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎config/env-editor.php‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<?php
2+
3+
return [
4+
/*
5+
|--------------------------------------------------------------------------
6+
| Files Config
7+
|--------------------------------------------------------------------------
8+
*/
9+
'paths' => [
10+
// .env file directory
11+
'env' => base_path(),
12+
//backup files directory
13+
'backupDirectory' => 'backups',
14+
],
15+
// .env file name
16+
'envFileName' => '.env',
17+
18+
/*
19+
|--------------------------------------------------------------------------
20+
| Routes group config
21+
|--------------------------------------------------------------------------
22+
|
23+
*/
24+
'route' => [
25+
// Prefix url for route Group
26+
'prefix' => 'env-editor',
27+
// Routes base name
28+
'name' => 'env-editor',
29+
// Middleware(s) applied on route Group
30+
'middleware' => ['web', 'admin'],
31+
],
32+
33+
/* ------------------------------------------------------------------------------------------------
34+
| Time Format for Views and parsed backups
35+
| ------------------------------------------------------------------------------------------------
36+
*/
37+
'timeFormat' => 'd/m/Y H:i:s',
38+
39+
/* ------------------------------------------------------------------------------------------------
40+
| Set Views options
41+
| ------------------------------------------------------------------------------------------------
42+
| Here you can set The "extends" blade of index.blade.php
43+
*/
44+
'layout' => 'env-editor::layout',
45+
46+
];

‎resources/lang/vendor/env-editor/en/env-editor.php‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
<?php
2+
3+
return [
4+
'menuTitle' => '.env Editor',
5+
'controllerMessages' => [
6+
'backupWasCreated' => 'A new backup was created',
7+
'fileWasRestored' => 'The backup file ":name", was restored as default .env',
8+
'fileWasDeleted' => 'The backup file ":name", was deleted',
9+
'currentEnvWasReplacedByTheUploadedFile' => 'File was uploaded and become the new .env file',
10+
'uploadedFileSavedAsBackup' => 'File was uploaded as backup with the name ":name"',
11+
'keyWasAdded' => 'Key ":name" was added',
12+
'keyWasEdited' => 'Key ":name" has ben updated',
13+
'keyWasDeleted' => 'Key ":name" was Deleted',
14+
],
15+
'views' => [
16+
'tabTitles' => [
17+
'upload' => 'Upload',
18+
'backup' => 'Backups',
19+
'currentEnv' => 'Current .env',
20+
],
21+
'currentEnv' => [
22+
'title' => 'Current .env file Content',
23+
'tableTitles' => [
24+
'key' => 'Key',
25+
'value' => 'Value',
26+
'actions' => 'Actions',
27+
],
28+
'btn' => [
29+
'edit' => 'Edit File',
30+
'delete' => 'Delete Key',
31+
'addAfterKey' => 'Add new key after this key',
32+
'addNewKey' => 'Add New key',
33+
'deleteConfigCache' => 'Clear config cache',
34+
'deleteConfigCacheDesc' => 'On production environments changed values may not applied immediately cause of cached config. So you may try to un-cache it',
35+
],
36+
'modal' => [
37+
'title' => [
38+
'new' => 'New Key',
39+
'edit' => 'Edit Key',
40+
'delete' => 'Delete Key',
41+
],
42+
'input' => [
43+
'key' => 'Key',
44+
'value' => 'Value',
45+
],
46+
'btn' => [
47+
'close' => 'Close',
48+
'new' => 'Add Key',
49+
'edit' => 'Update Key',
50+
'delete' => 'Delete Key',
51+
],
52+
],
53+
54+
],
55+
'upload' => [
56+
'title' => 'Here You can upload a new ".env" file as a backup or to replace the current ".env"',
57+
'selectFilePrompt' => 'Select File',
58+
'btn' => [
59+
'clearFile' => 'Cancel',
60+
'uploadAsBackup' => 'Upload as backup',
61+
'uploadAndReplace' => 'Upload and replace current .env',
62+
],
63+
],
64+
'backup' => [
65+
'title' => 'Here you can see a list of saved backup files (if you have), you can create a new one, or download the .env file',
66+
'tableTitles' => [
67+
'filename' => 'File Name',
68+
'created_at' => 'Creation Date',
69+
'actions' => 'Actions',
70+
],
71+
'noBackUpItems' => 'There are no backups on your chosen directory. <br> You can make your first backup by pressing the "Get a new BackUp" button',
72+
'btn' => [
73+
'backUpCurrentEnv' => 'Get a new BackUp',
74+
'downloadCurrentEnv' => 'Download current .env',
75+
'download' => 'Download File',
76+
'delete' => 'Delete File',
77+
'restore' => 'Restore File',
78+
'viewContent' => 'View file Contents',
79+
],
80+
],
81+
],
82+
'exceptions' => [
83+
'fileNotExists' => 'File ":name" does not Exists !!!',
84+
'keyAlreadyExists' => 'Key ":name" already Exists !!!',
85+
'keyNotExists' => 'Key ":name" does not Exists !!!',
86+
'provideFileName' => 'You have to provide a FileName !!!',
87+
],
88+
89+
];

‎resources/views/layouts/sidebar.blade.php‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ function update_color_scheme() {
7474
<li class="active">
7575
<a href="#adminSubmenu" data-toggle="collapse" aria-expanded="false" class="dropdown-toggle">Admin</a>
7676
<ul class="collapse list-unstyled" id="adminSubmenu">
77+
<li>
78+
<a href="{{ url('env-editor') }}">Config</a>
79+
</li>
7780
<li>
7881
<a href="{{ url('panel/users/all') }}">Users</a>
7982
</li>

0 commit comments

Comments
 (0)