Tweak separate database handling

Author: lbausch

.env.example

@@ -8,15 +8,17 @@ APP_TIMEZONE=Europe/Berlin
 
 # Database for SQLgreyGUI
 # If you want to use a single database for both SQLgreyGUI and SQLgrey use only this config block
-DB_CONNECTION=mysql
+DB_CONNECTION=sqlgreygui
+DB_DRIVER=mysql
 DB_HOST=127.0.0.1
 DB_PORT=3306
 DB_DATABASE=sqlgrey
 DB_USERNAME=sqlgrey
 DB_PASSWORD=sqlgrey
 
 # Uncomment the following lines if SQLgrey resides in a different database
-#SQLGREY_DB_CONNECTION=mysql
+#SQLGREY_DB_CONNECTION=sqlgrey
+SQLGREY_DB_DRIVER=mysql
 #SQLGREY_DB_HOST=null
 #SQLGREY_DB_PORT=3306
 #SQLGREY_DB_DATABASE=null

README.md

@@ -14,4 +14,3 @@ Web interface for [SQLgrey](http://sqlgrey.sourceforge.net/) using the [Laravel
 
 ## Documentation
 Visit the [official homepage](https://lbausch.github.io/SQLgreyGUI/) for requirements, installation instructions and further information.
-

ci/.env.testing

@@ -1,3 +1,4 @@
+APP_NAME=SQLgreyGUI
 APP_ENV=testing
 APP_KEY=
 APP_DEBUG=true
@@ -6,21 +7,23 @@ APP_URL=http://localhost
 APP_TIMEZONE=Europe/Berlin
 
 # Database for SQLgreyGUI
-# if you want to use a single database for both SQLgreyGUI and SQLgrey use only this config block
-DB_CONNECTION=mysql
+# If you want to use a single database for both SQLgreyGUI and SQLgrey use only this config block
+DB_CONNECTION=sqlgreygui
+DB_DRIVER=mysql
 DB_HOST=127.0.0.1
 DB_PORT=3306
 DB_DATABASE=testing
 DB_USERNAME=homestead
 DB_PASSWORD=secret
 
 # Uncomment the following lines if SQLgrey resides in a different database
-#SQLGREY_DB_CONNECTION=mysql
-#SQLGREY_DB_HOST=null
+#SQLGREY_DB_CONNECTION=sqlgrey
+#SQLGREY_DB_DRIVER=mysql
+#SQLGREY_DB_HOST=
 #SQLGREY_DB_PORT=3306
-#SQLGREY_DB_DATABASE=null
-#SQLGREY_DB_USERNAME=null
-#SQLGREY_DB_PASSWORD=null
+#SQLGREY_DB_DATABASE=
+#SQLGREY_DB_USERNAME=
+#SQLGREY_DB_PASSWORD=
 
 BROADCAST_DRIVER=log
 CACHE_DRIVER=file
@@ -32,7 +35,7 @@ REDIS_PASSWORD=null
 REDIS_PORT=6379
 
 MAIL_DRIVER=log
-MAIL_HOST=mailtrap.io
+MAIL_HOST=smtp.mailtrap.io
 MAIL_PORT=2525
 MAIL_USERNAME=null
 MAIL_PASSWORD=null

config/database.php

@@ -13,7 +13,7 @@
     |
     */
 
-    'default' => env('DB_CONNECTION', 'mysql'),
+    'default' => env('DB_CONNECTION', 'sqlgreygui'),
 
     /*
     |--------------------------------------------------------------------------
@@ -33,14 +33,8 @@
 
     'connections' => [
 
-        'sqlite' => [
-            'driver' => 'sqlite',
-            'database' => env('DB_DATABASE', database_path('database.sqlite')),
-            'prefix' => '',
-        ],
-
-        'mysql' => [
-            'driver' => 'mysql',
+        'sqlgreygui' => [
+            'driver' => env('DB_DRIVER', 'mysql'),
             'host' => env('DB_HOST', '127.0.0.1'),
             'port' => env('DB_PORT', '3306'),
             'database' => env('DB_DATABASE', 'forge'),
@@ -49,13 +43,14 @@
             'unix_socket' => env('DB_SOCKET', ''),
             'charset' => 'utf8mb4',
             'collation' => 'utf8mb4_unicode_ci',
+            'prefix' => env('DB_PREFIX', 'sg_'),
             'strict' => true,
             'engine' => null,
-            'prefix' => env('DB_PREFIX', 'sg_'),
         ],
 
-        'mysql_sqlgrey' => [
-            'driver' => 'mysql',
+
+        'sqlgrey' => [
+            'driver' => env('SQLGREY_DB_DRIVER', env('DB_DRIVER', 'mysql')),
             'host' => env('SQLGREY_DB_HOST', env('DB_HOST')),
             'port' => env('SQLGREY_DB_PORT', env('DB_PORT')),
             'database' => env('SQLGREY_DB_DATABASE', env('DB_DATABASE')),
@@ -82,6 +77,12 @@
             'sslmode' => 'prefer',
         ],
 
+        'sqlite' => [
+            'driver' => 'sqlite',
+            'database' => env('DB_DATABASE', database_path('database.sqlite')),
+            'prefix' => '',
+        ],
+
         'sqlsrv' => [
             'driver' => 'sqlsrv',
             'host' => env('DB_HOST', 'localhost'),

config/sqlgreygui.php

@@ -1,5 +1,5 @@
 <?php
 
 return [
-    'connection' => env('DB_CONNECTION_SQLGREY', 'mysql_sqlgrey'),
+    'connection' => env('SQLGREY_DB_CONNECTION', 'sqlgrey'),
 ];

docs/index.md

@@ -4,7 +4,7 @@
 * Whitelist: Add sender emails or sender domains to prevent them from being greylisted and delivered directly
 * Opt-Out: Define emails or domains you don't want greylisting to be enabled for
 * Opt-In: Define  emails or domains for which you want to enforce greylisting permanently
-* Option of using seperate databases for SQLgrey and the application itself. This way you can maintain a user database in a single place and use it with all installations of SQLgreyGUI. In addition you don't need to alter the SQLgrey database at all.
+* Option of using separate databases for SQLgrey and the application itself. This way you can maintain a user database in a single place and use it with all installations of SQLgreyGUI. In addition you don't need to alter the SQLgrey database at all.
 
 
 ## Requirements
@@ -26,4 +26,11 @@
 * Add cron entry `* * * * * php /path/to/sqlgreygui/artisan schedule:run >> /dev/null 2>&1` which will delete _undef_ records from the database
 
 
+## Using separate databases for SQLgrey and SQLgreyGUI
+Adjust the values starting with `SQLGREY_DB_` in the `.env` file.
+Refer to the `.env.example` file for possible entries.
+The default configuration in `config/database.php` is designed to work with MySQL out of the box.
+If you need different settings, e.g. for PostgreSQL, take a look at the existing config blocks in `config/database.php`.
+Additional documentation for available configuration possibilities may be found in the [Laravel documentation](https://laravel.com/docs/5.4/database#configuration).
+
 Follow [@SQLgreyGUI](https://twitter.com/sqlgreygui) on Twitter