How to Back Up and Restore Server Configuration
How to Back Up and Restore Server Configuration
Export your Brainsalt server's entire configuration to a single file and restore it on the same server or a different one. Use this to clone a proven setup across multiple servers, recover after hardware replacement, or keep an off-server copy of your configuration.
[USER-ACTION-REQUIRED: Attach a screenshot of the Backup & Restore page in System Management here]
Before you start
- You are signed in to System Management with the Administrator role. Backup & Restore is not available to Operator or User roles.
- The server is in a stable state (no active software update or display reconfiguration in progress).
- For restore: you have the backup file and its passphrase (if it was encrypted).
What the backup contains
A backup bundles everything the System Management interface can configure into one downloadable file:
-
Settings — web and service configuration (ports, service toggles, roles, front-panel settings, notes, storage parameters).
-
Credentials — all user accounts (password hashes) and the VNC remote-desktop password.
-
GPU / display configuration — EDID overrides, Mosaic grids, output color/format settings, virtual monitors, genlock state, and desktop layout.
-
Network snapshot — IP addresses, DHCP/static settings, and BMC network configuration for every adapter (captured for reference, never auto-applied — see below).
-
Application data (optional) — the shared application data folder used by Backstage and other Brainsalt products. Can be large; locked files are skipped automatically.
Media and video content on the media drive is NOT included. Only configuration (and optionally application data) is backed up. Back up your media drive separately.
Steps
Export a backup
Open System Management and navigate to Configure → Backup & Restore.
1. Choose whether to include application data
Tick Include Application Data if you want to capture the shared application data folder. Leave it unchecked for a fast, configuration-only backup.
2. Set a passphrase (optional)
Enter a Passphrase to encrypt the backup file with AES-256. The backup contains user credentials and VNC passwords — a passphrase is strongly recommended if the file will be stored off-site or transferred over a network.
3. Start the export
Click Export backup. A progress bar shows the packing status (file count and percentage). You can cancel at any time. When the export finishes, the browser automatically downloads the backup file.
Restore from a backup
1. Upload the backup file
In the Restore section, click the file chooser and select your backup file.
2. Select which blocks to restore
Tick the blocks you want to apply. Each block is independent — you can restore any combination:
-
Settings — service configuration, ports, notes, front-panel settings.
-
Credentials — user accounts and VNC password.
-
GPU — display configuration (EDIDs, Mosaic, output settings, virtual monitors). Applied to the GPUs immediately after restore.
-
Network (review) — imported IP and BMC settings appear for review. You apply or skip each adapter individually.
-
Application Data — only available if the backup was exported with this option.
3. Enter the passphrase (if encrypted)
If the backup was encrypted, enter the same passphrase used during export.
4. Start the restore
Click Restore selected. Confirm the prompt. The file uploads to the server and the selected blocks are applied. A progress bar shows upload and extraction status.
5. Review and apply network settings
If you selected Network (review), the imported IP configuration for each adapter and the BMC appears in a review panel below the Restore section. For each entry, click Apply to use that setting or Skip to leave it unchanged. The source server's hostname is also shown for optional application.
Applying a network change can disconnect your session if it changes the IP address you are connected through. Use a local console session or VNC when applying network settings.
6. Restart the service
Restored Settings and Credentials take effect after a service restart. GPU display configuration is applied immediately (the screen may flicker or briefly disconnect during re-application).
Options explained
Export options
|
Setting |
Description |
Values / Range |
|---|---|---|
|
Include Application Data |
Adds the shared application data folder to the backup. Can significantly increase the file size. Files locked by running applications are skipped automatically. |
Checkbox (off by default) |
|
Passphrase |
Encrypts the backup file with AES-256. Required on restore to decrypt. Leave empty for an unencrypted backup. |
Free text (optional) |
Restore blocks
|
Block |
Description |
When applied |
|---|---|---|
|
Settings |
Web and service configuration (ports, service toggles, minimum roles, front-panel settings, notes, storage parameters). The server's unique identity is preserved — it is not overwritten by the source server's identity. |
After service restart |
|
Credentials |
All user accounts (with password hashes) and the VNC remote-desktop password. |
After service restart |
|
GPU |
EDID overrides, Mosaic grids, output color/format/bit-depth, virtual monitors, genlock, and desktop layout. The display layout is replayed onto the GPUs as a multi-step hardware re-apply — the screen may flicker. |
Immediately (applied to GPUs) |
|
Network (review) |
Host adapter IPs (static/DHCP), BMC network settings, and hostname. Shown for manual review — never auto-applied. |
Per-adapter, on your confirmation |
|
Application Data |
Shared application data folder. Only available if the backup was exported with this option enabled. Files locked by running applications are skipped. |
Immediately (file copy) |
Common Mistakes
-
Lost passphrase. An encrypted backup cannot be restored without the exact passphrase. There is no recovery mechanism. Store the passphrase securely alongside the backup file.
-
Expecting network settings to apply automatically. Network and BMC IP settings are deliberately not auto-applied. Blindly copying IP addresses from one server to another would create address conflicts and could lock you out of the server. After restoring, review each adapter and apply or skip individually.
-
Restoring GPU configuration on a different display setup. Display settings (genlock, output color, Mosaic grids) are tied to the specific GPU and display topology. Restoring these onto a server with different GPUs, different outputs, or fewer displays may not produce the expected result. The display re-apply works correctly only when the hardware topology is identical.
-
Forgetting to restart the service. Restored Settings and Credentials do not take effect until the System Management service is restarted. GPU display configuration is the exception — it is applied immediately.
-
Applying network settings remotely. Changing the IP address of the adapter you are currently connected through will drop your session. Apply network settings from a local console or VNC session, or from a second network adapter.
Factory Reset
The same Backup & Restore page contains a Factory Reset section at the bottom. This is a separate, destructive action that returns the server to defaults.
Factory Reset is not reversible. It deletes all users (resetting to the default administrator account), tears down the display configuration, resets the VNC password, clears all settings, and can switch every network adapter to DHCP. The server reboots automatically afterwards. Export a backup first so you can recover if needed. You must type RESET to confirm.
Tips
-
Export a backup before every major change (display reconfiguration, software update, or factory reset). The export is fast when application data is excluded.
-
To clone a configuration across multiple identical servers, export once, then restore on each target server. Skip the Network block (or review it per server) to avoid IP conflicts.
-
A configuration-only backup (without application data) is typically small and exports in seconds. Including application data can produce a multi-gigabyte file depending on what Backstage and other products have stored.
-
The backup file includes user password hashes and VNC credentials. Always use a passphrase when the file will leave the local network.
-
You can cancel an export in progress without affecting the server. Nothing is changed on the server during export — it is a read-only snapshot.
Related
[USER-ACTION-REQUIRED: Add links to related pages once they exist in BXHELP, e.g. 'How to Configure Network Settings', 'How to Factory Reset a Server', 'System Management Overview'. No related pages are currently published in this space.]
