diff --git a/conf/.env.example.complete b/conf/.env.example.complete index e3dbdb8..fb94740 100644 --- a/conf/.env.example.complete +++ b/conf/.env.example.complete @@ -42,6 +42,14 @@ APP_TIMEZONE=UTC # overrides can be made. Defaults to disabled. APP_THEME=false +# 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. +# Set to an IP address, or multiple comma seperated IP addresses. +# Can alternatively be set to "*" to trust all proxy addresses. +APP_PROXIES=null + # Database details # Host can contain a port (localhost:3306) or a separate DB_PORT option can be used. DB_HOST=localhost @@ -50,8 +58,15 @@ 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', 'mail' or 'sendmail' +# Can be 'smtp' or 'sendmail' MAIL_DRIVER=smtp # Mail sending options @@ -92,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 @@ -126,7 +140,7 @@ STORAGE_S3_ENDPOINT=https://my-custom-s3-compatible.service.com:8001 STORAGE_URL=false # Authentication method to use -# Can be 'standard', 'ldap' or 'saml2' +# Can be 'standard', 'ldap', 'saml2' or 'oidc' AUTH_METHOD=standard # Social authentication configuration @@ -195,10 +209,12 @@ LDAP_DN=false LDAP_PASS=false LDAP_USER_FILTER=false LDAP_VERSION=false +LDAP_START_TLS=false LDAP_TLS_INSECURE=false LDAP_ID_ATTRIBUTE=uid LDAP_EMAIL_ATTRIBUTE=mail LDAP_DISPLAY_NAME_ATTRIBUTE=cn +LDAP_THUMBNAIL_ATTRIBUTE=null LDAP_FOLLOW_REFERRALS=true LDAP_DUMP_USER_DETAILS=false @@ -221,6 +237,9 @@ SAML2_IDP_x509=null SAML2_ONELOGIN_OVERRIDES=null SAML2_DUMP_USER_DETAILS=false SAML2_AUTOLOAD_METADATA=false +SAML2_IDP_AUTHNCONTEXT=true +SAML2_SP_x509=null +SAML2_SP_x509_KEY=null # SAML group sync configuration # Refer to https://www.bookstackapp.com/docs/admin/saml2-auth/ @@ -228,6 +247,19 @@ SAML2_USER_TO_GROUPS=false SAML2_GROUP_ATTRIBUTE=group SAML2_REMOVE_FROM_GROUPS=false +# OpenID Connect authentication configuration +# Refer to https://www.bookstackapp.com/docs/admin/oidc-auth/ +OIDC_NAME=SSO +OIDC_DISPLAY_NAME_CLAIMS=name +OIDC_CLIENT_ID=null +OIDC_CLIENT_SECRET=null +OIDC_ISSUER=null +OIDC_ISSUER_DISCOVER=false +OIDC_PUBLIC_KEY=null +OIDC_AUTH_ENDPOINT=null +OIDC_TOKEN_ENDPOINT=null +OIDC_DUMP_USER_DETAILS=false + # Disable default third-party services such as Gravatar and Draw.IO # Service-specific options will override this option DISABLE_EXTERNAL_SERVICES=false @@ -245,10 +277,15 @@ AVATAR_URL= DRAWIO=true # Default item listing view -# Used for public visitors and user's without a preference -# Can be 'list' or 'grid' +# Used for public visitors and user's without a preference. +# Can be 'list' or 'grid'. APP_VIEWS_BOOKS=list APP_VIEWS_BOOKSHELVES=grid +APP_VIEWS_BOOKSHELF=grid + +# Use dark mode by default +# Will be overriden by any user/session preference. +APP_DEFAULT_DARK_MODE=false # Page revision limit # Number of page revisions to keep in the system before deleting old revisions. @@ -263,6 +300,15 @@ REVISION_LIMIT=50 # Set to -1 for unlimited recycle bin lifetime. RECYCLE_BIN_LIFETIME=30 +# File Upload Limit +# 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