BookStack/.env.example

# 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.
APP_KEY=SomeRandomString

# Application URL
# This must be the root URL that you want to host BookStack on.
# 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
DB_DATABASE=database_database
DB_USERNAME=database_username
DB_PASSWORD=database_user_password

# Mail system to use
# Can be 'smtp' or 'sendmail'
MAIL_DRIVER=smtp

# Mail sender details
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.
# For more detailed documentation on mail options, refer to:
# https://www.bookstackapp.com/docs/admin/email-webhooks/#email-configuration
MAIL_HOST=localhost
MAIL_PORT=587
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
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 2020-09-19 11:09:43 -04:00			`# 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")`

Simplified example env and created full example copy 2019-01-06 10:46:16 -05:00			`# Application key`
			`# Used for encryption where needed.`
			# Run `php artisan key:generate` to generate a valid key.
Initial commit 2015-07-12 15:01:42 -04:00			`APP_KEY=SomeRandomString`

Simplified example env and created full example copy 2019-01-06 10:46:16 -05:00			`# Application URL`
			`# This must be the root URL that you want to host BookStack on.`
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. 2020-12-06 07:31:36 -05:00			`# 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`
Updated all application urls to allow path prefix. Allows BookStack to be installed at a non-root location on a domain. Closes #40. 2016-08-14 07:29:35 -04:00
Refactored Social auth into service, Made entity an abstract class 2015-09-04 12:50:52 -04:00			`# Database details`
Initial commit 2015-07-12 15:01:42 -04:00			`DB_HOST=localhost`
Refactored Social auth into service, Made entity an abstract class 2015-09-04 12:50:52 -04:00			`DB_DATABASE=database_database`
			`DB_USERNAME=database_username`
Updated readme with social & update instructions 2016-01-02 11:24:09 -05:00			`DB_PASSWORD=database_user_password`
Initial commit 2015-07-12 15:01:42 -04:00
Simplified example env and created full example copy 2019-01-06 10:46:16 -05:00			`# Mail system to use`
Updated default mail options 2020-03-14 13:32:11 -04:00			`# Can be 'smtp' or 'sendmail'`
Initial commit 2015-07-12 15:01:42 -04:00			`MAIL_DRIVER=smtp`
Simplified example env and created full example copy 2019-01-06 10:46:16 -05:00
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. 2020-12-06 07:31:36 -05:00			`# Mail sender details`
			`MAIL_FROM_NAME="BookStack"`
Updated default mail options 2020-03-14 13:32:11 -04:00			`MAIL_FROM=bookstack@example.com`

Simplified example env and created full example copy 2019-01-06 10:46:16 -05:00			`# SMTP mail options`
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 2020-09-19 11:09:43 -04:00			`# These settings can be checked using the "Send a Test Email"`
			`# feature found in the "Settings > Maintenance" area of the system.`
Mail Config: Updated how TLS is configured After full review of current MAIL_ENCRYPTION usage in laravel and smyfony mailer, this updates the options in BookStack to be simplified and specific in usage: - Removed mail.mailers.smtp.encryption option since it did not actually affect anything in the current state of dependancies. - Updated MAIL_ENCRYPTION so values of tls OR ssl will force-enable tls via 'scheme' option with laravel passes to the SMTP transfport, which Smyfony uses as an indicator to force TLS. When MAIL_ENCRYPTION is not used, STARTTLS will still be attempted by symfony mailer. Updated .env files to refer to BookStack docs (which was updated for this) and to reflect correct default port. Related to #4342 2023-06-24 06:27:18 -04:00			`# For more detailed documentation on mail options, refer to:`
			`# https://www.bookstackapp.com/docs/admin/email-webhooks/#email-configuration`
Refactored Social auth into service, Made entity an abstract class 2015-09-04 12:50:52 -04:00			`MAIL_HOST=localhost`
Mail Config: Updated how TLS is configured After full review of current MAIL_ENCRYPTION usage in laravel and smyfony mailer, this updates the options in BookStack to be simplified and specific in usage: - Removed mail.mailers.smtp.encryption option since it did not actually affect anything in the current state of dependancies. - Updated MAIL_ENCRYPTION so values of tls OR ssl will force-enable tls via 'scheme' option with laravel passes to the SMTP transfport, which Smyfony uses as an indicator to force TLS. When MAIL_ENCRYPTION is not used, STARTTLS will still be attempted by symfony mailer. Updated .env files to refer to BookStack docs (which was updated for this) and to reflect correct default port. Related to #4342 2023-06-24 06:27:18 -04:00			`MAIL_PORT=587`
Initial commit 2015-07-12 15:01:42 -04:00			`MAIL_USERNAME=null`
			`MAIL_PASSWORD=null`
Allow to use DB tables prefix 2021-09-19 08:32:35 -04:00			`MAIL_ENCRYPTION=null`