From 162d89314325084e8dbdb6591d8dc5fa241defcd Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Sun, 6 Dec 2020 12:31:36 +0000 Subject: [PATCH] Updated .env.example to encorage use of setting APP_URL For the purposes of secure URL generation and to avoid common problems found when people are using reverse proxies. --- .env.example | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/.env.example b/.env.example index 47f2367b0..05383f04a 100644 --- a/.env.example +++ b/.env.example @@ -12,11 +12,13 @@ APP_KEY=SomeRandomString # Application URL -# Remove the hash below and set a URL if using BookStack behind -# 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 +# All URLs in BookStack will be generated using this value +# to ensure URLs generated are consistent and secure. +# If you change this in the future you may need to run a command +# to update stored URLs in the database. Command example: +# php artisan bookstack:update-url https://old.example.com https://new.example.com +APP_URL=https://example.com # Database details DB_HOST=localhost @@ -28,8 +30,8 @@ DB_PASSWORD=database_user_password # Can be 'smtp' or 'sendmail' MAIL_DRIVER=smtp -# Mail sender options -MAIL_FROM_NAME=BookStack +# Mail sender details +MAIL_FROM_NAME="BookStack" MAIL_FROM=bookstack@example.com # SMTP mail options