Backup & Restore

Owned by Yelyzaveta Burda
Last updated: Jun 13, 2024
3 min read

Introduction to Backup & Restore for SubSpace Navigation

The Backup tab panel ensures that all of your navigation settings are securely archived and can be restored or transferred as needed.
Whether you're looking to perform routine backups, prepare for migrations between Confluence instances, or ensure continuity in your production environments, the Backup & Restore feature is your essential tool.


In the Confluence Settings, scroll down to Subspace Navigation on the left and go to the “Backup & Restore” entry. You will see the Backup tab panel displayed by default.

 

image-20240516-140544.png
Image 1: Backup tab panel (click to enlarge)

 

What Data Do We Export?

The "What data do we export?" section outlines the specific elements of the SubSpace Navigation that are included in the backup.

 

image-20240516-135709.png
Image 2: The data that will be exported (click to enlarge)

Create Backup

Clicking the "Create Backup" button triggers the actual creation of the backup file and gives you the option to label the backup file for easier identification.

 

Restore Process

The Restore tab allows you to reinstate previously saved configurations of SubSpace Navigation from backup files. This is crucial for recovering data or transferring configurations between different instances of Confluence.

 

Steps to Initiate a Restore:

  1. Restore Status: Initially, the status shows as "Not Started". After a restore operation, it updates to either "done" or "failed" based on the outcome of the restore process.

  2. File Selection:

    • Drop a File: You can drag and drop a backup file or click to navigate through your local directory to select a backup file.

    • Activation: Once a file is selected, the "Restore from Backup" button becomes active, enabling you to initiate the restore process.

  3. Restore Confirmation:

    • Upon clicking "Restore from Backup", a confirmation dialog warns you that proceeding will overwrite the current configuration.

    • You must confirm the action by clicking "Restore" to begin the process.

Restore Details: Expanding the Restore Status section post-restoration reveals details such as:

  • Label: The label set in the backup process.

  • Date: When the restore was performed.

  • Restored Menus: Lists all menus restored.

  • Global Settings: Indicates the status of global settings restoration.

Backup Details View

The Backup Details tab provides the history of backup operations performed during the backup process.
This will help you keep track of backup activities and access specific backup information in case of possible misuse.

 

Table Overview

In the table, you will see the following details:

Label: The custom label or the default label assigned to each backup. This label helps in identifying the backup easily.
User: Displays the profile picture and name of the user who performed the backup, enhancing traceability and accountability.
Export Date: Shows the exact date and time when the backup was created, providing a chronological view of backup activities.
Exported Menus: Lists all the navigation menus that were included in the backup. This detail allows users to understand the scope of each backup.

 

When backups have been performed, the tab displays a table that holds a maximum of 10 entries. When an 11th entry is added, the oldest backup (the last one in the list) is automatically removed to maintain the cap.