BookStack Code Mirror - bookstack/blob - .env.example

   1 # This file, when named as ".env" in the root of your BookStack install
   2 # folder, is used for the core configuration of the application.
   3 # By default this file contains the most common required options but
   4 # a full list of options can be found in the '.env.example.complete' file.
   5
   6 # NOTE: If any of your values contain a space or a hash you will need to
   7 # wrap the entire value in quotes. (eg. MAIL_FROM_NAME="BookStack Mailer")
   8
   9 # Application key
  10 # Used for encryption where needed.
  11 # Run `php artisan key:generate` to generate a valid key.
  12 APP_KEY=SomeRandomString
  13
  14 # Application URL
  15 # This must be the root URL that you want to host BookStack on.
  16 # All URLs in BookStack will be generated using this value
  17 # to ensure URLs generated are consistent and secure.
  18 # If you change this in the future you may need to run a command
  19 # to update stored URLs in the database. Command example:
  20 # php artisan bookstack:update-url https://old.example.com https://new.example.com
  21 APP_URL=https://example.com
  22
  23 # Database details
  24 DB_HOST=localhost
  25 DB_DATABASE=database_database
  26 DB_USERNAME=database_username
  27 DB_PASSWORD=database_user_password
  28
  29 # Storage system to use
  30 # By default files are stored on the local filesystem, with images being placed in
  31 # public web space so they can be efficiently served directly by the web-server.
  32 # For other options with different security levels & considerations, refer to:
  33 # https://www.bookstackapp.com/docs/admin/upload-config/
  34 STORAGE_TYPE=local
  35
  36 # Mail system to use
  37 # Can be 'smtp' or 'sendmail'
  38 MAIL_DRIVER=smtp
  39
  40 # Mail sender details
  41 MAIL_FROM_NAME="BookStack"
  42 MAIL_FROM=bookstack@example.com
  43
  44 # SMTP mail options
  45 # These settings can be checked using the "Send a Test Email"
  46 # feature found in the "Settings > Maintenance" area of the system.
  47 # For more detailed documentation on mail options, refer to:
  48 # https://www.bookstackapp.com/docs/admin/email-webhooks/#email-configuration
  49 MAIL_HOST=localhost
  50 MAIL_PORT=587
  51 MAIL_USERNAME=null
  52 MAIL_PASSWORD=null
  53 MAIL_ENCRYPTION=null