rework backup restore options

This commit is contained in:
Matt Hill
2023-11-15 14:16:15 -07:00
parent a678eb6743
commit 47629b197a
7 changed files with 71 additions and 105 deletions

View File

@@ -0,0 +1,33 @@
.. _attach-drive:
==========================
Use an Existing Data Drive
==========================
During initial setup, select this option if you:
1. have re-flashed StartOS and want to resume normal operation on the same device
2. are transplanting your existing data drive to a new device, perhaps one with a better CPU or more RAM
#. During select "Recover."
.. figure:: /_static/images/setup/screen0-recover.jpg
:width: 60%
#. Next, select "Use Existing Drive."
.. figure:: /_static/images/setup/screen3-use_existing.jpg
:width: 60%
#. Select your server's data drive.
.. figure:: /_static/images/setup/screen4-use_existing_drive_selection.jpg
:width: 60%
#. Enter and confirm a new password.
.. figure:: /_static/images/setup/screen5-set_password_complete.jpg
:width: 60%
#. Your server will initialize again (all previous data will be recovered).
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60%

View File

@@ -8,8 +8,10 @@ Guides that do not fit into the categories of "devices" or "services."
.. toctree::
:maxdepth: 1
attach-drive
transfer-data
upgrade-pi
lnd-migration
upgrade-hardware/index
thunderbird
smtp
backup-mount

View File

@@ -1,8 +1,8 @@
.. _ssd-upgrade:
.. _transfer-data:
================
Upgrade Your SSD
================
============================
Transfer Data to a New Drive
============================
This guide will go over how to upgrade your data drive and transfer the data from the old one to the new one. This will preserve the entire state of your server, including all Tor and LAN addresses as well as channels you have open on the lightning network! You may like to do this in order to increase storage size, storage speed, or just to move your existing server data to new hardware entirely.
This is not the same as running a back up and restoring them onto a new server. You can read about the differences on the :ref:`Restore page<backup-restore>`.

View File

@@ -1,11 +0,0 @@
.. _upgrade-hardware:
==================
Upgrading Hardware
==================
.. toctree::
:maxdepth: 1
drive-upgrade
upgrade-pure

View File

@@ -1,14 +1,12 @@
.. _upgrade-pi:
=========================
Upgrade From Raspberry Pi
Upgrade Your Raspberry Pi
=========================
Follow this guide to upgrade from a Raspberry Pi StartOS server to a Server One, Server Pure, or similar device.
.. _external-drives:
External Drive
==============
From Pi with External Drive
---------------------------
If your current Raspberry Pi setup uses an external drive over USB.
#. Shutdown your Raspberry Pi server and disconnect from power. If you have a speaker, wait for shutdown noises.
@@ -71,9 +69,8 @@ If your current Raspberry Pi setup uses an external drive over USB.
.. warning:: DO NOT reconnect your old server without first wiping the SD card and SSD! This can cause serious problems! If you have lightning channels you could lose your money!
NASPI (Embassy One)
===================
From NASPI (Embassy One)
------------------------
.. figure:: /_static/images/hardware-pics/server-one.png
:width: 30%

View File

@@ -4,20 +4,13 @@
Backup Restore
==============
There are 3 different ways that you may choose to recover server data, as well as a 4th option to migrate/transfer data between hardware.
.. warning:: Restoring from backup is for disaster recovery purposes only. To re-use an existing data drive with a fresh copy of StartOS (after re-flashing, for example), follow :ref:`this guide <attach-drive>`. To transfer data from one drive drive to another (to upgrade your storage, for example), follow :ref:`this guide <transfer-data>`.
#. "Restore [individual services] from Backup" to your currently running server. This is specifically for service data.
#. "Use Existing Drive" a drive with existing server data on it during setup. Use this when re-flashing your SD card, for example.
#. "Restore [entire server] from Backup" (as in, disaster recovery) all server data in the event that your backup is the **only** thing you have left.
#. "Transfer" data from an existing server. This is a total migration for use when upgrading hardware only.
.. warning:: If you are restoring data from a drive that you are attaching *directly to your server,* (if using a RasPi or other low-powered board) please ensure that it is getting adequate power. This is best accomplished via external power to the drive (such as a powered USB hub). Server One (2022 and newer) and Server Pure users can safely ignore this warning.
Select the appropriate tab below to restore your data:
If you are still reading, it means disaster has struck, and you need to restore your data from an encrypted backup.
.. tabs::
.. group-tab:: Restore
.. group-tab:: Restore specific services
#. Go to *System > Restore From Backup*.
@@ -41,34 +34,7 @@ Select the appropriate tab below to restore your data:
It is not possible to recover services that are already installed. If you wish to recover a service that is already installed, please uninstall it first to permit recovery.
.. group-tab:: Attach
#. During :ref:`Initial Setup<initial-setup>`, select "Recover."
.. figure:: /_static/images/setup/screen0-recover.jpg
:width: 60%
#. Next, select "Use Existing Drive."
.. figure:: /_static/images/setup/screen3-use_existing.jpg
:width: 60%
#. Select your server's data drive.
.. figure:: /_static/images/setup/screen4-use_existing_drive_selection.jpg
:width: 60%
#. Enter and confirm a new password.
.. figure:: /_static/images/setup/screen5-set_password_complete.jpg
:width: 60%
#. Your server will initialize again (all previous data will be recovered).
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60%
.. group-tab:: Recover
.. group-tab:: Restore entire server
#. During :ref:`Initial Setup<initial-setup>`, select "Recover."
@@ -80,22 +46,22 @@ Select the appropriate tab below to restore your data:
.. figure:: /_static/images/restore/recover0.png
:width: 60%
#. If you have a physical backup, plug it in and select the drive. If it does not appear, try another USB 3.0 (blue) port and hit refresh, then select the drive and skip to step 5 (enter drive encryption password). If you are using a Network Folder, click "Open."
#. (Physical drive only) Select your backup drive. If it does not appear, try another USB 3.0 (blue) port and hit refresh.
.. figure:: /_static/images/restore/recover1.png
:width: 60%
#. Enter the details for your Network Folder and click "Verify".
#. (Network folder only) Click "Open". Enter the details for your Network Folder and click "Verify".
.. figure:: /_static/images/restore/recover2.png
:width: 60%
#. Enter the encryption password for the drive (this is your server's master password).
#. Enter the encryption password for the drive (the master password of your server when the backup was created).
.. figure:: /_static/images/restore/recover3.png
:width: 60%
#. Select the drive (from your new hardware) that you are recovering onto.
#. Select the drive (from your new hardware) where the data will be stored on the new server.
.. warning:: This will **PERMANENTLY ERASE** any existing data on that drive. If you re-using an old drive, ensure that you have first removed all your data!!
@@ -109,40 +75,3 @@ Select the appropriate tab below to restore your data:
.. figure:: /_static/images/restore/recover6.png
:width: 60%
.. group-tab:: Transfer
#. During :ref:`Initial Setup<initial-setup>`, select "Recover."
.. figure:: /_static/images/setup/screen0-recover.jpg
:width: 60%
#. Select "Transfer"
.. figure:: /_static/images/setup/transfer.png
:width: 60%
#. Plug in the drive (make sure it is powered on) of the server you are migrating **from** and select it (in this example, /dev/sda). You may need to try a different USB port and hit "Refresh" if you don't see it immediately. You will see a warning about using the old drive again; read and understand it.
.. figure:: /_static/images/setup/transfer-from.png
:width: 60%
#. Select the drive on your new server (that you are migrating **onto**).
.. figure:: /_static/images/setup/transfer-to.png
:width: 60%
.. warning:: This will **PERMANENETLY ERASE** any existing data on that drive. If you re-using an old drive, ensure that you have first removed all your data!!
#. Set your new master password. *Make it good. Write it down.* Click finish.
.. figure:: /_static/images/setup/screen5-set_password.png
:width: 60%
.. figure:: /_static/images/setup/transfer-calc-size.png
:width: 60%
#. Your server will now initialize and migrate the old data to the new drive. The time required can vary greatly depending on how much data you are migrating. Be prepared for this to take many hours, especially if you have 1-2TB+ of data. Go have a sandwich and contemplate other aspects of your sovereignty.
.. figure:: /_static/images/setup/transfer-copying.png
:width: 60%

View File

@@ -4,12 +4,18 @@
Initial Setup
=============
#. If using Firefox (*highly recommended*) to connect to your server, you must complete the "Local" portion for your OS. For iOS, use Safari:
.. _fresh-setup:
Starting Fresh
--------------
#. If using Firefox (*recommended*) to connect to your server, you must complete the "Local" portion for your OS:
- :ref:`Linux <ff-linux>`
- :ref:`Mac <ff-mac>`
- :ref:`Windows <ff-windows>`
- :ref:`Android <ff-android>`
- iOS (use Safari)
#. Connect your server to power and Ethernet
@@ -19,6 +25,16 @@ Initial Setup
#. Follow the on-screen instructions.
.. _recover-options:
Recover Options
---------------
If you are using an existing drive, transferring data from one drive to another, or restoring your entire system from a backup, follow the appropriate guide below:
- :ref:`Use Existing Drive <attach-drive>`
- :ref:`Transfer <transfer-data>`
- :ref:`Restore from Backup <backup-restore>`
.. _setup-troubleshooting:
Troubleshooting