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

   1 # Full list of environment variables that can be used with BookStack.
   2 # Selectively copy these to your '.env' file as required.
   3 # Each option is shown with it's default value.
   4 # Do not copy this whole file to use as your '.env' file.
   5
   6 # The details here only serve as a quick reference.
   7 # Please refer to the BookStack documentation for full details:
   8 # https://www.bookstackapp.com/docs/
   9
  10 # Application environment
  11 # Can be 'production', 'development', 'testing' or 'demo'
  12 APP_ENV=production
  13
  14 # Enable debug mode
  15 # Shows advanced debug information and errors.
  16 # CAN EXPOSE OTHER VARIABLES, LEAVE DISABLED
  17 APP_DEBUG=false
  18
  19 # Application key
  20 # Used for encryption where needed.
  21 # Run `php artisan key:generate` to generate a valid key.
  22 APP_KEY=SomeRandomString
  23
  24 # Application URL
  25 # This must be the root URL that you want to host BookStack on.
  26 # All URL's in BookStack will be generated using this value.
  27 APP_URL=https://example.com
  28
  29 # Application default language
  30 # The default language choice to show.
  31 # May be overridden by user-preference or visitor browser settings.
  32 APP_LANG=en
  33
  34 # Auto-detect language for public visitors.
  35 # Uses browser-sent headers to infer a language.
  36 # APP_LANG will be used if such a header is not provided.
  37 APP_AUTO_LANG_PUBLIC=true
  38
  39 # Application timezone
  40 # Used where dates are displayed such as on exported content.
  41 # Valid timezone values can be found here: https://www.php.net/manual/en/timezones.php
  42 APP_TIMEZONE=UTC
  43
  44 # Application theme
  45 # Used to specific a themes/<APP_THEME> folder where BookStack UI
  46 # overrides can be made. Defaults to disabled.
  47 APP_THEME=false
  48
  49 # Trusted proxies
  50 # Used to indicate trust of systems that proxy to the application so
  51 # certain header values (Such as "X-Forwarded-For") can be used from the
  52 # incoming proxy request to provide origin detail.
  53 # Set to an IP address, or multiple comma seperated IP addresses.
  54 # Can alternatively be set to "*" to trust all proxy addresses.
  55 APP_PROXIES=null
  56
  57 # Database details
  58 # Host can contain a port (localhost:3306) or a separate DB_PORT option can be used.
  59 DB_HOST=localhost
  60 DB_PORT=3306
  61 DB_DATABASE=database_database
  62 DB_USERNAME=database_username
  63 DB_PASSWORD=database_user_password
  64
  65 # MySQL specific connection options
  66 # Path to Certificate Authority (CA) certificate file for your MySQL instance.
  67 # When this option is used host name identity verification will be performed
  68 # which checks the hostname, used by the client, against names within the
  69 # certificate itself (Common Name or Subject Alternative Name).
  70 MYSQL_ATTR_SSL_CA="/path/to/ca.pem"
  71
  72 # Mail configuration
  73 # Refer to https://www.bookstackapp.com/docs/admin/email-webhooks/#email-configuration
  74 MAIL_DRIVER=smtp
  75 [email protected]
  76 MAIL_FROM_NAME=BookStack
  77
  78 MAIL_HOST=localhost
  79 MAIL_PORT=587
  80 MAIL_USERNAME=null
  81 MAIL_PASSWORD=null
  82 MAIL_ENCRYPTION=null
  83 MAIL_VERIFY_SSL=true
  84
  85 MAIL_SENDMAIL_COMMAND="/usr/sbin/sendmail -bs"
  86
  87 # Cache & Session driver to use
  88 # Can be 'file', 'database', 'memcached' or 'redis'
  89 CACHE_DRIVER=file
  90 SESSION_DRIVER=file
  91
  92 # Session configuration
  93 SESSION_LIFETIME=120
  94 SESSION_COOKIE_NAME=bookstack_session
  95 SESSION_SECURE_COOKIE=false
  96
  97 # Cache key prefix
  98 # Can be used to prevent conflicts multiple BookStack instances use the same store.
  99 CACHE_PREFIX=bookstack
 100
 101 # Memcached server configuration
 102 # If using a UNIX socket path for the host, set the port to 0
 103 # This follows the following format: HOST:PORT:WEIGHT
 104 # For multiple servers separate with a comma
 105 MEMCACHED_SERVERS=127.0.0.1:11211:100
 106
 107 # Redis server configuration
 108 # This follows the following format: HOST:PORT:DATABASE
 109 # or, if using a password: HOST:PORT:DATABASE:PASSWORD
 110 # For multiple servers separate with a comma. These will be clustered.
 111 REDIS_SERVERS=127.0.0.1:6379:0
 112
 113 # Queue driver to use
 114 # Can be 'sync', 'database' or 'redis'
 115 QUEUE_CONNECTION=sync
 116
 117 # Storage system to use
 118 # Can be 'local', 'local_secure' or 's3'
 119 STORAGE_TYPE=local
 120
 121 # Image storage system to use
 122 # Defaults to the value of STORAGE_TYPE if unset.
 123 # Accepts the same values as STORAGE_TYPE.
 124 STORAGE_IMAGE_TYPE=local
 125
 126 # Attachment storage system to use
 127 # Defaults to the value of STORAGE_TYPE if unset.
 128 # Accepts the same values as STORAGE_TYPE although 'local' will be forced to 'local_secure'.
 129 STORAGE_ATTACHMENT_TYPE=local_secure
 130
 131 # Amazon S3 storage configuration
 132 STORAGE_S3_KEY=your-s3-key
 133 STORAGE_S3_SECRET=your-s3-secret
 134 STORAGE_S3_BUCKET=s3-bucket-name
 135 STORAGE_S3_REGION=s3-bucket-region
 136
 137 # S3 endpoint to use for storage calls
 138 # Only set this if using a non-Amazon s3-compatible service such as Minio
 139 STORAGE_S3_ENDPOINT=https://my-custom-s3-compatible.service.com:8001
 140
 141 # Storage URL prefix
 142 # Used as a base for any generated image urls.
 143 # An s3-format URL will be generated if not set.
 144 STORAGE_URL=false
 145
 146 # Authentication method to use
 147 # Can be 'standard', 'ldap', 'saml2' or 'oidc'
 148 AUTH_METHOD=standard
 149
 150 # Automatically initiate login via external auth system if it's the only auth method.
 151 # Works with saml2 or oidc auth methods.
 152 AUTH_AUTO_INITIATE=false
 153
 154 # Social authentication configuration
 155 # All disabled by default.
 156 # Refer to https://www.bookstackapp.com/docs/admin/third-party-auth/
 157
 158 AZURE_APP_ID=false
 159 AZURE_APP_SECRET=false
 160 AZURE_TENANT=false
 161 AZURE_AUTO_REGISTER=false
 162 AZURE_AUTO_CONFIRM_EMAIL=false
 163
 164 DISCORD_APP_ID=false
 165 DISCORD_APP_SECRET=false
 166 DISCORD_AUTO_REGISTER=false
 167 DISCORD_AUTO_CONFIRM_EMAIL=false
 168
 169 FACEBOOK_APP_ID=false
 170 FACEBOOK_APP_SECRET=false
 171 FACEBOOK_AUTO_REGISTER=false
 172 FACEBOOK_AUTO_CONFIRM_EMAIL=false
 173
 174 GITHUB_APP_ID=false
 175 GITHUB_APP_SECRET=false
 176 GITHUB_AUTO_REGISTER=false
 177 GITHUB_AUTO_CONFIRM_EMAIL=false
 178
 179 GITLAB_APP_ID=false
 180 GITLAB_APP_SECRET=false
 181 GITLAB_BASE_URI=false
 182 GITLAB_AUTO_REGISTER=false
 183 GITLAB_AUTO_CONFIRM_EMAIL=false
 184
 185 GOOGLE_APP_ID=false
 186 GOOGLE_APP_SECRET=false
 187 GOOGLE_SELECT_ACCOUNT=false
 188 GOOGLE_AUTO_REGISTER=false
 189 GOOGLE_AUTO_CONFIRM_EMAIL=false
 190
 191 OKTA_BASE_URL=false
 192 OKTA_APP_ID=false
 193 OKTA_APP_SECRET=false
 194 OKTA_AUTO_REGISTER=false
 195 OKTA_AUTO_CONFIRM_EMAIL=false
 196
 197 SLACK_APP_ID=false
 198 SLACK_APP_SECRET=false
 199 SLACK_AUTO_REGISTER=false
 200 SLACK_AUTO_CONFIRM_EMAIL=false
 201
 202 TWITCH_APP_ID=false
 203 TWITCH_APP_SECRET=false
 204 TWITCH_AUTO_REGISTER=false
 205 TWITCH_AUTO_CONFIRM_EMAIL=false
 206
 207 TWITTER_APP_ID=false
 208 TWITTER_APP_SECRET=false
 209 TWITTER_AUTO_REGISTER=false
 210 TWITTER_AUTO_CONFIRM_EMAIL=false
 211
 212 # LDAP authentication configuration
 213 # Refer to https://www.bookstackapp.com/docs/admin/ldap-auth/
 214 LDAP_SERVER=false
 215 LDAP_BASE_DN=false
 216 LDAP_DN=false
 217 LDAP_PASS=false
 218 LDAP_USER_FILTER="(&(uid={user}))"
 219 LDAP_VERSION=false
 220 LDAP_START_TLS=false
 221 LDAP_TLS_INSECURE=false
 222 LDAP_TLS_CA_CERT=false
 223 LDAP_ID_ATTRIBUTE=uid
 224 LDAP_EMAIL_ATTRIBUTE=mail
 225 LDAP_DISPLAY_NAME_ATTRIBUTE=cn
 226 LDAP_THUMBNAIL_ATTRIBUTE=null
 227 LDAP_FOLLOW_REFERRALS=true
 228 LDAP_DUMP_USER_DETAILS=false
 229
 230 # LDAP group sync configuration
 231 # Refer to https://www.bookstackapp.com/docs/admin/ldap-auth/
 232 LDAP_USER_TO_GROUPS=false
 233 LDAP_GROUP_ATTRIBUTE="memberOf"
 234 LDAP_REMOVE_FROM_GROUPS=false
 235 LDAP_DUMP_USER_GROUPS=false
 236
 237 # SAML authentication configuration
 238 # Refer to https://www.bookstackapp.com/docs/admin/saml2-auth/
 239 SAML2_NAME=SSO
 240 SAML2_EMAIL_ATTRIBUTE=email
 241 SAML2_DISPLAY_NAME_ATTRIBUTES=username
 242 SAML2_EXTERNAL_ID_ATTRIBUTE=null
 243 SAML2_IDP_ENTITYID=null
 244 SAML2_IDP_SSO=null
 245 SAML2_IDP_SLO=null
 246 SAML2_IDP_x509=null
 247 SAML2_ONELOGIN_OVERRIDES=null
 248 SAML2_DUMP_USER_DETAILS=false
 249 SAML2_AUTOLOAD_METADATA=false
 250 SAML2_IDP_AUTHNCONTEXT=true
 251 SAML2_SP_x509=null
 252 SAML2_SP_x509_KEY=null
 253
 254 # SAML group sync configuration
 255 # Refer to https://www.bookstackapp.com/docs/admin/saml2-auth/
 256 SAML2_USER_TO_GROUPS=false
 257 SAML2_GROUP_ATTRIBUTE=group
 258 SAML2_REMOVE_FROM_GROUPS=false
 259
 260 # OpenID Connect authentication configuration
 261 # Refer to https://www.bookstackapp.com/docs/admin/oidc-auth/
 262 OIDC_NAME=SSO
 263 OIDC_DISPLAY_NAME_CLAIMS=name
 264 OIDC_CLIENT_ID=null
 265 OIDC_CLIENT_SECRET=null
 266 OIDC_ISSUER=null
 267 OIDC_ISSUER_DISCOVER=false
 268 OIDC_PUBLIC_KEY=null
 269 OIDC_AUTH_ENDPOINT=null
 270 OIDC_TOKEN_ENDPOINT=null
 271 OIDC_USERINFO_ENDPOINT=null
 272 OIDC_ADDITIONAL_SCOPES=null
 273 OIDC_DUMP_USER_DETAILS=false
 274 OIDC_USER_TO_GROUPS=false
 275 OIDC_GROUPS_CLAIM=groups
 276 OIDC_REMOVE_FROM_GROUPS=false
 277 OIDC_EXTERNAL_ID_CLAIM=sub
 278 OIDC_END_SESSION_ENDPOINT=false
 279
 280 # Disable default third-party services such as Gravatar and Draw.IO
 281 # Service-specific options will override this option
 282 DISABLE_EXTERNAL_SERVICES=false
 283
 284 # Use custom avatar service, Sets fetch URL
 285 # Possible placeholders: ${hash} ${size} ${email}
 286 # If set, Avatars will be fetched regardless of DISABLE_EXTERNAL_SERVICES option.
 287 # Example: AVATAR_URL=https://seccdn.libravatar.org/avatar/${hash}?s=${size}&d=identicon
 288 AVATAR_URL=
 289
 290 # Enable diagrams.net integration
 291 # Can simply be true/false to enable/disable the integration.
 292 # Alternatively, It can be URL to the diagrams.net instance you want to use.
 293 # For URLs, The following URL parameters should be included: embed=1&proto=json&spin=1&configure=1
 294 DRAWIO=true
 295
 296 # Default item listing view
 297 # Used for public visitors and user's without a preference.
 298 # Can be 'list' or 'grid'.
 299 APP_VIEWS_BOOKS=list
 300 APP_VIEWS_BOOKSHELVES=grid
 301 APP_VIEWS_BOOKSHELF=grid
 302
 303 # Use dark mode by default
 304 # Will be overriden by any user/session preference.
 305 APP_DEFAULT_DARK_MODE=false
 306
 307 # Page revision limit
 308 # Number of page revisions to keep in the system before deleting old revisions.
 309 # If set to 'false' a limit will not be enforced.
 310 REVISION_LIMIT=100
 311
 312 # Recycle Bin Lifetime
 313 # The number of days that content will remain in the recycle bin before
 314 # being considered for auto-removal. It is not a guarantee that content will
 315 # be removed after this time.
 316 # Set to 0 for no recycle bin functionality.
 317 # Set to -1 for unlimited recycle bin lifetime.
 318 RECYCLE_BIN_LIFETIME=30
 319
 320 # File Upload Limit
 321 # Maximum file size, in megabytes, that can be uploaded to the system.
 322 FILE_UPLOAD_SIZE_LIMIT=50
 323
 324 # Export Page Size
 325 # Primarily used to determine page size of PDF exports.
 326 # Can be 'a4' or 'letter'.
 327 EXPORT_PAGE_SIZE=a4
 328
 329 # Export PDF Command
 330 # Set a command which can be used to convert a HTML file into a PDF file.
 331 # When false this will not be used.
 332 # String values represent the command to be called for conversion.
 333 # Supports '{input_html_path}' and '{output_pdf_path}' placeholder values.
 334 # Example: EXPORT_PDF_COMMAND="/scripts/convert.sh {input_html_path} {output_pdf_path}"
 335 EXPORT_PDF_COMMAND=false
 336
 337 # Export PDF Command Timeout
 338 # The number of seconds that the export PDF command will run before a timeout occurs.
 339 # Only applies for the EXPORT_PDF_COMMAND option, not for DomPDF or wkhtmltopdf.
 340 EXPORT_PDF_COMMAND_TIMEOUT=15
 341
 342 # Set path to wkhtmltopdf binary for PDF generation.
 343 # Can be 'false' or a path path like: '/home/bins/wkhtmltopdf'
 344 # When false, BookStack will attempt to find a wkhtmltopdf in the application
 345 # root folder then fall back to the default dompdf renderer if no binary exists.
 346 # Only used if 'ALLOW_UNTRUSTED_SERVER_FETCHING=true' which disables security protections.
 347 WKHTMLTOPDF=false
 348
 349 # Allow <script> tags in page content
 350 # Note, if set to 'true' the page editor may still escape scripts.
 351 ALLOW_CONTENT_SCRIPTS=false
 352
 353 # Indicate if robots/crawlers should crawl your instance.
 354 # Can be 'true', 'false' or 'null'.
 355 # The behaviour of the default 'null' option will depend on the 'app-public' admin setting.
 356 # Contents of the robots.txt file can be overridden, making this option obsolete.
 357 ALLOW_ROBOTS=null
 358
 359 # Allow server-side fetches to be performed to potentially unknown
 360 # and user-provided locations. Primarily used in exports when loading
 361 # in externally referenced assets.
 362 # Can be 'true' or 'false'.
 363 ALLOW_UNTRUSTED_SERVER_FETCHING=false
 364
 365 # A list of hosts that BookStack can be iframed within.
 366 # Space separated if multiple. BookStack host domain is auto-inferred.
 367 # For Example: ALLOWED_IFRAME_HOSTS="https://example.com https://a.example.com"
 368 # Setting this option will also auto-adjust cookies to be SameSite=None.
 369 ALLOWED_IFRAME_HOSTS=null
 370
 371 # A list of sources/hostnames that can be loaded within iframes within BookStack.
 372 # Space separated if multiple. BookStack host domain is auto-inferred.
 373 # Can be set to a lone "*" to allow all sources for iframe content (Not advised).
 374 # Defaults to a set of common services.
 375 # Current host and source for the "DRAWIO" setting will be auto-appended to the sources configured.
 376 ALLOWED_IFRAME_SOURCES="https://*.draw.io https://*.youtube.com https://*.youtube-nocookie.com https://*.vimeo.com"
 377
 378 # A list of the sources/hostnames that can be reached by application SSR calls.
 379 # This is used wherever users can provide URLs/hosts in-platform, like for webhooks.
 380 # Host-specific functionality (usually controlled via other options) like auth
 381 # or user avatars for example, won't use this list.
 382 # Space seperated if multiple. Can use '*' as a wildcard.
 383 # Values will be compared prefix-matched, case-insensitive, against called SSR urls.
 384 # Defaults to allow all hosts.
 385 ALLOWED_SSR_HOSTS="*"
 386
 387 # The default and maximum item-counts for listing API requests.
 388 API_DEFAULT_ITEM_COUNT=100
 389 API_MAX_ITEM_COUNT=500
 390
 391 # The number of API requests that can be made per minute by a single user.
 392 API_REQUESTS_PER_MIN=180
 393
 394 # Enable the logging of failed email+password logins with the given message.
 395 # The default log channel below uses the php 'error_log' function which commonly
 396 # results in messages being output to the webserver error logs.
 397 # The message can contain a %u parameter which will be replaced with the login
 398 # user identifier (Username or email).
 399 LOG_FAILED_LOGIN_MESSAGE=false
 400 LOG_FAILED_LOGIN_CHANNEL=errorlog_plain_webserver
 401
 402 # Alter the precision of IP addresses stored by BookStack.
 403 # Should be a number between 0 and 4, where 4 retains the full IP address
 404 # and 0 completely hides the IP address. As an example, a value of 2 for the
 405 # IP address '146.191.42.4' would result in '146.191.x.x' being logged.
 406 # For the IPv6 address '2001:db8:85a3:8d3:1319:8a2e:370:7348' this would result as:
 407 # '2001:db8:85a3:8d3:x:x:x:x'
 408 IP_ADDRESS_PRECISION=4