Upgrading Signature
About Signature
Welcome to Signature, your go-to destination for knowledge and information! Signature is powered by BookStack, a versatile and user-friendly platform designed to streamline the creation and management of documentation.
What is Signature?
Signature is more than just a knowledge base—it's your one-stop shop for all things related to our organization. Whether you're a new employee looking to onboard smoothly, a seasoned team member seeking specific information, or a curious visitor exploring our offerings, Signature has you covered.
Technical Details
- Powered by BookStack: Signature utilizes BookStack, a powerful and intuitive documentation platform.
- Data Centre: Hosted in the Azure South-Africa region, ensuring reliability and performance for our users in the local area.
- Last Updated Version: v24.02.3
- Last Updated Date: [Insert Date]
Upgrade history
Version | Date | Location | Description |
---|---|---|---|
21.12.3 | 2022-06-01 | AWS [Version 9] | This version was set up in a container on Ubuntu 18.04 |
24.02.3 | 2024-04-26 | Azure South-Africa | Migrated from container to stand-alone on Ubuntu 22.04 |
Upgrading Bookstack
BookStack is updated regularly. 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 three following commands in the root directory of the application:
cd /var/www/bookstack/
sudo git pull origin release
sudo composer install --no-dev
sudo php artisan migrate
- Line 2 will update the repository that was created in the installation.
- Line 3 will install the PHP dependencies using
composer
. - Line 4 will then update the database with any required changes.
In addition, Clearing the system caches is also recommended:
sudo php artisan cache:clear
sudo php artisan config:clear
sudo php artisan view:clear0
Check the below Version Specific Instructions list for the version you are updating to for any additional instructions.
When running update commands, your command line user will need permission to handle the required files and folders in the BookStack installation folder. You can find more details about required filesystem permissions here.