Fixed OIDC Logout

[bookstack] / .env.example.complete

diff --git a/.env.example.complete b/.env.example.complete
index 1e2160d07a4f1802e13ec6cc13a207989555af24..e89dc551591774023feea1f96d49c1dda70e3247 100644 (file)
--- a/.env.example.complete
+++ b/.env.example.complete
@@ -3,6 +3,10 @@
 # Each option is shown with it's default value.
 # Do not copy this whole file to use as your '.env' file.
 
 # Each option is shown with it's default value.
 # Do not copy this whole file to use as your '.env' file.
 

+# The details here only serve as a quick reference.
+# Please refer to the BookStack documentation for full details:
+# https://www.bookstackapp.com/docs/
+

 # Application environment
 # Can be 'production', 'development', 'testing' or 'demo'
 APP_ENV=production
 # Application environment
 # Can be 'production', 'development', 'testing' or 'demo'
 APP_ENV=production


@@ -65,20 +69,20 @@ DB_PASSWORD=database_user_password
 # certificate itself (Common Name or Subject Alternative Name).
 MYSQL_ATTR_SSL_CA="/path/to/ca.pem"
 
 # certificate itself (Common Name or Subject Alternative Name).
 MYSQL_ATTR_SSL_CA="/path/to/ca.pem"
 

-# Mail system to use
-# Can be 'smtp' or 'sendmail'
+# Mail configuration
+# Refer to https://www.bookstackapp.com/docs/admin/email-webhooks/#email-configuration

 MAIL_DRIVER=smtp
 MAIL_DRIVER=smtp

-
-# Mail sending options

 [email protected]
 MAIL_FROM_NAME=BookStack
 
 [email protected]
 MAIL_FROM_NAME=BookStack
 

-# SMTP mail options

 MAIL_HOST=localhost
 MAIL_HOST=localhost

-MAIL_PORT=1025
+MAIL_PORT=587

 MAIL_USERNAME=null
 MAIL_PASSWORD=null
 MAIL_ENCRYPTION=null
 MAIL_USERNAME=null
 MAIL_PASSWORD=null
 MAIL_ENCRYPTION=null

+MAIL_VERIFY_SSL=true
+
+MAIL_SENDMAIL_COMMAND="/usr/sbin/sendmail -bs"

 
 # Cache & Session driver to use
 # Can be 'file', 'database', 'memcached' or 'redis'
 
 # Cache & Session driver to use
 # Can be 'file', 'database', 'memcached' or 'redis'


@@ -263,7 +267,16 @@ OIDC_ISSUER_DISCOVER=false
 OIDC_PUBLIC_KEY=null
 OIDC_AUTH_ENDPOINT=null
 OIDC_TOKEN_ENDPOINT=null
 OIDC_PUBLIC_KEY=null
 OIDC_AUTH_ENDPOINT=null
 OIDC_TOKEN_ENDPOINT=null

+OIDC_ADDITIONAL_SCOPES=null

 OIDC_DUMP_USER_DETAILS=false
 OIDC_DUMP_USER_DETAILS=false

+OIDC_USER_TO_GROUPS=false
+OIDC_GROUPS_CLAIM=groups
+OIDC_REMOVE_FROM_GROUPS=false
+OIDC_EXTERNAL_ID_CLAIM=sub
+
+# OIDC Logout Feature: Its value should be value of end_session_endpoint from <issuer>/.well-known/openid-configuration 
+OIDC_END_SESSION_ENDPOINT=null
+

 
 # Disable default third-party services such as Gravatar and Draw.IO
 # Service-specific options will override this option
 
 # Disable default third-party services such as Gravatar and Draw.IO
 # Service-specific options will override this option


@@ -295,7 +308,7 @@ APP_DEFAULT_DARK_MODE=false
 # Page revision limit
 # Number of page revisions to keep in the system before deleting old revisions.
 # If set to 'false' a limit will not be enforced.
 # Page revision limit
 # Number of page revisions to keep in the system before deleting old revisions.
 # If set to 'false' a limit will not be enforced.

-REVISION_LIMIT=50
+REVISION_LIMIT=100

 
 # Recycle Bin Lifetime
 # The number of days that content will remain in the recycle bin before
 
 # Recycle Bin Lifetime
 # The number of days that content will remain in the recycle bin before


@@ -314,6 +327,13 @@ FILE_UPLOAD_SIZE_LIMIT=50
 # Can be 'a4' or 'letter'.
 EXPORT_PAGE_SIZE=a4
 
 # Can be 'a4' or 'letter'.
 EXPORT_PAGE_SIZE=a4
 

+# Set path to wkhtmltopdf binary for PDF generation.
+# Can be 'false' or a path path like: '/home/bins/wkhtmltopdf'
+# When false, BookStack will attempt to find a wkhtmltopdf in the application
+# root folder then fall back to the default dompdf renderer if no binary exists.
+# Only used if 'ALLOW_UNTRUSTED_SERVER_FETCHING=true' which disables security protections.
+WKHTMLTOPDF=false
+

 # Allow <script> tags in page content
 # Note, if set to 'true' the page editor may still escape scripts.
 ALLOW_CONTENT_SCRIPTS=false
 # Allow <script> tags in page content
 # Note, if set to 'true' the page editor may still escape scripts.
 ALLOW_CONTENT_SCRIPTS=false


@@ -360,8 +380,8 @@ LOG_FAILED_LOGIN_CHANNEL=errorlog_plain_webserver
 
 # Alter the precision of IP addresses stored by BookStack.
 # Should be a number between 0 and 4, where 4 retains the full IP address
 
 # Alter the precision of IP addresses stored by BookStack.
 # Should be a number between 0 and 4, where 4 retains the full IP address

-# and 0 completely hides the IP address. As an examples, a value of 2 for the
+# and 0 completely hides the IP address. As an example, a value of 2 for the

 # IP address '146.191.42.4' would result in '146.191.x.x' being logged.
 # IP address '146.191.42.4' would result in '146.191.x.x' being logged.

-# For the IP address '2001:db8:85a3:8d3:1319:8a2e:370:7348' this would result as:
+# For the IPv6 address '2001:db8:85a3:8d3:1319:8a2e:370:7348' this would result as:

 # '2001:db8:85a3:8d3:x:x:x:x'
 # '2001:db8:85a3:8d3:x:x:x:x'

-IP_ADDRESS_PRECISION=4
\ No newline at end of file
+IP_ADDRESS_PRECISION=4