Admin Documentation

Updating BookStack

BookStack is updated regularly and is still in beta although we do try to keep the platform and upgrade path as stable as possible. The latest release can be found on GitHub here and detailed information on releases is posted on the BookStack blog here.

Before updating you should back up the database and any file uploads to prevent potential data loss.
Backup and restore documentation can be found here.

Updating is currently done via Git version control. To update BookStack you can run the following command in the root directory of the application:

git pull origin release && composer install && php artisan migrate

This command will update the repository that was created in the installation, install the PHP dependencies using composer then run then update the database with any required changes.

In addition, Clearing the cache is also recommended:

php artisan cache:clear
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.24 or higher

Version v0.24 changes the way the homepage option is stored. After updating, You may need to re-configure this setting.

If updating from a much older BookStack version (Pre v0.20) you may need to update the permission and search indexes. You can do this by running the following commands from your BookStack install folder:

php artisan bookstack:regenerate-search
php artisan bookstack:regenerate-permissions

Updating to v0.19 or higher

Version v0.19 needs the following requirement change:

  • Minimum required version of PHP has changed from 5.6.4 to 7.0.0.

Updating to v0.18 or higher

Version v0.18 introduced a commenting system. After updating you should check the permissions for all roles if you’d like to enable comments for your users.

Updating to v0.13 or higher

The v0.13 release contained some new features and updates which change the requirements of BookStack.

  • Minimum required version of PHP has changed from 5.5.9 to 5.6.4. Upgrade your PHP version if below 5.6.4.
  • PHP-Tidy extension is now required.
    • On Ubuntu 16.04 this can be installed via sudo apt install php7.0-tidy.
    • On Ubuntu 14.04 (Using the defauly 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.