bookstack/website
Fork 4
Code Issues 5 Pull requests Activity

Implemented doc/advisory changes for v23.02

Browse source 
Have not yet double-checked this content
This commit is contained in:
Dan Brown 2023-02-24 19:15:12 +00:00
commit 32cb4e352f
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
4 changed files with 45 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

6
content/blog/bookstack-release-v23-02.md
View file

@ -9,6 +9,9 @@ slug = "bookstack-release-v23-02"
draft = false
+++
BookStack v23.02 is here, acting primarily as a maintenance release to
upgrade the underlying framework while optimizing things and making
a few other additions.
* [Update instructions](https://www.bookstackapp.com/docs/admin/updates)
* [GitHub release page](https://github.com/BookStackApp/BookStack/releases/tag/v23.02)
@ -18,7 +21,8 @@ TODO - Required docs updates
**Upgrade Notices**
- **Thing** - info
- **PHP Version Requirement Change** - The minimum supported PHP version has changed from PHP 7.4 to PHP 8.0.2 in this release. Please see the [version-specific update instructions](/docs/admin/updates/#updating-to-v2302-or-higher) for this release for guidance on updating PHP.
- **Logical Theme System Event Change** - The `commonmark_environment_configure` event argument and return type has changed. Please [see the event definition](https://github.com/BookStackApp/BookStack/blob/b88b1bef2c0cf74627c5122b656dfabc2d5f23ee/app/Theming/ThemeEvents.php#L63-L71) to understand the new types.
<!-- {{<yt W7I2Hlcj1QA>}} -->

5
content/docs/admin/email-webhooks.md
View file

@ -45,7 +45,7 @@ MAIL_FROM_NAME=BookStack
#### Sendmail
The `sendmail` drivers uses the sendmail application on the host system. It will call `/usr/sbin/sendmail -bs`.
The `sendmail` drivers uses the sendmail application on the host system. By default it will call `/usr/sbin/sendmail -bs` although this is configurable.
To enable this option you can set the following in your `.env` file:
@ -57,6 +57,9 @@ MAIL_FROM=noreply@yourdomain.tld
# The "from" name used for outgoing email
MAIL_FROM_NAME=BookStack
# The command to use for calling sendmail
MAIL_SENDMAIL_COMMAND="/usr/sbin/sendmail -bs"
```
#### Debugging Email

6
content/docs/admin/installation.md
View file

@ -99,7 +99,7 @@ Community docker setups are available for those that would prefer to use a conta
## Ubuntu 22.04 Installation Script
A script to install BookStack on a fresh instance of Ubuntu 22.04 is available. This script is ONLY FOR A FRESH OS, it will install Apache, MySQL 8.0 & PHP-8.1 and could OVERWRITE any existing web setup on the machine. It also does not set up mail settings or configure system security so you will have to do those separately. You can use the script as a reference if you're installing on a non-fresh machine.
A script to install BookStack on a fresh instance of Ubuntu 22.04 is available. This script is ONLY FOR A FRESH OS, it will install Apache, MySQL 8.0 & PHP 8.1 and could OVERWRITE any existing web setup on the machine. It also does not set up mail settings or configure system security so you will have to do those separately. You can use the script as a reference if you're installing on a non-fresh machine.
- [Link to installation script](https://github.com/BookStackApp/devops/blob/main/scripts/installation-ubuntu-22.04.sh)
- [Video guide](https://www.youtube.com/watch?v=wq78komr9rs)
@ -128,7 +128,7 @@ Permissions for the BookStack installation files & folders will be set based upo
## Ubuntu 20.04 Installation Script
A script to install BookStack on a fresh instance of Ubuntu 20.04 is available. This script is ONLY FOR A FRESH OS, it will install Apache, MySQL 8.0 & PHP-7.4 and could OVERWRITE any existing web setup on the machine. It also does not set up mail settings or configure system security so you will have to do those separately. You can use the script as a reference if you're installing on a non-fresh machine.
A script to install BookStack on a fresh instance of Ubuntu 20.04 is available. This script is ONLY FOR A FRESH OS, it will install Apache, MySQL 8.0 & PHP 8.2 and could OVERWRITE any existing web setup on the machine. It also does not set up mail settings or configure system security so you will have to do those separately. You can use the script as a reference if you're installing on a non-fresh machine.
- [Link to installation script](https://github.com/BookStackApp/devops/blob/main/scripts/installation-ubuntu-20.04.sh)
- [Video guide](https://www.youtube.com/watch?v=ShqUjt33uOs)
@ -155,7 +155,7 @@ sudo ./installation-ubuntu-20.04.sh
## Ubuntu 18.04 Installation Script
A script to install BookStack on a fresh instance of Ubuntu 18.04 is available. This script is ONLY FOR A FRESH OS, it will install Apache, MySQL 5.7 & PHP-7.4 and could OVERWRITE any existing web setup on the machine. It also does not set up mail settings or configure system security so you will have to do those separately. You can use the script as a reference if you're installing on a non-fresh machine.
A script to install BookStack on a fresh instance of Ubuntu 18.04 is available. This script is ONLY FOR A FRESH OS, it will install Apache, MySQL 5.7 & PHP 8.2 and could OVERWRITE any existing web setup on the machine. It also does not set up mail settings or configure system security so you will have to do those separately. You can use the script as a reference if you're installing on a non-fresh machine.
[Link to installation script](https://github.com/BookStackApp/devops/blob/main/scripts/installation-ubuntu-18.04.sh)

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

@ -39,6 +39,29 @@ This is primarily a list of breaking changes & security notices.
Details of updates can be found on [our blog](https://www.bookstackapp.com/blog/) or via
the [GitHub releases page](https://github.com/BookStackApp/BookStack/releases).
#### Updating to v23.02 or higher
**PHP Version Requirement Change** - The minimum required version of PHP has changed from 7.4 to 8.0.2. This should not be a concern for those that are using common containers. Installations via our Ubuntu 22.04 install script are already using PHP 8.1 and therefore they don't need to be upgraded at this time.
For installs that have used our Ubuntu 18.04 and Ubuntu 20.04 install scripts, PHP can generally be upgraded to 8.2 using the below commands:
*Warning: If you run other applications on this machine, PHP applications in particular, then those may be affected by these changes also.*
```bash
sudo apt update
sudo apt install software-properties-common
sudo add-apt-repository ppa:ondrej/php
sudo apt update
sudo apt install -y php8.2 php8.2-curl php8.2-mbstring php8.2-ldap php8.2-xml php8.2-zip php8.2-gd php8.2-mysql libapache2-mod-php8.2
sudo a2dismod php7.2 php7.4 php7.3 php8.0 php8.1
sudo a2enmod php8.2
sudo systemctl restart apache2
```
You may also need to [update composer](#updating-composer) to be compatible with php8.2.
**Logical Theme System Event Change** - The `commonmark_environment_configure` event argument and return type has changed. Please [see the event definition](https://github.com/BookStackApp/BookStack/blob/b88b1bef2c0cf74627c5122b656dfabc2d5f23ee/app/Theming/ThemeEvents.php#L63-L71) to understand the new types.
#### Updating to v23.01.1 or higher
**Security** - v23.01.1 patches a vulnerability in PDF generation that could be used to make server-side requests or run potential other PHP code.
@ -94,10 +117,7 @@ the [GitHub releases page](https://github.com/BookStackApp/BookStack/releases).
#### Updating to v21.12.3 or higher
**Composer Version Requirement Change** - Composer v2.0 or greater is now required to install or update BookStack.
You can check your composer version by running `composer -V`.
You can often update composer by running `sudo composer self-update` (Or you may be prompted to run `sudo composer self-update --2`).
If you're using a system-supplied composer package you may need to first uninstall that (eg. `sudo apt remove composer`) then follow the [composer download documentation](https://getcomposer.org/download/) to get the latest version. Take notice of the `sudo mv composer.phar /usr/local/bin/composer` command shown in the documentation to install composer globally for easier usage.
**Composer Version Requirement Change** - Composer v2.0 or greater is now required to install or update BookStack. See the ["Updating Composer"](#updating-composer) section of this page below.
#### Updating to v21.12.1 or higher
@ -304,3 +324,12 @@ The v0.13 release contained some new features and updates which change the requi
- On Ubuntu 16.04 this can be installed via `sudo apt install php7.0-tidy`.
- On Ubuntu 14.04 (Using the default PHP option) this can be installed via `sudo apt-get install php5-tidy`.
* Page attachments will be stored in the `storage/uploads` folder (Unless you use Amazon S3). This folder will be created on update. Ensure your webserver has write permissions for this folder.
---
### Updating Composer
You can check your current composer version by running `composer -V`.
You can often update composer by running `sudo composer self-update` (Or you may be prompted to run `sudo composer self-update --2`).
If you're using a system-supplied composer package you may need to first uninstall that (eg. `sudo apt remove composer`) then follow the [composer download documentation](https://getcomposer.org/download/) to get the latest version. Take notice of the `sudo mv composer.phar /usr/local/bin/composer` command shown in the documentation to install composer globally for easier usage.