Back up your existing installation
- Last Updated: October 2, 2026
- 1 minute read
- Semaphore
- Documentation
Before upgrading Semaphore, create both of the following backups:
- Studio and KMM backups by using the Semaphore user interface.
- A file-system backup of the Semaphore application data and configuration.
Back up Studio and KMM
Create separate backups of Studio and KMM by using the backup functionality available in the Semaphore user interface:
-
To back up Studio, select Services > Backup/Restore > Download Backup.
-
To back up the entire KMM workspace, select Tools > Backup Models > Entire Workspace.
The workspace backup includes models, model history, Publisher configuration, custom edit rules, and other KMM data and configuration.
For detailed instructions, refer to Backing up and restoring Semaphore in the Semaphore for Linux Administration guide.
Create a file-system backup
In addition to the Studio and KMM backups, create a file-system backup as an additional safeguard:
-
Stop all Semaphore services:
sudo systemctl stop semaphore -
Back up the application data and configuration in the following directories:
/var/opt/semaphore/ /etc/opt/semaphore/The
/var/opt/semaphore/directory contains application data. The/etc/opt/semaphore/directory contains application configuration.For example:
sudo mkdir -p /backup sudo tar -czf /backup/semaphore-backup-$(date +%F-%H%M).tar.gz \ /var/opt/semaphore/ \ /etc/opt/semaphore/Run the backup command with administrator privileges (
root) to ensure that all required files can be read and included in the archive. -
Verify the contents of the backup archive before proceeding with the upgrade:
tar -tzf /backup/semaphore-backup-YYYY-MM-DD-HHMM.tar.gz -
Store at least one copy of the backup outside the server on which the upgrade is performed.