Restoring brings a Burrow's contents back from a backup archive you made earlier. You place the archive where the Burrow can find it, and the next time the owner opens the dashboard the Burrow offers to restore it. Restoring replaces what is in the Burrow now with what the backup holds: its projects, environments, and secrets, every version and in the same order. The Burrow keeps its own identity, who can sign in, and its network and certificate settings, so only the contents change.
What you need#
Two things, both from when the backup was made:
Item | Detail |
|---|---|
The backup archive | The |
Its passphrase | The passphrase you set when the backup was made. The Burrow cannot recover or reset it, and cannot restore without it. |
Only the burrow owner can restore. Other members are not shown the prompt.
Place the backup#
Copy the backup archive onto the server the Burrow runs on.
Put it in the
restorefolder inside the Burrow's data directory. By default this isdata/restore/; if you setBURROW_DATA_DIR, it is therestorefolder inside that.Leave exactly one
.rkbfile there. The Burrow picks it up on its own; there is nothing to restart.
Restore it#
Open your Burrow as the owner. The restore prompt appears on its own, naming when the backup was taken and the version it came from.
Enter the backup passphrase.
To bring back the backup's audit history as well, tick Also restore the backup's audit history. Left unticked, the Burrow keeps its own history.
Tick I understand this replaces the Burrow.
Select Replace burrow.
The Burrow works through the restore and shows each step as it goes: reading the backup, replacing the contents, re-securing the secrets, and finishing. The secrets step scales with how many you have and shows a progress bar. Leave the dialog open until it finishes; it cannot be closed while a restore is running. When it is done, the dashboard reloads onto the restored contents.
What changes and what stays#
Restoring touches the Burrow's contents and leaves the Burrow itself alone.
Area | What happens |
|---|---|
Projects, environments, and secrets | Replaced with the backup's, every secret version and its order. |
Machines | Reset. Enrolled machines are removed and re-enroll against the restored contents, covered below. |
Who can sign in and their roles | Unchanged. |
Network, address, and certificate | Unchanged. The Burrow keeps where it is reached and the certificate it serves. |
Other Burrow settings | Brought back from the backup, such as the display name and update preference, apart from the network and certificate settings above. |
Audit history | Kept, unless you choose to restore the backup's. The restore itself is always recorded. |
Machines re-enroll#
A machine's access is tied to the projects it was granted, and restoring replaces those. Enrolled machines are cleared during a restore. After it finishes, enroll each machine again from the Machines page and grant it access to the restored projects and environments.
If the backup is from a newer version#
A backup restores into the same version it was taken from, or a newer one. A backup taken by a newer build than the one you are restoring into is refused, with the current contents left untouched, since it may carry data this build does not understand. Update the Burrow first, then restore.
After a restore#
The archive is moved out of the restore folder into a restored folder beside it, so it is not offered again and you still have the file. To restore once more, place a fresh archive in the folder.