From 9e11fc33fa6cf657b35af97a268210ec447c59a7 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Sat, 19 Sep 2020 16:09:43 +0100 Subject: [PATCH] Updated example env with helpful info - Added comments to explain the use of the file. - Added comments to advise that space/hash containing values would need to be quoted. Related to #2258 --- .env.example | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/.env.example b/.env.example index f5e81277c..47f2367b0 100644 --- a/.env.example +++ b/.env.example @@ -1,3 +1,11 @@ +# This file, when named as ".env" in the root of your BookStack install +# folder, is used for the core configuration of the application. +# By default this file contains the most common required options but +# a full list of options can be found in the '.env.example.complete' file. + +# NOTE: If any of your values contain a space or a hash you will need to +# wrap the entire value in quotes. (eg. MAIL_FROM_NAME="BookStack Mailer") + # Application key # Used for encryption where needed. # Run `php artisan key:generate` to generate a valid key. @@ -5,7 +13,7 @@ APP_KEY=SomeRandomString # Application URL # Remove the hash below and set a URL if using BookStack behind -# a proxy, if using a third-party authentication option. +# a proxy or if using a third-party authentication option. # This must be the root URL that you want to host BookStack on. # All URL's in BookStack will be generated using this value. #APP_URL=https://example.com @@ -25,11 +33,10 @@ MAIL_FROM_NAME=BookStack MAIL_FROM=bookstack@example.com # SMTP mail options +# These settings can be checked using the "Send a Test Email" +# feature found in the "Settings > Maintenance" area of the system. MAIL_HOST=localhost MAIL_PORT=1025 MAIL_USERNAME=null MAIL_PASSWORD=null -MAIL_ENCRYPTION=null - - -# A full list of options can be found in the '.env.example.complete' file. \ No newline at end of file +MAIL_ENCRYPTION=null \ No newline at end of file