Skip to content

Added notes on backup restores based on processor arch #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MattDHill merged 1 commit into from
Dec 31, 2025
Merged

Added notes on backup restores based on processor arch #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/user-manual/backup-create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Creating backups is an essential responsibility of self-hosting. If you do not m

1. You can create backups to a [physical drive](#physical-drive) plugged directly into your server, or over-the-air to another device on the same LAN (a [network folder](#network-folder)).

1. Backups are encrypted using your master password.
1. Backups are encrypted using your master password. If you change your password prior backups retain the original password.

1. Services may choose to exclude certain files or folders from the backup. For example, Bitcoin excludes the blockchain, since it can be recovered by re-syncing.

Expand All @@ -24,6 +24,8 @@ Creating backups is an essential responsibility of self-hosting. If you do not m

1. Upon completion, StartOS issues a backup report, indicating which services were backed up, as well as any errors.

1. Backups taken from a specific system architecture (x86, ARM, RISC-V) are backed up for just that architecture. If restored to another architecture, they will likely need to be reinstalled to run efficiently.

## Physical Drive

`EXT4` is the recommended format of your backup drive. `fat32` and `exFAT` are _not_ recommended and may not work.
Expand Down
4 changes: 4 additions & 0 deletions src/user-manual/backup-restore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ This option should only be necessary if you accidentally uninstall a service.
1. Decrypt the backup drive by entering the password that was used to create it.
1. Select the service(s) you want to restore and click "Restore Selected".

```admonish tip title="Important"
If you're restoring a backup taken from a different system architecture (x86, ARM, RISC-V) to the one you're restoring to, you may need to *reinstall* services (not uninstall, since you will lose your data) from the marketplace after the restore completes to avoid running them more slowly in emulation.
```

## Restoring an Entire Server

If your StartOS data drive is lost or corrupted and you need to restore your entire server, follow instructions [here](./initial-setup.md#recover-options).