From caa4159f23db3b0675c027d186f64aba84a512b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Tue, 22 Mar 2022 09:35:39 +0100 Subject: [PATCH] Testing (#62) --- README.md | 5 +-- README_fr.md | 5 +-- check_process | 5 +-- conf/.env.example | 4 +++ conf/.env.example.complete | 71 ++++++++++++++++++++++++++++++++++---- doc/DISCLAIMER.md | 3 +- doc/DISCLAIMER_fr.md | 3 +- manifest.json | 24 ++++++++++--- scripts/install | 3 +- scripts/restore | 1 + scripts/upgrade | 1 + 11 files changed, 103 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 126d7fb..fc9f8f1 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ BookStack is an opinionated wiki system that provides a pleasant and simple out - Multi-Lingual -**Shipped version:** 22.02.3~ynh1 +**Shipped version:** 22.02.3~ynh2 **Demo:** https://demo.bookstackapp.com @@ -40,7 +40,8 @@ BookStack is an opinionated wiki system that provides a pleasant and simple out BookStack uses LDAP authentication by default. -You can switch to standard authentication in the webadmin -> bookstack -> config panel setting +You can switch to standard authentication in the webadmin -> bookstack -> config panel setting. + For the first time Login with standard authentication, use the default credentials `admin@admin.com` and `password`. You should change these details immediately after logging in for the first time. ## Documentation and resources diff --git a/README_fr.md b/README_fr.md index 0e95f70..e1ae464 100644 --- a/README_fr.md +++ b/README_fr.md @@ -22,7 +22,7 @@ BookStack is an opinionated wiki system that provides a pleasant and simple out - Multi-Lingual -**Version incluse :** 22.02.3~ynh1 +**Version incluse :** 22.02.3~ynh2 **Démo :** https://demo.bookstackapp.com @@ -36,7 +36,8 @@ BookStack is an opinionated wiki system that provides a pleasant and simple out BookStack utilise l'authentification LDAP par défaut. -Vous pouvez passer à l'authentification standard dans le webadmin -> Bookstack -> paramètre du panneau de configuration +Vous pouvez passer à l'authentification standard dans le webadmin -> Bookstack -> paramètre du panneau de configuration. + Pour la première connexion avec une authentification standard, utilisez les informations d'identification par défaut `admin@admin.com` et `password`. Vous devez modifier ces informations immédiatement après vous être connecté pour la première fois. ## Documentations et ressources diff --git a/check_process b/check_process index e0ee37e..3f212e2 100644 --- a/check_process +++ b/check_process @@ -14,17 +14,14 @@ setup_private=1 setup_public=1 upgrade=1 - upgrade=1 from_commit=aaa9c9534b01a210989aceb4ad4d2b9c585be6df upgrade=1 from_commit=12ee6097f4f48e6fb765afbe25dd10345e9c8adb backup_restore=1 - multi_instance=0 + multi_instance=1 change_url=1 ;;; Options Email= Notification=none ;;; Upgrade options - ; commit=aaa9c9534b01a210989aceb4ad4d2b9c585be6df - name=Testing (#35) ; commit=12ee6097f4f48e6fb765afbe25dd10345e9c8adb name=Testing (#38) manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666& diff --git a/conf/.env.example b/conf/.env.example index f27d735..abb20bf 100644 --- a/conf/.env.example +++ b/conf/.env.example @@ -81,6 +81,10 @@ SESSION_DRIVER=redis # Example of using a single local Redis server REDIS_SERVERS=127.0.0.1:6379:__REDIS_DB__ +# Queue driver to use +# Can be 'sync', 'database' or 'redis' +QUEUE_CONNECTION=redis + # Storage system to use # Can be 'local', 'local_secure' or 's3' STORAGE_TYPE=local 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