X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/867cbe15eab76215e1e84ae285b5c443ab16959f..refs/pull/3918/head:/.env.example.complete diff --git a/.env.example.complete b/.env.example.complete index c0fed8c4e..03e52d6bb 100644 --- a/.env.example.complete +++ b/.env.example.complete @@ -42,7 +42,7 @@ APP_TIMEZONE=UTC # overrides can be made. Defaults to disabled. APP_THEME=false -# Trusted Proxies +# Trusted proxies # Used to indicate trust of systems that proxy to the application so # certain header values (Such as "X-Forwarded-For") can be used from the # incoming proxy request to provide origin detail. @@ -58,6 +58,13 @@ DB_DATABASE=database_database DB_USERNAME=database_username DB_PASSWORD=database_user_password +# MySQL specific connection options +# Path to Certificate Authority (CA) certificate file for your MySQL instance. +# When this option is used host name identity verification will be performed +# which checks the hostname, used by the client, against names within the +# 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_DRIVER=smtp @@ -100,8 +107,7 @@ MEMCACHED_SERVERS=127.0.0.1:11211:100 REDIS_SERVERS=127.0.0.1:6379:0 # Queue driver to use -# Queue not really currently used but may be configurable in the future. -# Would advise not to change this for now. +# Can be 'sync', 'database' or 'redis' QUEUE_CONNECTION=sync # Storage system to use @@ -137,6 +143,10 @@ STORAGE_URL=false # Can be 'standard', 'ldap', 'saml2' or 'oidc' AUTH_METHOD=standard +# Automatically initiate login via external auth system if it's the only auth method. +# Works with saml2 or oidc auth methods. +AUTH_AUTO_INITIATE=false + # Social authentication configuration # All disabled by default. # Refer to https://www.bookstackapp.com/docs/admin/third-party-auth/ @@ -217,6 +227,7 @@ LDAP_DUMP_USER_DETAILS=false LDAP_USER_TO_GROUPS=false LDAP_GROUP_ATTRIBUTE="memberOf" LDAP_REMOVE_FROM_GROUPS=false +LDAP_DUMP_USER_GROUPS=false # SAML authentication configuration # Refer to https://www.bookstackapp.com/docs/admin/saml2-auth/ @@ -252,7 +263,11 @@ OIDC_ISSUER_DISCOVER=false OIDC_PUBLIC_KEY=null OIDC_AUTH_ENDPOINT=null OIDC_TOKEN_ENDPOINT=null +OIDC_ADDITIONAL_SCOPES=null OIDC_DUMP_USER_DETAILS=false +OIDC_USER_TO_GROUPS=false +OIDC_GROUPS_CLAIM=groups +OIDC_REMOVE_FROM_GROUPS=false # Disable default third-party services such as Gravatar and Draw.IO # Service-specific options will override this option @@ -267,7 +282,7 @@ AVATAR_URL= # Enable diagrams.net integration # Can simply be true/false to enable/disable the integration. # Alternatively, It can be URL to the diagrams.net instance you want to use. -# For URLs, The following URL parameters should be included: embed=1&proto=json&spin=1 +# For URLs, The following URL parameters should be included: embed=1&proto=json&spin=1&configure=1 DRAWIO=true # Default item listing view @@ -284,7 +299,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. -REVISION_LIMIT=50 +REVISION_LIMIT=100 # Recycle Bin Lifetime # The number of days that content will remain in the recycle bin before @@ -298,6 +313,11 @@ RECYCLE_BIN_LIFETIME=30 # Maximum file size, in megabytes, that can be uploaded to the system. FILE_UPLOAD_SIZE_LIMIT=50 +# Export Page Size +# Primarily used to determine page size of PDF exports. +# Can be 'a4' or 'letter'. +EXPORT_PAGE_SIZE=a4 + # Allow