Updated configuration files

Added a notice to the top of each to explain they should not be normally modified.
Standardised comment format used for each item.
Better aligned some files with laravel 5.5 options.

diff --git a/config/app.php b/config/app.php
index 3a704e83c510b9c42a6564ab98ca6304e96fb66f..e2885d1968bb425d2744969a1e64edfd3e741695 100755 (executable)
--- a/config/app.php
+++ b/config/app.php
@@ -1,175 +1,84 @@
 <?php
 
 <?php
 

+/**
+ * Global app configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */
+

 return [
 
 return [
 

+    // The environment to run BookStack in.
+    // Options: production, development, demo, testing

     'env' => env('APP_ENV', 'production'),
 
     'env' => env('APP_ENV', 'production'),
 

-    /**
-     * Set the default view type for various lists. Can be overridden by user preferences.
-     * This will be used for public viewers and users that have not set a preference.
-     */
+    // Enter the application in debug mode.
+    // Shows much more verbose error messages. Has potential to show
+    // private configuration variables so should remain disabled in public.
+    'debug' => env('APP_DEBUG', false),
+
+    // Set the default view type for various lists. Can be overridden by user preferences.
+    // These will be used for public viewers and users that have not set a preference.

     'views' => [
         'books' => env('APP_VIEWS_BOOKS', 'list')
     ],
 
     'views' => [
         'books' => env('APP_VIEWS_BOOKS', 'list')
     ],
 

-    /**
-     * The number of revisions to keep in the database.
-     * Once this limit is reached older revisions will be deleted.
-     * If set to false then a limit will not be enforced.
-     */
+    // The number of revisions to keep in the database.
+    // Once this limit is reached older revisions will be deleted.
+    // If set to false then a limit will not be enforced.

     'revision_limit' => env('REVISION_LIMIT', 50),
 
     'revision_limit' => env('REVISION_LIMIT', 50),
 

-    /**
-     * Allow <script> tags to entered within page content.
-     * <script> tags are escaped by default.
-     * Even when overridden the WYSIWYG editor may still escape script content.
-     */
+    // Allow <script> tags to entered within page content.
+    // <script> tags are escaped by default.
+    // Even when overridden the WYSIWYG editor may still escape script content.

     'allow_content_scripts' => env('ALLOW_CONTENT_SCRIPTS', false),
 
     'allow_content_scripts' => env('ALLOW_CONTENT_SCRIPTS', false),
 

-    /**
-     * Override the default behaviour for allowing crawlers to crawl the instance.
-     * May be ignored if view has be overridden or modified.
-     * Defaults to null since, if not set, 'app-public' status used instead.
-     */
+    // Override the default behaviour for allowing crawlers to crawl the instance.
+    // May be ignored if view has be overridden or modified.
+    // Defaults to null since, if not set, 'app-public' status used instead.

     'allow_robots' => env('ALLOW_ROBOTS', null),
 
     'allow_robots' => env('ALLOW_ROBOTS', null),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Application Debug Mode
-    |--------------------------------------------------------------------------
-    |
-    | When your application is in debug mode, detailed error messages with
-    | stack traces will be shown on every error that occurs within your
-    | application. If disabled, a simple generic error page is shown.
-    |
-    */
-
-    'debug' => env('APP_DEBUG', false),
-
-    /*
-    |--------------------------------------------------------------------------
-    | Application URL
-    |--------------------------------------------------------------------------
-    |
-    | This URL is used by the console to properly generate URLs when using
-    | the Artisan command line tool. You should set this to the root of
-    | your application so that it is used when running Artisan tasks.
-    |
-    */
-
+    // Application Base URL, Used by laravel in development commands
+    // and used by BookStack in URL generation.

     'url' => env('APP_URL', '') === 'http://bookstack.dev' ? '' : env('APP_URL', ''),
 
     'url' => env('APP_URL', '') === 'http://bookstack.dev' ? '' : env('APP_URL', ''),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Application Timezone
-    |--------------------------------------------------------------------------
-    |
-    | Here you may specify the default timezone for your application, which
-    | will be used by the PHP date and date-time functions. We have gone
-    | ahead and set this to a sensible default for you out of the box.
-    |
-    */
-
+    // Application timezone for back-end date functions.

     'timezone' => 'UTC',
 
     'timezone' => 'UTC',
 

-    /*
-    |--------------------------------------------------------------------------
-    | Application Locale Configuration
-    |--------------------------------------------------------------------------
-    |
-    | The application locale determines the default locale that will be used
-    | by the translation service provider. You are free to set this value
-    | to any of the locales which will be supported by the application.
-    |
-    */
-
+    // Default locale to use

     'locale' => env('APP_LANG', 'en'),
     'locale' => env('APP_LANG', 'en'),

+
+    // Locales available

     'locales' => ['en', 'ar', 'de', 'de_informal', 'es', 'es_AR', 'fr', 'nl', 'pt_BR', 'sk', 'sv', 'kr', 'ja', 'pl', 'it', 'ru', 'uk', 'zh_CN', 'zh_TW'],
 
     'locales' => ['en', 'ar', 'de', 'de_informal', 'es', 'es_AR', 'fr', 'nl', 'pt_BR', 'sk', 'sv', 'kr', 'ja', 'pl', 'it', 'ru', 'uk', 'zh_CN', 'zh_TW'],
 

-    /*
-    |--------------------------------------------------------------------------
-    | Right-to-left text control
-    |--------------------------------------------------------------------------
-    |
-    | Right-to-left text control is set to false by default since English
-    | is the primary supported application but this may be dynamically
-    | altered by the applications localization system.
-    |
-    */
+    //  Application Fallback Locale
+    'fallback_locale' => 'en',

 
 

+    // Enable right-to-left text control.

     'rtl' => false,
 
     'rtl' => false,
 

-    /*
-    |--------------------------------------------------------------------------
-    | Auto-detect the locale for public users
-    |--------------------------------------------------------------------------
-    |
-    | For public users their locale can be guessed by headers sent by their
-    | browser. This is usually set by users in their browser settings.
-    | If not found the default app locale will be used.
-    |
-    */
+    // Auto-detect the locale for public users
+    // For public users their locale can be guessed by headers sent by their
+    // browser. This is usually set by users in their browser settings.
+    // If not found the default app locale will be used.

     'auto_detect_locale' => env('APP_AUTO_LANG_PUBLIC', true),
 
     'auto_detect_locale' => env('APP_AUTO_LANG_PUBLIC', true),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Application Fallback Locale
-    |--------------------------------------------------------------------------
-    |
-    | The fallback locale determines the locale to use when the current one
-    | is not available. You may change the value to correspond to any of
-    | the language folders that are provided through your application.
-    |
-    */
-
-    'fallback_locale' => 'en',
-
-    /*
-    |--------------------------------------------------------------------------
-    | Encryption Key
-    |--------------------------------------------------------------------------
-    |
-    | This key is used by the Illuminate encrypter service and should be set
-    | to a random, 32 character string, otherwise these encrypted strings
-    | will not be safe. Please do this before deploying an application!
-    |
-    */
-
+    // Encryption key

     'key' => env('APP_KEY', 'AbAZchsay4uBTU33RubBzLKw203yqSqr'),
 
     'key' => env('APP_KEY', 'AbAZchsay4uBTU33RubBzLKw203yqSqr'),
 

+    // Encryption cipher

     'cipher' => 'AES-256-CBC',
 
     'cipher' => 'AES-256-CBC',
 

-    /*
-    |--------------------------------------------------------------------------
-    | Logging Configuration
-    |--------------------------------------------------------------------------
-    |
-    | Here you may configure the log settings for your application. Out of
-    | the box, Laravel uses the Monolog PHP logging library. This gives
-    | you a variety of powerful log handlers / formatters to utilize.
-    |
-    | Available Settings: "single", "daily", "syslog", "errorlog"
-    |
-    */
-
+    // Logging configuration
+    // Options: single, daily, syslog, errorlog

     'log' => env('APP_LOGGING', 'single'),
 
     'log' => env('APP_LOGGING', 'single'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Autoloaded Service Providers
-    |--------------------------------------------------------------------------
-    |
-    | The service providers listed here will be automatically loaded on the
-    | request to your application. Feel free to add your own services to
-    | this array to grant expanded functionality to your applications.
-    |
-    */
-
+    // Application Services Provides

     'providers' => [
 
     'providers' => [
 

-        /*
-         * Laravel Framework Service Providers...
-         */
+        // Laravel Framework Service Providers...

         Illuminate\Auth\AuthServiceProvider::class,
         Illuminate\Broadcasting\BroadcastServiceProvider::class,
         Illuminate\Bus\BusServiceProvider::class,
         Illuminate\Auth\AuthServiceProvider::class,
         Illuminate\Broadcasting\BroadcastServiceProvider::class,
         Illuminate\Bus\BusServiceProvider::class,


@@ -192,20 +101,17 @@ return [
         Illuminate\Notifications\NotificationServiceProvider::class,
         SocialiteProviders\Manager\ServiceProvider::class,
 
         Illuminate\Notifications\NotificationServiceProvider::class,
         SocialiteProviders\Manager\ServiceProvider::class,
 

-        /**
-         * Third Party
-         */
+        // Third party service providers

         Intervention\Image\ImageServiceProvider::class,
         Barryvdh\DomPDF\ServiceProvider::class,
         Barryvdh\Snappy\ServiceProvider::class,
 
 
         Intervention\Image\ImageServiceProvider::class,
         Barryvdh\DomPDF\ServiceProvider::class,
         Barryvdh\Snappy\ServiceProvider::class,
 
 

-        /*
-         * Application Service Providers...
-         */
+        // BookStack replacement service providers (Extends Laravel)

         BookStack\Providers\PaginationServiceProvider::class,
         BookStack\Providers\TranslationServiceProvider::class,
 
         BookStack\Providers\PaginationServiceProvider::class,
         BookStack\Providers\TranslationServiceProvider::class,
 

+        // BookStack custom service providers

         BookStack\Providers\AuthServiceProvider::class,
         BookStack\Providers\AppServiceProvider::class,
         BookStack\Providers\BroadcastServiceProvider::class,
         BookStack\Providers\AuthServiceProvider::class,
         BookStack\Providers\AppServiceProvider::class,
         BookStack\Providers\BroadcastServiceProvider::class,


@@ -225,8 +131,10 @@ return [
     |
     */
 
     |
     */
 

+    // Class aliases, Registered on application start

     'aliases' => [
 
     'aliases' => [
 

+        // Laravel

         'App'       => Illuminate\Support\Facades\App::class,
         'Artisan'   => Illuminate\Support\Facades\Artisan::class,
         'Auth'      => Illuminate\Support\Facades\Auth::class,
         'App'       => Illuminate\Support\Facades\App::class,
         'Artisan'   => Illuminate\Support\Facades\Artisan::class,
         'Auth'      => Illuminate\Support\Facades\Auth::class,


@@ -262,18 +170,12 @@ return [
         'View'      => Illuminate\Support\Facades\View::class,
         'Socialite' => Laravel\Socialite\Facades\Socialite::class,
 
         'View'      => Illuminate\Support\Facades\View::class,
         'Socialite' => Laravel\Socialite\Facades\Socialite::class,
 

-        /**
-         * Third Party
-         */
-
+        // Third Party

         'ImageTool' => Intervention\Image\Facades\Image::class,
         'DomPDF' => Barryvdh\DomPDF\Facade::class,
         'SnappyPDF' => Barryvdh\Snappy\Facades\SnappyPdf::class,
 
         'ImageTool' => Intervention\Image\Facades\Image::class,
         'DomPDF' => Barryvdh\DomPDF\Facade::class,
         'SnappyPDF' => Barryvdh\Snappy\Facades\SnappyPdf::class,
 

-        /**
-         * Custom
-         */
-
+        // Custom BookStack

         'Activity' => BookStack\Facades\Activity::class,
         'Setting'  => BookStack\Facades\Setting::class,
         'Views'    => BookStack\Facades\Views::class,
         'Activity' => BookStack\Facades\Activity::class,
         'Setting'  => BookStack\Facades\Setting::class,
         'Views'    => BookStack\Facades\Views::class,


@@ -281,6 +183,7 @@ return [
 
     ],
 
 
     ],
 

+    // Proxy configuration

     'proxies' => env('APP_PROXIES', ''),
 
 ];
     'proxies' => env('APP_PROXIES', ''),
 
 ];

diff --git a/config/auth.php b/config/auth.php
index f0e699809a99fe1c722b8a1bc20a7cc78774ade4..7bf1ae7722c958cfd8940c4d30d43af78a76dbf6 100644 (file)
--- a/config/auth.php
+++ b/config/auth.php
@@ -1,43 +1,32 @@
 <?php
 
 <?php
 

-return [
+/**
+ * Authentication configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */

 
 

+return [

 
 

+    // Method of authentication to use
+    // Options: standard, ldap

     'method' => env('AUTH_METHOD', 'standard'),
 
     'method' => env('AUTH_METHOD', 'standard'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Authentication Defaults
-    |--------------------------------------------------------------------------
-    |
-    | This option controls the default authentication "guard" and password
-    | reset options for your application. You may change these defaults
-    | as required, but they're a perfect start for most applications.
-    |
-    */
-
+    // Authentication Defaults
+    // This option controls the default authentication "guard" and password
+    // reset options for your application.

     'defaults' => [
         'guard' => 'web',
         'passwords' => 'users',
     ],
 
     'defaults' => [
         'guard' => 'web',
         'passwords' => 'users',
     ],
 

-    /*
-    |--------------------------------------------------------------------------
-    | Authentication Guards
-    |--------------------------------------------------------------------------
-    |
-    | Next, you may define every authentication guard for your application.
-    | Of course, a great default configuration has been defined for you
-    | here which uses session storage and the Eloquent user provider.
-    |
-    | All authentication drivers have a user provider. This defines how the
-    | users are actually retrieved out of your database or other storage
-    | mechanisms used by this application to persist your user's data.
-    |
-    | Supported: "session", "token"
-    |
-    */
-
+    // Authentication Guards
+    // All authentication drivers have a user provider. This defines how the
+    // users are actually retrieved out of your database or other storage
+    // mechanisms used by this application to persist your user's data.
+    // Supported: "session", "token"

     'guards' => [
         'web' => [
             'driver' => 'session',
     'guards' => [
         'web' => [
             'driver' => 'session',


@@ -50,23 +39,11 @@ return [
         ],
     ],
 
         ],
     ],
 

-    /*
-    |--------------------------------------------------------------------------
-    | User Providers
-    |--------------------------------------------------------------------------
-    |
-    | All authentication drivers have a user provider. This defines how the
-    | users are actually retrieved out of your database or other storage
-    | mechanisms used by this application to persist your user's data.
-    |
-    | If you have multiple user tables or models you may configure multiple
-    | sources which represent each model / table. These sources may then
-    | be assigned to any extra authentication guards you have defined.
-    |
-    | Supported: "database", "eloquent"
-    |
-    */
-
+    // User Providers
+    // All authentication drivers have a user provider. This defines how the
+    // users are actually retrieved out of your database or other storage
+    // mechanisms used by this application to persist your user's data.
+    // Supported: database, eloquent, ldap

     'providers' => [
         'users' => [
             'driver' => env('AUTH_METHOD', 'standard') === 'standard' ? 'eloquent' : env('AUTH_METHOD'),
     'providers' => [
         'users' => [
             'driver' => env('AUTH_METHOD', 'standard') === 'standard' ? 'eloquent' : env('AUTH_METHOD'),


@@ -79,25 +56,10 @@ return [
         // ],
     ],
 
         // ],
     ],
 

-    /*
-    |--------------------------------------------------------------------------
-    | Resetting Passwords
-    |--------------------------------------------------------------------------
-    |
-    | Here you may set the options for resetting passwords including the view
-    | that is your password reset e-mail. You may also set the name of the
-    | table that maintains all of the reset tokens for your application.
-    |
-    | You may specify multiple password reset configurations if you have more
-    | than one user table or model in the application and you want to have
-    | separate password reset settings based on the specific user types.
-    |
-    | The expire time is the number of minutes that the reset token should be
-    | considered valid. This security feature keeps tokens short-lived so
-    | they have less time to be guessed. You may change this as needed.
-    |
-    */
-
+    // Resetting Passwords
+    // The expire time is the number of minutes that the reset token should be
+    // considered valid. This security feature keeps tokens short-lived so
+    // they have less time to be guessed. You may change this as needed.

     'passwords' => [
         'users' => [
             'provider' => 'users',
     'passwords' => [
         'users' => [
             'provider' => 'users',

diff --git a/config/broadcasting.php b/config/broadcasting.php
index 36f9b3c146f12c1a0bda370843bc03df186d3f3a..3d9eb78f95abd18bdb79d785a693de3f174641a6 100644 (file)
--- a/config/broadcasting.php
+++ b/config/broadcasting.php
@@ -1,31 +1,25 @@
 <?php
 
 <?php
 

-return [
+/**
+ * Broadcasting configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */

 
 

-    /*
-    |--------------------------------------------------------------------------
-    | Default Broadcaster
-    |--------------------------------------------------------------------------
-    |
-    | This option controls the default broadcaster that will be used by the
-    | framework when an event needs to be broadcast. You may set this to
-    | any of the connections defined in the "connections" array below.
-    |
-    */
+return [

 
 

+    // Default Broadcaster
+    // This option controls the default broadcaster that will be used by the
+    // framework when an event needs to be broadcast. This can be set to
+    // any of the connections defined in the "connections" array below.

     'default' => env('BROADCAST_DRIVER', 'pusher'),
 
     'default' => env('BROADCAST_DRIVER', 'pusher'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Broadcast Connections
-    |--------------------------------------------------------------------------
-    |
-    | Here you may define all of the broadcast connections that will be used
-    | to broadcast events to other systems or over websockets. Samples of
-    | each available type of connection are provided inside this array.
-    |
-    */
-
+    // Broadcast Connections
+    // Here you may define all of the broadcast connections that will be used
+    // to broadcast events to other systems or over websockets. Samples of
+    // each available type of connection are provided inside this array.

     'connections' => [
 
         'pusher' => [
     'connections' => [
 
         'pusher' => [

diff --git a/config/cache.php b/config/cache.php
index 0a95683227fa02dd3ece50b75db2506e40d8574c..43f420457eba43f7b757e48bf0960b6e5a55a2b8 100644 (file)
--- a/config/cache.php
+++ b/config/cache.php
@@ -1,5 +1,13 @@
 <?php
 
 <?php
 

+/**
+ * Caching configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */
+

 // MEMCACHED - Split out configuration into an array
 if (env('CACHE_DRIVER') === 'memcached') {
     $memcachedServerKeys = ['host', 'port', 'weight'];
 // MEMCACHED - Split out configuration into an array
 if (env('CACHE_DRIVER') === 'memcached') {
     $memcachedServerKeys = ['host', 'port', 'weight'];


@@ -14,30 +22,11 @@ if (env('CACHE_DRIVER') === 'memcached') {
 
 return [
 
 
 return [
 

-    /*
-    |--------------------------------------------------------------------------
-    | Default Cache Store
-    |--------------------------------------------------------------------------
-    |
-    | This option controls the default cache connection that gets used while
-    | using this caching library. This connection is used when another is
-    | not explicitly specified when executing a given caching function.
-    |
-    */
-
+    // Default cache store to use
+    // Can be overridden at cache call-time

     'default' => env('CACHE_DRIVER', 'file'),
 
     'default' => env('CACHE_DRIVER', 'file'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Cache Stores
-    |--------------------------------------------------------------------------
-    |
-    | Here you may define all of the cache "stores" for your application as
-    | well as their drivers. You may even define multiple stores for the
-    | same cache driver to group types of items stored in your caches.
-    |
-    */
-
+    // Available caches stores

     'stores' => [
 
         'apc' => [
     'stores' => [
 
         'apc' => [


@@ -71,17 +60,8 @@ return [
 
     ],
 
 
     ],
 

-    /*
-    |--------------------------------------------------------------------------
-    | Cache Key Prefix
-    |--------------------------------------------------------------------------
-    |
-    | When utilizing a RAM based store such as APC or Memcached, there might
-    | be other applications utilizing the same cache. So, we'll specify a
-    | value to get prefixed to all our keys so we can avoid collisions.
-    |
-    */
-
+    // Cache key prefix
+    // Used to prevent collisions in shared cache systems.

     'prefix' => env('CACHE_PREFIX', 'bookstack'),
 
 ];
     'prefix' => env('CACHE_PREFIX', 'bookstack'),
 
 ];

diff --git a/config/compile.php b/config/compile.php
deleted file mode 100644 (file)
index 04807ea..0000000
--- a/config/compile.php
+++ /dev/null
@@ -1,35 +0,0 @@
-<?php
-
-return [
-
-    /*
-    |--------------------------------------------------------------------------
-    | Additional Compiled Classes
-    |--------------------------------------------------------------------------
-    |
-    | Here you may specify additional classes to include in the compiled file
-    | generated by the `artisan optimize` command. These should be classes
-    | that are included on basically every request into the application.
-    |
-    */
-
-    'files' => [
-        //
-    ],
-
-    /*
-    |--------------------------------------------------------------------------
-    | Compiled File Providers
-    |--------------------------------------------------------------------------
-    |
-    | Here you may list service providers which define a "compiles" function
-    | that returns additional files that should be compiled, providing an
-    | easy way to get common files from any packages you are utilizing.
-    |
-    */
-
-    'providers' => [
-        //
-    ],
-
-];

diff --git a/config/database.php b/config/database.php
index 3883b58686ae4abb54c26b7dc94578be236e6c6f..6ca902944ed14644d8ded1631ac4bc3ae0749746 100644 (file)
--- a/config/database.php
+++ b/config/database.php
@@ -1,5 +1,13 @@
 <?php
 
 <?php
 

+/**
+ * Database configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */
+

 // REDIS - Split out configuration into an array
 if (env('REDIS_SERVERS', false)) {
     $redisServerKeys = ['host', 'port', 'database'];
 // REDIS - Split out configuration into an array
 if (env('REDIS_SERVERS', false)) {
     $redisServerKeys = ['host', 'port', 'database'];


@@ -16,6 +24,7 @@ if (env('REDIS_SERVERS', false)) {
     }
 }
 
     }
 }
 

+// MYSQL - Split out port from host if set

 $mysql_host = env('DB_HOST', 'localhost');
 $mysql_host_exploded = explode(':', $mysql_host);
 $mysql_port = env('DB_PORT', 3306);
 $mysql_host = env('DB_HOST', 'localhost');
 $mysql_host_exploded = explode(':', $mysql_host);
 $mysql_port = env('DB_PORT', 3306);


@@ -26,48 +35,12 @@ if (count($mysql_host_exploded) > 1) {
 
 return [
 
 
 return [
 

-    /*
-    |--------------------------------------------------------------------------
-    | PDO Fetch Style
-    |--------------------------------------------------------------------------
-    |
-    | By default, database results will be returned as instances of the PHP
-    | stdClass object; however, you may desire to retrieve records in an
-    | array format for simplicity. Here you can tweak the fetch style.
-    |
-    */
-
-    'fetch' => PDO::FETCH_CLASS,
-
-    /*
-    |--------------------------------------------------------------------------
-    | Default Database Connection Name
-    |--------------------------------------------------------------------------
-    |
-    | Here you may specify which of the database connections below you wish
-    | to use as your default connection for all database work. Of course
-    | you may use many connections at once using the Database library.
-    |
-    */
-
+    // Default database connection name.
+    // Options: mysql, mysql_testing

     'default' => env('DB_CONNECTION', 'mysql'),
 
     'default' => env('DB_CONNECTION', 'mysql'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Database Connections
-    |--------------------------------------------------------------------------
-    |
-    | Here are each of the database connections setup for your application.
-    | Of course, examples of configuring each database platform that is
-    | supported by Laravel is shown below to make development simple.
-    |
-    |
-    | All database work in Laravel is done through the PHP PDO facilities
-    | so make sure you have the driver for your particular database of
-    | choice installed on your machine before you begin development.
-    |
-    */
-
+    // Available database connections
+    // Many of those shown here are unsupported by BookStack.

     'connections' => [
 
         'sqlite' => [
     'connections' => [
 
         'sqlite' => [


@@ -82,11 +55,13 @@ return [
             'database'  => env('DB_DATABASE', 'forge'),
             'username'  => env('DB_USERNAME', 'forge'),
             'password'  => env('DB_PASSWORD', ''),
             'database'  => env('DB_DATABASE', 'forge'),
             'username'  => env('DB_USERNAME', 'forge'),
             'password'  => env('DB_PASSWORD', ''),

+            'unix_socket' => env('DB_SOCKET', ''),

             'port'      => $mysql_port,
             'charset'   => 'utf8mb4',
             'collation' => 'utf8mb4_unicode_ci',
             'prefix'    => '',
             'strict'    => false,
             'port'      => $mysql_port,
             'charset'   => 'utf8mb4',
             'collation' => 'utf8mb4_unicode_ci',
             'prefix'    => '',
             'strict'    => false,

+            'engine' => null,

         ],
 
         'mysql_testing' => [
         ],
 
         'mysql_testing' => [


@@ -124,30 +99,13 @@ return [
 
     ],
 
 
     ],
 

-    /*
-    |--------------------------------------------------------------------------
-    | Migration Repository Table
-    |--------------------------------------------------------------------------
-    |
-    | This table keeps track of all the migrations that have already run for
-    | your application. Using this information, we can determine which of
-    | the migrations on disk haven't actually been run in the database.
-    |
-    */
-
+    // Migration Repository Table
+    // This table keeps track of all the migrations that have already run for
+    // your application. Using this information, we can determine which of
+    // the migrations on disk haven't actually been run in the database.

     'migrations' => 'migrations',
 
     'migrations' => 'migrations',
 

-    /*
-    |--------------------------------------------------------------------------
-    | Redis Databases
-    |--------------------------------------------------------------------------
-    |
-    | Redis is an open source, fast, and advanced key-value store that also
-    | provides a richer set of commands than a typical key-value systems
-    | such as APC or Memcached. Laravel makes it easy to dig right in.
-    |
-    */
-
+    // Redis configuration to use if set

     'redis' => env('REDIS_SERVERS', false) ? $redisConfig : [],
 
 ];
     'redis' => env('REDIS_SERVERS', false) ? $redisConfig : [],
 
 ];

diff --git a/config/dompdf.php b/config/dompdf.php
index 036e1bb3c7b601a04f367035807d1834fbff69e5..77f0cff9c73738cd40eb61c54fe56b3053a5c76a 100644 (file)
--- a/config/dompdf.php
+++ b/config/dompdf.php
@@ -1,16 +1,16 @@
 <?php
 
 <?php
 

+/**
+ * DOMPDF configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */
+

 return [
 
 return [
 

-    /*
-    |--------------------------------------------------------------------------
-    | Settings
-    |--------------------------------------------------------------------------
-    |
-    | Set some default values. It is possible to add all defines that can be set
-    | in dompdf_config.inc.php. You can also override the entire config file.
-    |
-    */
+

     'show_warnings' => false,   // Throw an Exception on warnings from dompdf
     'orientation' => 'portrait',
     'defines' => [
     'show_warnings' => false,   // Throw an Exception on warnings from dompdf
     'orientation' => 'portrait',
     'defines' => [

diff --git a/config/filesystems.php b/config/filesystems.php
index b7ebf5b2dadf752cfb7977fd36651bdb2d998ab4..abaf3c6a47b76564c286d23282fa54fb38394f62 100644 (file)
--- a/config/filesystems.php
+++ b/config/filesystems.php
@@ -1,57 +1,29 @@
 <?php
 
 <?php
 

-return [
+/**
+ * Filesystem configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */

 
 

-    /*
-    |--------------------------------------------------------------------------
-    | Default Filesystem Disk
-    |--------------------------------------------------------------------------
-    |
-    | Here you may specify the default filesystem disk that should be used
-    | by the framework. A "local" driver, as well as a variety of cloud
-    | based drivers are available for your choosing. Just store away!
-    |
-    | Supported: "local", "ftp", "s3", "rackspace"
-    |
-    */
+return [

 
 

+    // Default Filesystem Disk
+    // Options: local, local_secure, s3

     'default' => env('STORAGE_TYPE', 'local'),
 
     'default' => env('STORAGE_TYPE', 'local'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Storage URL
-    |--------------------------------------------------------------------------
-    |
-    | This is the url to where the storage is located for when using an external
-    | file storage service, such as s3, to store publicly accessible assets.
-    |
-    */
+    // Storage URL
+    // This is the url to where the storage is located for when using an external
+    // file storage service, such as s3, to store publicly accessible assets.

     'url' => env('STORAGE_URL', false),
 
     'url' => env('STORAGE_URL', false),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Default Cloud Filesystem Disk
-    |--------------------------------------------------------------------------
-    |
-    | Many applications store files both locally and in the cloud. For this
-    | reason, you may specify a default "cloud" driver here. This driver
-    | will be bound as the Cloud disk implementation in the container.
-    |
-    */
-
+    // Default Cloud Filesystem Disk

     'cloud' => 's3',
 
     'cloud' => 's3',
 

-    /*
-    |--------------------------------------------------------------------------
-    | Filesystem Disks
-    |--------------------------------------------------------------------------
-    |
-    | Here you may configure as many filesystem "disks" as you wish, and you
-    | may even configure multiple disks of the same driver. Defaults have
-    | been setup for each driver as an example of the required options.
-    |
-    */
-
+    // Available filesystem disks
+    // Only local, local_secure & s3 are supported by BookStack

     'disks' => [
 
         'local' => [
     'disks' => [
 
         'local' => [


@@ -69,13 +41,6 @@ return [
             'host'     => 'ftp.example.com',
             'username' => 'your-username',
             'password' => 'your-password',
             'host'     => 'ftp.example.com',
             'username' => 'your-username',
             'password' => 'your-password',

-
-            // Optional FTP Settings...
-            // 'port'     => 21,
-            // 'root'     => '',
-            // 'passive'  => true,
-            // 'ssl'      => true,
-            // 'timeout'  => 30,

         ],
 
         's3' => [
         ],
 
         's3' => [

diff --git a/config/mail.php b/config/mail.php
index a5aff0239886ed285417f48ad0d80ebbf0b595e2..49407bd8eae1f34d08931795f95c4d893ee63a09 100644 (file)
--- a/config/mail.php
+++ b/config/mail.php
@@ -1,123 +1,44 @@
 <?php
 
 <?php
 

-return [
+/**
+ * Mail configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */

 
 

-    /*
-    |--------------------------------------------------------------------------
-    | Mail Driver
-    |--------------------------------------------------------------------------
-    |
-    | Laravel supports both SMTP and PHP's "mail" function as drivers for the
-    | sending of e-mail. You may specify which one you're using throughout
-    | your application here. By default, Laravel is setup for SMTP mail.
-    |
-    | Supported: "smtp", "mail", "sendmail", "mailgun", "mandrill", "ses", "log"
-    |
-    */
+return [

 
 

+    // Mail driver to use.
+    // Options: smtp, mail, sendmail, log

     'driver' => env('MAIL_DRIVER', 'smtp'),
 
     'driver' => env('MAIL_DRIVER', 'smtp'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | SMTP Host Address
-    |--------------------------------------------------------------------------
-    |
-    | Here you may provide the host address of the SMTP server used by your
-    | applications. A default option is provided that is compatible with
-    | the Mailgun mail service which will provide reliable deliveries.
-    |
-    */
-
+    // SMTP host address

     'host' => env('MAIL_HOST', 'smtp.mailgun.org'),
 
     'host' => env('MAIL_HOST', 'smtp.mailgun.org'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | SMTP Host Port
-    |--------------------------------------------------------------------------
-    |
-    | This is the SMTP port used by your application to deliver e-mails to
-    | users of the application. Like the host we have set this value to
-    | stay compatible with the Mailgun e-mail application by default.
-    |
-    */
-
+    // SMTP host port

     'port' => env('MAIL_PORT', 587),
 
     'port' => env('MAIL_PORT', 587),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Global "From" Address
-    |--------------------------------------------------------------------------
-    |
-    | You may wish for all e-mails sent by your application to be sent from
-    | the same address. Here, you may specify a name and address that is
-    | used globally for all e-mails that are sent by your application.
-    |
-    */
-
-    'from' => ['address' => env('MAIL_FROM', '[email protected]'), 'name' => env('MAIL_FROM_NAME','BookStack')],
-
-    /*
-    |--------------------------------------------------------------------------
-    | E-Mail Encryption Protocol
-    |--------------------------------------------------------------------------
-    |
-    | Here you may specify the encryption protocol that should be used when
-    | the application send e-mail messages. A sensible default using the
-    | transport layer security protocol should provide great security.
-    |
-    */
+    // Global "From" address & name
+    'from' => [
+        'address' => env('MAIL_FROM', '[email protected]'),
+        'name' => env('MAIL_FROM_NAME','BookStack')
+    ],

 
 

+    // Email encryption protocol

     'encryption' => env('MAIL_ENCRYPTION', 'tls'),
 
     'encryption' => env('MAIL_ENCRYPTION', 'tls'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | SMTP Server Username
-    |--------------------------------------------------------------------------
-    |
-    | If your SMTP server requires a username for authentication, you should
-    | set it here. This will get used to authenticate with your server on
-    | connection. You may also set the "password" value below this one.
-    |
-    */
-
+    // SMTP server username

     'username' => env('MAIL_USERNAME'),
 
     'username' => env('MAIL_USERNAME'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | SMTP Server Password
-    |--------------------------------------------------------------------------
-    |
-    | Here you may set the password required by your SMTP server to send out
-    | messages from your application. This will be given to the server on
-    | connection so that the application will be able to send messages.
-    |
-    */
-
+    // SMTP server password

     'password' => env('MAIL_PASSWORD'),
 
     'password' => env('MAIL_PASSWORD'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Sendmail System Path
-    |--------------------------------------------------------------------------
-    |
-    | When using the "sendmail" driver to send e-mails, we will need to know
-    | the path to where Sendmail lives on this server. A default path has
-    | been provided here, which will work well on most of your systems.
-    |
-    */
-
+    // Sendmail application path

     'sendmail' => '/usr/sbin/sendmail -bs',
 
     'sendmail' => '/usr/sbin/sendmail -bs',
 

-    /*
-    |--------------------------------------------------------------------------
-    | Markdown Mail Settings
-    |--------------------------------------------------------------------------
-    |
-    | If you are using Markdown based email rendering, you may configure your
-    | theme and component paths here, allowing you to customize the design
-    | of the emails. Or, you may simply stick with the Laravel defaults!
-    |
-    */
+    // Email markdown configuration

     'markdown' => [
         'theme' => 'default',
         'paths' => [
     'markdown' => [
         'theme' => 'default',
         'paths' => [

diff --git a/config/queue.php b/config/queue.php
index cf9b09da01f7f4d45eda6a2b2d8f80e1dc68d139..721eac13685cccaebc05b4e9ec417289017c4929 100644 (file)
--- a/config/queue.php
+++ b/config/queue.php
@@ -1,34 +1,20 @@
 <?php
 
 <?php
 

-return [
+/**
+ * Queue configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */

 
 

-    /*
-    |--------------------------------------------------------------------------
-    | Default Queue Driver
-    |--------------------------------------------------------------------------
-    |
-    | The Laravel queue API supports a variety of back-ends via an unified
-    | API, giving you convenient access to each back-end using the same
-    | syntax for each one. Here you may set the default queue driver.
-    |
-    | Supported: "null", "sync", "database", "beanstalkd",
-    |            "sqs", "iron", "redis"
-    |
-    */
+return [

 
 

+    // Default driver to use for the queue
+    // Options: null, sync, redis

     'default' => env('QUEUE_DRIVER', 'sync'),
 
     'default' => env('QUEUE_DRIVER', 'sync'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Queue Connections
-    |--------------------------------------------------------------------------
-    |
-    | Here you may configure the connection information for each server that
-    | is used by your application. A default configuration has been added
-    | for each back-end shipped with Laravel. You are free to add more.
-    |
-    */
-
+    // Queue connection configuration

     'connections' => [
 
         'sync' => [
     'connections' => [
 
         'sync' => [


@@ -75,17 +61,7 @@ return [
 
     ],
 
 
     ],
 

-    /*
-    |--------------------------------------------------------------------------
-    | Failed Queue Jobs
-    |--------------------------------------------------------------------------
-    |
-    | These options configure the behavior of failed queue job logging so you
-    | can control which database and table are used to store the jobs that
-    | have failed. You may change them to any database / table you wish.
-    |
-    */
-
+    // Failed queue job logging

     'failed' => [
         'database' => 'mysql', 'table' => 'failed_jobs',
     ],
     'failed' => [
         'database' => 'mysql', 'table' => 'failed_jobs',
     ],

diff --git a/config/services.php b/config/services.php
index a07fab23f14dbe317704d6f19421562e68d72607..f713f9d3897df3caf051805bdb64bd0f25ae9a4a 100644 (file)
--- a/config/services.php
+++ b/config/services.php
@@ -1,18 +1,14 @@
 <?php
 
 <?php
 

-return [
+/**
+ * Third party service configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */

 
 

-    /*
-    |--------------------------------------------------------------------------
-    | Third Party Services
-    |--------------------------------------------------------------------------
-    |
-    | This file is for storing the credentials for third party services such
-    | as Stripe, Mailgun, Mandrill, and others. This file provides a sane
-    | default location for this type of information, allowing packages
-    | to have a conventional place to find your various credentials.
-    |
-    */
+return [

 
     // Single option to disable non-auth external services such as Gravatar and Draw.io
     'disable_services' => env('DISABLE_EXTERNAL_SERVICES', false),
 
     // Single option to disable non-auth external services such as Gravatar and Draw.io
     'disable_services' => env('DISABLE_EXTERNAL_SERVICES', false),


@@ -31,10 +27,6 @@ return [
         'secret' => '',
     ],
 
         'secret' => '',
     ],
 

-    'mandrill' => [
-        'secret' => '',
-    ],
-

     'ses'      => [
         'key'    => '',
         'secret' => '',
     'ses'      => [
         'key'    => '',
         'secret' => '',

diff --git a/config/session.php b/config/session.php
index 328fed27d7121f2a12b2dbb18f1ccd5cefac6691..09bdad499933112cf9bc05dc89498a25fcadc7a7 100644 (file)
--- a/config/session.php
+++ b/config/session.php
@@ -1,181 +1,81 @@
 <?php
 
 <?php
 

-return [
+/**
+ * Session configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */

 
 

-    /*
-    |--------------------------------------------------------------------------
-    | Default Session Driver
-    |--------------------------------------------------------------------------
-    |
-    | This option controls the default session "driver" that will be used on
-    | requests. By default, we will use the lightweight native driver but
-    | you may specify any of the other wonderful drivers provided here.
-    |
-    | Supported: "file", "cookie", "database", "apc",
-    |            "memcached", "redis", "array"
-    |
-    */
+return [

 
 

+    // Default session driver
+    // Options: file, cookie, database, redis, memcached, array

     'driver' => env('SESSION_DRIVER', 'file'),
 
     'driver' => env('SESSION_DRIVER', 'file'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Session Lifetime
-    |--------------------------------------------------------------------------
-    |
-    | Here you may specify the number of minutes that you wish the session
-    | to be allowed to remain idle before it expires. If you want them
-    | to immediately expire on the browser closing, set that option.
-    |
-    */

 
 

+    // Session lifetime, in minutes

     'lifetime' => env('SESSION_LIFETIME', 120),
 
     'lifetime' => env('SESSION_LIFETIME', 120),
 

+    // Expire session on browser close

     'expire_on_close' => false,
 
     'expire_on_close' => false,
 

-    /*
-    |--------------------------------------------------------------------------
-    | Session Encryption
-    |--------------------------------------------------------------------------
-    |
-    | This option allows you to easily specify that all of your session data
-    | should be encrypted before it is stored. All encryption will be run
-    | automatically by Laravel and you can use the Session like normal.
-    |
-    */
-
+    // Encrypt session data

     'encrypt' => false,
 
     'encrypt' => false,
 

-    /*
-    |--------------------------------------------------------------------------
-    | Session File Location
-    |--------------------------------------------------------------------------
-    |
-    | When using the native session driver, we need a location where session
-    | files may be stored. A default has been set for you but a different
-    | location may be specified. This is only needed for file sessions.
-    |
-    */
-
+    // Location to store session files

     'files' => storage_path('framework/sessions'),
 
     'files' => storage_path('framework/sessions'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Session Database Connection
-    |--------------------------------------------------------------------------
-    |
-    | When using the "database" or "redis" session drivers, you may specify a
-    | connection that should be used to manage these sessions. This should
-    | correspond to a connection in your database configuration options.
-    |
-    */
-
+    // Session Database Connection
+    // When using the "database" or "redis" session drivers, you can specify a
+    // connection that should be used to manage these sessions. This should
+    // correspond to a connection in your database configuration options.

     'connection' => null,
 
     'connection' => null,
 

-    /*
-    |--------------------------------------------------------------------------
-    | Session Database Table
-    |--------------------------------------------------------------------------
-    |
-    | When using the "database" session driver, you may specify the table we
-    | should use to manage the sessions. Of course, a sensible default is
-    | provided for you; however, you are free to change this as needed.
-    |
-    */
-
+    // Session database table, if database driver is in use

     'table' => 'sessions',
 
     'table' => 'sessions',
 

-    /*
-    |--------------------------------------------------------------------------
-    | Session Sweeping Lottery
-    |--------------------------------------------------------------------------
-    |
-    | Some session drivers must manually sweep their storage location to get
-    | rid of old sessions from storage. Here are the chances that it will
-    | happen on a given request. By default, the odds are 2 out of 100.
-    |
-    */
-
+    // Session Sweeping Lottery
+    // Some session drivers must manually sweep their storage location to get
+    // rid of old sessions from storage. Here are the chances that it will
+    // happen on a given request. By default, the odds are 2 out of 100.

     'lottery' => [2, 100],
 
     'lottery' => [2, 100],
 

-    /*
-    |--------------------------------------------------------------------------
-    | Session Cookie Name
-    |--------------------------------------------------------------------------
-    |
-    | Here you may change the name of the cookie used to identify a session
-    | instance by ID. The name specified here will get used every time a
-    | new session cookie is created by the framework for every driver.
-    |
-    */

 
 

+    // Session Cookie Name
+    // Here you may change the name of the cookie used to identify a session
+    // instance by ID. The name specified here will get used every time a
+    // new session cookie is created by the framework for every driver.

     'cookie' => env('SESSION_COOKIE_NAME', 'bookstack_session'),
 
     'cookie' => env('SESSION_COOKIE_NAME', 'bookstack_session'),
 

-    /*
-    |--------------------------------------------------------------------------
-    | Session Cookie Path
-    |--------------------------------------------------------------------------
-    |
-    | The session cookie path determines the path for which the cookie will
-    | be regarded as available. Typically, this will be the root path of
-    | your application but you are free to change this when necessary.
-    |
-    */
-
+    // Session Cookie Path
+    // The session cookie path determines the path for which the cookie will
+    // be regarded as available. Typically, this will be the root path of
+    // your application but you are free to change this when necessary.

     'path' => '/',
 
     'path' => '/',
 

-    /*
-    |--------------------------------------------------------------------------
-    | Session Cookie Domain
-    |--------------------------------------------------------------------------
-    |
-    | Here you may change the domain of the cookie used to identify a session
-    | in your application. This will determine which domains the cookie is
-    | available to in your application. A sensible default has been set.
-    |
-    */
-
+    // Session Cookie Domain
+    // Here you may change the domain of the cookie used to identify a session
+    // in your application. This will determine which domains the cookie is
+    // available to in your application. A sensible default has been set.

     'domain' => env('SESSION_DOMAIN', null),
 
     'domain' => env('SESSION_DOMAIN', null),
 

-    /*
-    |--------------------------------------------------------------------------
-    | HTTPS Only Cookies
-    |--------------------------------------------------------------------------
-    |
-    | By setting this option to true, session cookies will only be sent back
-    | to the server if the browser has a HTTPS connection. This will keep
-    | the cookie from being sent to you if it can not be done securely.
-    |
-    */
-
+    // HTTPS Only Cookies
+    // By setting this option to true, session cookies will only be sent back
+    // to the server if the browser has a HTTPS connection. This will keep
+    // the cookie from being sent to you if it can not be done securely.

     'secure' => env('SESSION_SECURE_COOKIE', false),
 
     'secure' => env('SESSION_SECURE_COOKIE', false),
 

-    /*
-    |--------------------------------------------------------------------------
-    | HTTP Access Only
-    |--------------------------------------------------------------------------
-    |
-    | Setting this value to true will prevent JavaScript from accessing the
-    | value of the cookie and the cookie will only be accessible through
-    | the HTTP protocol. You are free to modify this option if needed.
-    |
-    */
-
+    // HTTP Access Only
+    // Setting this value to true will prevent JavaScript from accessing the
+    // value of the cookie and the cookie will only be accessible through the HTTP protocol.

     'http_only' => true,
 
     'http_only' => true,
 

-    /*
-    |--------------------------------------------------------------------------
-    | Same-Site Cookies
-    |--------------------------------------------------------------------------
-    |
-    | This option determines how your cookies behave when cross-site requests
-    | take place, and can be used to mitigate CSRF attacks. By default, we
-    | do not enable this as other CSRF protection services are in place.
-    |
-    | Supported: "lax", "strict"
-    |
-    */
-
+    // Same-Site Cookies
+    // This option determines how your cookies behave when cross-site requests
+    // take place, and can be used to mitigate CSRF attacks. By default, we
+    // do not enable this as other CSRF protection services are in place.
+    // Options: lax, strict

     'same_site' => null,
     'same_site' => null,

-

 ];
 ];

diff --git a/config/setting-defaults.php b/config/setting-defaults.php
index db35023d5e727f926a63f7858d28cc64cb2a34b2..b48253eb190f1cc408c50fc944bc41b8a8d79f28 100644 (file)
--- a/config/setting-defaults.php
+++ b/config/setting-defaults.php
@@ -1,17 +1,22 @@
 <?php
 
 /**
 <?php
 
 /**

- * The defaults for the system settings that are saved in the database.
+ * Default system settings.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.

  */
  */

+

 return [
 
 return [
 

-    'app-name'        => 'BookStack',
-    'app-logo' => '',
-    'app-name-header' => true,
-    'app-editor'      => 'wysiwyg',
-    'app-color'       => '#0288D1',
-    'app-color-light' => 'rgba(21, 101, 192, 0.15)',
-    'app-custom-head' => false,
+    'app-name'             => 'BookStack',
+    'app-logo'             => '',
+    'app-name-header'      => true,
+    'app-editor'           => 'wysiwyg',
+    'app-color'            => '#0288D1',
+    'app-color-light'      => 'rgba(21, 101, 192, 0.15)',
+    'app-custom-head'      => false,

     'registration-enabled' => false,
 
 ];
\ No newline at end of file
     'registration-enabled' => false,
 
 ];
\ No newline at end of file

diff --git a/config/snappy.php b/config/snappy.php
index 73f21fd30b795c26941c3c086584bfbe7798a662..60c26ffd531d2477b9c236c067388f274368bc9b 100644 (file)
--- a/config/snappy.php
+++ b/config/snappy.php
@@ -1,5 +1,13 @@
 <?php
 
 <?php
 

+/**
+ * SnappyPDF configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */
+

 return [
     'pdf' => [
         'enabled' => true,
 return [
     'pdf' => [
         'enabled' => true,

diff --git a/config/view.php b/config/view.php
index e9a96c8ab8df3c04d6de5801b57920b4ec6706d9..80bc9ef8fe8385a711e0295cbacb868e6b74bac9 100644 (file)
--- a/config/view.php
+++ b/config/view.php
@@ -1,5 +1,14 @@
 <?php
 
 <?php
 

+/**
+ * View configuration options.
+ *
+ * Changes to these config files are not supported by BookStack and may break upon updates.
+ * Configuration should be altered via the `.env` file or environment variables.
+ * Do not edit this file unless you're happy to maintain any changes yourself.
+ */
+
+// Join up possible view locations

 $viewPaths = [realpath(base_path('resources/views'))];
 if ($theme = env('APP_THEME', false)) {
     array_unshift($viewPaths, base_path('themes/' . $theme));
 $viewPaths = [realpath(base_path('resources/views'))];
 if ($theme = env('APP_THEME', false)) {
     array_unshift($viewPaths, base_path('themes/' . $theme));


@@ -7,43 +16,22 @@ if ($theme = env('APP_THEME', false)) {
 
 return [
 
 
 return [
 

-    /*
-    |--------------------------------------------------------------------------
-    | App theme
-    |--------------------------------------------------------------------------
-    |
-    | This option defines the theme to use for the application. When a theme
-    | is set there mush be a `themes/<theme_name>` folder to hold the
-    | custom theme overrides.
-    |
-    */
-
+    // App theme
+    // This option defines the theme to use for the application. When a theme
+    // is set there must be a `themes/<theme_name>` folder to hold the
+    // custom theme overrides.

     'theme' => env('APP_THEME', false),
 
     'theme' => env('APP_THEME', false),
 

-    /*
-    |--------------------------------------------------------------------------
-    | View Storage Paths
-    |--------------------------------------------------------------------------
-    |
-    | Most templating systems load templates from disk. Here you may specify
-    | an array of paths that should be checked for your views. Of course
-    | the usual Laravel view path has already been registered for you.
-    |
-    */
-
+    // View Storage Paths
+    // Most templating systems load templates from disk. Here you may specify
+    // an array of paths that should be checked for your views. Of course
+    // the usual Laravel view path has already been registered for you.

     'paths' => $viewPaths,
 
     'paths' => $viewPaths,
 

-    /*
-    |--------------------------------------------------------------------------
-    | Compiled View Path
-    |--------------------------------------------------------------------------
-    |
-    | This option determines where all the compiled Blade templates will be
-    | stored for your application. Typically, this is within the storage
-    | directory. However, as usual, you are free to change this value.
-    |
-    */
-
+    // Compiled View Path
+    // This option determines where all the compiled Blade templates will be
+    // stored for your application. Typically, this is within the storage
+    // directory. However, as usual, you are free to change this value.

     'compiled' => realpath(storage_path('framework/views')),
 
 ];
     'compiled' => realpath(storage_path('framework/views')),
 
 ];