bookstack/website
Fork 4
Code Issues 5 Pull requests Activity

Added content and updates for v0.25.2 release

Browse source
This commit is contained in:
Dan Brown 2019-03-10 13:46:56 +00:00
commit fb4cfde8a5
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
7 changed files with 99 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

60
content/blog/beta-release-v0-25-2.md Normal file
View file

@ -0,0 +1,60 @@
+++
categories = ["Releases"]
tags = ["Releases"]
title = "Project Roadmap & Beta Release v0.25.2"
date = 2019-03-10T13:45:00Z
author = "Dan Brown"
image = "/images/blog-cover-images/mountains-eberhard-grossgasteiger.jpg"
description = "We have another patch release for BookStack v0.25 to fix bugs, update translations & to add some new configuration options."
slug = "beta-release-v0-25-2"
draft = false
+++
We have another patch release for BookStack v0.25 to fix bugs, update translations & to add some new configuration options. We now also have a project roadmap to provide some visibility of where the BookStack is going.
* [Update instructions](https://www.bookstackapp.com/docs/admin/updates)
* [GitHub release page](https://github.com/BookStackApp/BookStack/releases/tag/v0.25.2)
### Project Roadmap
Visibility of BookStack's direction was becoming increasingly requested as more people get involved with the project. To provide some insight into the development plan, a new section has been added to the project readme to outline a high-level roadmap for BookStack:
**[BookStack Roadmap](https://github.com/BookStackApp/BookStack#road-map)**
Additionally, the release process has been detailed to provide insight into how BookStack releases are organised and how releases are versioned:
**[BookStack Release Process](https://github.com/BookStackApp/BookStack#release-versioning--process)**
### Code Block Updates
Code blocks in BookStack have been updated to provide syntax highlighting for two new popular languages: Lua & PowerShell.
![CodeBlock LUA PoweShell](/images/2019/03/codeblock_lua_powershell.png)
### Language Updates
* German translations now include translations for shelves. Thanks to [@Xiphoseer](https://github.com/BookStackApp/BookStack/pull/1272). ([#1272](https://github.com/BookStackApp/BookStack/pull/1272)).
* Dutch translations will now show the current password hint information. Thanks to [@maantje](https://github.com/BookStackApp/BookStack/pull/1314). ([#1314](https://github.com/BookStackApp/BookStack/pull/1314))
### Full List of Changes
* Added LDAP option to set a custom "Display Name" property. Thanks to [@dfanara](https://github.com/BookStackApp/BookStack/pull/1317). ([#1317](https://github.com/BookStackApp/BookStack/pull/1317), [#1306](https://github.com/BookStackApp/BookStack/issues/1306))
* Fixed issue where default system language would not be reflected when viewing another user's profile. ([#1316](https://github.com/BookStackApp/BookStack/issues/1316))
* Updated Dutch translations for the password hint. Thanks to [@maantje](https://github.com/BookStackApp/BookStack/pull/1314). ([#1314](https://github.com/BookStackApp/BookStack/pull/1314))
* Updated front-end file upload size limit to be configurable. ([#1293](https://github.com/BookStackApp/BookStack/issues/1293))
* Updated image paste/drop uploads to properly set page relations so image permissions are active. ([#1287](https://github.com/BookStackApp/BookStack/issues/1287))
* Fixed bug where using alignment properties could break tables. ([#1284](https://github.com/BookStackApp/BookStack/issues/1284))
* Added possibility to set a password for Redis connections. ([#1283](https://github.com/BookStackApp/BookStack/issues/1283))
* Updated German translations to include translations for shelves. Thanks to [@Xiphoseer](https://github.com/BookStackApp/BookStack/pull/1272). ([#1272](https://github.com/BookStackApp/BookStack/pull/1272))
* Added PowerShell code highlighting to code blocks. Thanks to [@christophert](https://github.com/BookStackApp/BookStack/pull/1263). ([#1263](https://github.com/BookStackApp/BookStack/pull/1263), [#1040](https://github.com/BookStackApp/BookStack/issues/1040))
* Fixed issue where image-manager tooltips could be cut-off. Thanks to [@Abijeet](https://github.com/BookStackApp/BookStack/pull/1238). ([#1238](https://github.com/BookStackApp/BookStack/pull/1238), [#1186](https://github.com/BookStackApp/BookStack/issues/1186))
* Added LUA code highlighting to code blocks. ([#1223](https://github.com/BookStackApp/BookStack/issues/1223))
* Updated permissions checked for "Page Copy" function to be more accurate to what permissions are actually required. Thanks to [@mark-james](https://github.com/BookStackApp/BookStack/pull/1202). ([#1202](https://github.com/BookStackApp/BookStack/pull/1202), [#1199](https://github.com/BookStackApp/BookStack/issues/1199))
* Updated permissions checked for the "Shelves" header item to be visible. Now takes into account custom shelve-level permissions. ([#1201](https://github.com/BookStackApp/BookStack/issues/1201))
----
<span style="font-size: 0.8em;opacity:0.8;">Header Image Credits: &nbsp; <a style="background-color:black;color:white;text-decoration:none;padding:4px 6px;font-family:-apple-system, BlinkMacSystemFont, &quot;San Francisco&quot;, &quot;Helvetica Neue&quot;, Helvetica, Ubuntu, Roboto, Noto, &quot;Segoe UI&quot;, Arial, sans-serif;font-size:12px;font-weight:bold;line-height:1.2;display:inline-block;border-radius:3px" href="https://unsplash.com/@eberhardgross?utm_medium=referral&amp;utm_campaign=photographer-credit&amp;utm_content=creditBadge" target="_blank" rel="noopener noreferrer" title="Download free do whatever you want high-resolution photos from eberhard grossgasteiger"><span style="display:inline-block;padding:2px 3px"><svg xmlns="http://www.w3.org/2000/svg" style="height:12px;width:auto;position:relative;vertical-align:middle;top:-2px;fill:white" viewBox="0 0 32 32"><title>unsplash-logo</title><path d="M10 9V0h12v9H10zm12 5h10v18H0V14h10v9h12v-9z"></path></svg></span><span style="display:inline-block;padding:2px 3px">eberhard grossgasteiger</span></a></span>

17
content/docs/admin/cache-session-config.md
View file

@ -7,7 +7,7 @@ type = "admin-doc"
### Cookie Configuration
Browser cookies are used to track sessions when using BookStack. The following session cookie options can be set in your `.env` file:
Browser cookies are used to track sessions when using BookStack. The following session cookie options can be set in your .env file:
```bash
# Only send cookies over a HTTPS connection.
@ -26,7 +26,7 @@ By default BookStack will use a file system cache that's storage in the `storage
#### Database
As an easy alternative to using the filesystem, you can use the database to store the cache and session. The database setup for this is done when installing/updating BookStack so you simply need to set the following in your `.env` file:
As an easy alternative to using the filesystem, you can use the database to store the cache and session. The database setup for this is done when installing/updating BookStack so you simply need to set the following in your .env file:
```bash
CACHE_DRIVER=database
@ -35,7 +35,9 @@ SESSION_DRIVER=database
#### Memcached
To use memcached for caching and/or sessions open up your `.env` file and find the `CACHE_DRIVER` & `SESSION_DRIVER` variables. By default these are both set to `file`. Change these variables to `memcached`. You will also need to add a variable to specify the memcached servers you are using. To do this add a variable named `MEMCACHED_SERVERS` to the `.env` file and set the value to be your memcached servers in the following format: `HOST:PORT:WEIGHT,HOST2:PORT:WEIGHT`. You can specify as many servers as you want. Their usage split will be determined by the weight given to them. Here are some examples of what the `.env` file should look like:
To use memcached for caching and/or sessions open up your .env file and find the `CACHE_DRIVER` & `SESSION_DRIVER` variables. By default these are both set to `file`. Change these variables to `memcached`.
You will also need to add a variable to specify the memcached servers you are using. To do this add a variable named `MEMCACHED_SERVERS` to the .env file and set the value to be your memcached servers in the following format: `HOST:PORT:WEIGHT,HOST2:PORT:WEIGHT`. You can specify as many servers as you want. Their usage split will be determined by the weight given to them. Here are some examples of what the .env file should look like:
```bash
# Set both the cache and session to use memcached
@ -51,11 +53,13 @@ MEMCACHED_SERVERS=8.8.8.8:11211:50,8.8.4.4:11211:50
#### Redis
To use Redis for caching and/or sessions open up your `.env` file and find the `CACHE_DRIVER` & `SESSION_DRIVER` variables. By default these are both set to `file`. Change these variables to `redis`. You will need to add a variable to specify your Redis servers. To do this add a variable named `REDIS_SERVERS` to the `.env` file and set the value to point at your Redis servers in the following format: `HOST:PORT:DATABASE,HOST2:PORT:DATABASE`. The default values for each host are `127.0.0.1:6379:0`. You can list as many servers as you like.
To use Redis for caching and/or sessions open up your .env file and find the `CACHE_DRIVER` & `SESSION_DRIVER` variables. By default these are both set to `file`. Change these variables to `redis`.
To specify if you would like to cluster you Redis servers create a `REDIS_CLUSTER` key in the `.env` file and set it to `true`. This option, if set to true, will instruct the built-in Redis client to perform client-side sharding across your Redis nodes, allowing them to pool together for a large amount of RAM. This disadvantage of this it that it does not allow for fail-over.
You will need to add a variable to specify your Redis servers. To do this add a variable named `REDIS_SERVERS` to the .env file and set the value to point at your Redis servers in the following format: `HOST:PORT:DATABASE,HOST2:PORT:DATABASE`. The default values for each host are `127.0.0.1:6379:0`. You can list as many servers as you like. If your redis servers are password protected you can use the format `HOST:PORT:DATABASE:PASSWORD`.
Here's an example of setting the Redis configuration:
If more that one server is provided they will automatically be clustered by BookStack to perform client-side sharding across your Redis nodes, allowing them to pool together for a large amount of RAM. This disadvantage of this it that it does not allow for fail-over.
Here's a configuration example of using Redis with BookStack:
```bash
# Set both the cache and session to use Redis
@ -67,5 +71,4 @@ REDIS_SERVERS=127.0.0.1:6379:0
# Example of using two non-local Redis servers clustered together
REDIS_SERVERS=8.8.8.8:6379:0,8.8.4.4:6379:0
REDIS_CLUSTER=true
```

3
content/docs/admin/ldap-auth.md
View file

@ -40,6 +40,9 @@ LDAP_VERSION=false
# Set the default 'email' attribute. Defaults to 'mail'
LDAP_EMAIL_ATTRIBUTE=mail
# Set the property to use for a user's display name. Defaults to 'cn'
LDAP_DISPLAY_NAME_ATTRIBUTE=cn
# If you need to allow untrusted LDAPS certificates, add the below and uncomment (remove the #)
# Only set this option if debugging or you're absolutely sure it's required for your setup.
#LDAP_TLS_INSECURE=true

5
content/docs/admin/updates.md
View file

@ -27,9 +27,14 @@ php artisan view:clear
Check the below list for the version you are updating to for any additional instructions.
---
## Version Specific Instructions
#### Updating to v0.25.2 or higher
**Configuration Change** - The .env option `REDIS_CLUSTER` has now been removed. If more than one redis server is provided they will automatically be clustered by BookStack.
#### Updating to v0.25 or higher
**Security** - During the release cycle for Version v0.25 it was found that page content includes could leak their content as preview text to users that don’t have permission to view the included content. It’s recommended to re-save any pages that included other page content that’s restricted to ensure included text is not shown in page preview text.

15
content/docs/admin/upload-config.md
View file

@ -10,6 +10,7 @@ BookStack allows users to upload both images for content and files as attachment
* [Storage Options](#storage-options)
* [Changing Upload Limits](#changing-upload-limits)
* [File Upload Timeout](#file-upload-timeout)
* [File Upload Limit](#file-upload-limit)
**For information relating to security for file uploads please refer to the [Security Page](/docs/admin/security).**
@ -159,3 +160,17 @@ To modify this timeout, in BookStack settings, Find the 'Custom HTML head conten
window.uploadTimeout = 120 * 1000;
</script>
```
---
### File Upload Limit
File uploads in BookStack use a JavaScript library which has a default upload size limit of 256MB. To modify this timeout, in BookStack settings, Find the 'Custom HTML head content' setting and add the below code. Note that this does not change any server-side upload limits, Your websever may still impose an upload limit.
```html
<script>
// Set the file upload limit to 1.5GB.
// The value is defined in MB.
window.uploadLimit = 1500;
</script>
```

BIN
static/images/2019/03/codeblock_lua_powershell.png (Stored with Git LFS) Normal file
View file

Binary file not shown.

BIN
static/images/blog-cover-images/mountains-eberhard-grossgasteiger.jpg (Stored with Git LFS) Normal file
View file

Binary file not shown.