BookStack Code Mirror - website/blob - content/docs/admin/updates.md

 1 +++
 2 title = "Updating BookStack"
 3 description = "How to update BookStack to the lastest version"
 4 date = "2017-01-01"
 5 type = "admin-doc"
 6 +++
 7
 8 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](https://github.com/BookStackApp/BookStack/releases) and detailed information on releases is posted on the [BookStack blog here](https://www.bookstackapp.com/blog/tag/releases/).
 9
 10 **Before updating you should back up the database and any file uploads to prevent potential data loss**. <br>
 11 Backup and restore documentation can be found [here](/docs/admin/backup-restore).
 12
 13  Updating is currently done via Git version control. To update BookStack you can run the following command in the root directory of the application:
 14
 15 ```bash
 16 git pull origin release && composer install && php artisan migrate
 17 ```
 18
 19 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.
 20
 21 In addition, Clearing the cache is also recommended:
 22
 23 ```bash
 24 php artisan cache:clear
 25 php artisan view:clear
 26 ```
 27
 28 Check the below list for the version you are updating to for any additional instructions.
 29
 30 ---
 31
 32 ## Version Specific Instructions
 33
 34 #### Updating to v0.25.2 or higher
 35
 36 **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.
 37
 38 #### Updating to v0.25 or higher
 39
 40 **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.
 41
 42 **Requirements Change** - Minimum required version of PHP has changed from 7.0.0 to 7.0.5.
 43
 44 **Configuration Change** - The .env option `GRAVATAR_URL=false` has been replaced by `AVATAR_URL=false`.
 45
 46
 47 #### Updating to v0.24 or higher
 48
 49 Version v0.24 changes the way the homepage option is stored. After updating, You may need to re-configure this setting.
 50
 51 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:
 52
 53 ```bash
 54 php artisan bookstack:regenerate-search
 55 php artisan bookstack:regenerate-permissions
 56 ```
 57
 58 #### Updating to v0.19 or higher
 59
 60 Version v0.19 needs the following requirement change:
 61
 62 * Minimum required version of PHP has changed from 5.6.4 to 7.0.0.
 63
 64 #### Updating to v0.18 or higher
 65
 66 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.
 67
 68 #### Updating to v0.13 or higher
 69
 70 The v0.13 release contained some new features and updates which change the requirements of BookStack.
 71
 72 * Minimum required version of PHP has changed from 5.5.9 to 5.6.4.
 73   Upgrade your PHP version if below 5.6.4.
 74 * PHP-Tidy extension is now required.
 75   - On Ubuntu 16.04 this can be installed via `sudo apt install php7.0-tidy`.
 76   - On Ubuntu 14.04 (Using the defauly PHP option) this can be installed via `sudo apt-get install php5-tidy`.
 77 * 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.