Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-30 20:14:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Big refactor, many minor fixes (#441)

Browse Source 
* Big refactor, many minor fixes

* Link fixes, icon edits

* Index and ToC fixes

* update icons in theme lib and add to device guides index

* WIP - refactor Initial setup, LAN, FF, others

* First draft ready, many fixes and edits

* Ooops - minor edits and changes on initial setup

* Add change password guide (try 2).

* Remove change password menu item from guides

* Fix display bug, think different

---------

Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
Co-authored-by: gStart9 <george@start9labs.com>
This commit is contained in:
kn0wmad
2023-07-28 18:02:43 +00:00
committed by GitHub
parent eceae35a2b
commit 09b61c7e33
149 changed files with 1362 additions and 785 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
site/source/guides/upgrade-hardware/drive-upgrade.rst Normal file
View File

@@ -0,0 +1,74 @@
.. _ssd-upgrade:
================
Upgrade Your SSD
================
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>`.
.. tip:: You will likely need a cable, adapter, or enclosure in order to attach your old drive via USB for data migration.
Power Down and Exchange Hardware
--------------------------------
#. Start by shutting down your server:
.. figure:: /_static/images/walkthrough/shutdown.png
:width: 50%
#. Remove power and extract the existing drive from your device.
#. Install the new drive, ideally in the same hardware slot as the previous drive. Be sure to secure with screws if applicable.
Flash StartOS and Transfer Data
-------------------------------
#. Flash your device with a fresh install of StartOS by following our :ref:`flashing guides <flashing>`.
#. Head to http://start.local from any device on the same LAN.
#. Select "Recover".
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.png
:width: 30%
#. Select "Transfer".
.. figure:: /_static/images/setup/transfer.png
:width: 30%
#. Now plug in the **old drive** to your server, using an adapter if necessary.
.. tip:: Use the fastest possible data transfer method, especially if moving terabytes of data.
#. Select the **old drive** - the one that is externally connected to your server, which you are migrating **from**. You may need to hit "REFRESH" if it does not appear:
.. figure:: /_static/images/setup/transfer-from.png
:width: 30%
#. Select the **new drive** (installed earlier) that you are migrating **to**.
.. warning:: Any data on this new drive will be PERMANENTLY ERASED! BE CERTAIN that it is the correct drive.
.. figure:: /_static/images/setup/transfer-to.png
:width: 30%
#. You will be asked to create your master password. It can be the same as it was previously, or a new one.
.. figure:: /_static/images/setup/screen5-set_password.png
:width: 30%
#. Your data will now transfer. Keep in mind that the more data you have, the longer this process will take, possibly even days.
.. note:: As an example, transferring 2TB of data from a Server Pure via a USB3.2 enclosure to a new 4TB NVMe drive can take upwards of 24hrs, including up to 14hrs of "initialization," while StartOS indexes all the data (at the beginning of the process). Please be patient.
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 20%
#. You are now ready to proceed and use your server with its new drive! It will have the same addresses and root certificate as it did before migrating.
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
:width: 30%
.. warning:: Do not under any circumstances use your old drive to setup another server unless you wipe it first or wipe it during the initial setup process. If you have lightning channels you could lose all your funds!

70
site/source/guides/upgrade-hardware/index.rst Normal file
View File

@@ -0,0 +1,70 @@
.. _upgrade-hardware:
================
Upgrade Hardware
================
Guides for migrating or upgrading your server's hardware.
.. raw:: html
<div class="topics-grid grid-container full">
<div class="grid-x grid-margin-x">
.. topic-box::
:title: Migrate LND from other nodes to StartOS
:link: lnd-migration
:icon: scylla-icon scylla-icon--home
:class: large-5
:anchor: Upgrade
This is for migrating LND from another node to StartOS without closing channels
.. topic-box::
:title: Upgrade SSD
:link: drive-upgrade
:icon: scylla-icon scylla-icon--benchmarks
:class: large-5
:anchor: Upgrade
This is for replacing or upgrading your SSD
.. topic-box::
:title: Upgrade SSD ('22 Server One)
:link: naspi-ssd-upgrade
:icon: scylla-icon scylla-icon--benchmarks
:class: large-5
:anchor: Upgrade
This is for replacing or upgrading your 2022 Server One SSD
.. topic-box::
:title: 2022 One to Pro Migration
:link: upgrade-pro
:icon: scylla-icon scylla-icon--enterprise
:class: large-5
:anchor: Upgrade
This is for migrating from a Server One (Raspberry Pi) to Server Pro
.. topic-box::
:title: Upgrade to all-in-one NASPi case
:link: naspi-upgrade
:icon: scylla-icon scylla-icon--home
:class: large-5
:anchor: Upgrade
This is for upgrading a Pi to an all-in-one NASPi case
.. raw:: html
</div></div>
.. toctree::
:maxdepth: 2
LND migration <lnd-migration>
SSD upgrade <drive-upgrade>
Pro upgrade <upgrade-pro>
NASPi upgrade <naspi-upgrade>
2022 Server One SSD upgrade <naspi-ssd-upgrade>

26
site/source/guides/upgrade-hardware/lnd-migration.rst Normal file
View File

@@ -0,0 +1,26 @@
.. _lnd-migration:
========================
Migrating LND to StartOS
========================
.. warning:: **After migrating an LND wallet to StartOS, NEVER restart your old node. Turning on your old node can result in the broadcast of old channel states and potentially loss of funds!**
This guide is for users seeking to migrate LND on-chain and lightning funds from a different node to StartOS easily and without closing channels. This migration will require two sets of hardware, your existing hardware you wish to migrate from, and the hardware running StartOS you are migrating to. Both devices must be running on the same LAN. The LND service on StartOS provides easy to use actions for users migrating from the below Node implementations:
- Umbrel (Both 0.4 and 0.5)
- RaspiBlitz
- myNode
**Instructions**
#. First, you will first navigate to your LND service on StartOS and click the `Stop` button to stop LND.
.. warning:: Running any of the migration actions above will delete any existing LND wallet running on your StartOS server. If you have funds on your StartOS LND node, make sure to transfer these funds to another wallet before running a migration action.
#. Select the action corresponding to the node you are migrating from and fill out the corresponding IP and password(s). If you are unsure of the IP address of your node, you may need to check your router.
.. figure:: /_static/images/hardware-pics/lnd_migration_actions.png
:width: 60%
#. The migration action may take several minutes to complete. Once the action has completed and your old node has been unplugged, you may safely start LND on StartOS. **Remember - NEVER restart your old node after the migration has completed!**

134
site/source/guides/upgrade-hardware/naspi-ssd-upgrade.rst Normal file
View File

@@ -0,0 +1,134 @@
.. _naspi-ssd-upgrade:
======================
Upgrade Your NASPI SSD
======================
This guide will go over how to switch out an old drive on your server to a different 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!
This is not the same as running a back up and restoring them onto a new server.
#. Start by shutting down your server:
.. figure:: /_static/images/walkthrough/shutdown.png
:width: 50%
#. Remove the power and Ethernet cables:
.. figure:: /_static/images/hardware-pics/back-no-cables.jpg
:width: 50%
#. Unscrew the two screws here and remove the USB adaptor:
.. figure:: /_static/images/hardware-pics/back-screws-usb-loop.jpg
:width: 50%
#. Remove the micro SD card from the front:
.. figure:: /_static/images/hardware-pics/front-sd-card.jpg
:width: 50%
#. Remove the bottom four screws:
.. figure:: /_static/images/hardware-pics/bottom-screws.jpg
:width: 50%
#. Carefully slide the contents of the case out and disassemble the server by disconnecting the power wire and removing the 5 screws (and 4 brass spacers beneath the fan bracket) highlighted below:
.. figure:: /_static/images/hardware-pics/disassembly-0.png
:width: 50%
#. This top section should lift off now and you'll be left with the SSD still attached. Remove the two screws shown below:
.. figure:: /_static/images/hardware-pics/disassembly-1.png
:width: 50%
#. Now slide the **old** SSD off the connector:
.. figure:: /_static/images/hardware-pics/old-drive-exposed.jpg
:width: 50%
#. Now take the **new** SSD, and connect it where the old one was:
.. figure:: /_static/images/hardware-pics/new-ssd-attach-0.png
:width: 50%
#. Secure the SSD with the two silver screws:
.. figure:: /_static/images/hardware-pics/disassembly-1.png
:width: 50%
#. Reattach the 4 brass spacers holding the Pi to the SSD board, followed by the 5 black screws to secure the fan bracket and power management board. Then reconnect the power wire:
.. figure:: /_static/images/hardware-pics/disassembly-0.png
:width: 50%
#. Now reinsert the server back into the case and reattach the bottom four black screws:
.. figure:: /_static/images/hardware-pics/bottom-screws.jpg
:width: 50%
#. Reconnect the USB adaptor and back two black screws:
.. figure:: /_static/images/hardware-pics/back-screws-usb-loop.jpg
:width: 50%
#. Flash the micro SD card with a fresh install of StartOS - you can follow the flashing guide :ref:`here <flashing-pi>`
#. Once flashed, reinsert the micro SD card into the server:
.. figure:: /_static/images/hardware-pics/front-sd-card.jpg
:width: 50%
#. Reconnect the Ethernet cable, make sure the USB adaptor is connect and then finally connect the power cable:
.. figure:: /_static/images/hardware-pics/plugged-in-back.jpg
:width: 50%
.. figure:: /_static/images/hardware-pics/plugged-in-front.jpg
:width: 50%
#. Head to http://start.local on any device on the same LAN
#. Select "Recover"
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.png
:width: 60%
#. Select "Transfer"
.. figure:: /_static/images/setup/transfer.png
:width: 60%
#. Now connect the **old ssd** to your server:
.. figure:: /_static/images/hardware-pics/attach-ssd.jpg
:width: 60%
#. Select the **old drive** - the one that is externally connect to your server (you may need to hit *REFRESH*):
.. figure:: /_static/images/setup/transfer-from.png
:width: 60%
#. Select the drive **inside the server** that you are migrating **to** - this is your **NEW** drive - and any data on this drive will be erased:
.. figure:: /_static/images/setup/transfer-to.png
:width: 60%
#. You will be asked to create a password. It can be the same as it was previously:
.. figure:: /_static/images/setup/screen5-set_password.png
:width: 60%
#. Your data will now transfer over - the length of this process will vary depending on how much data you have, but will likely take several hours:
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60%
#. You are now ready to proceed and use your server with its new drive! It will have the same addresses and root certificate as it did before migrating.
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
:width: 60%
.. warning:: Do not unders any circumstances use the old SSD to setup another server unless you wipe it first or wipe it during the initial setup proecess! If you have lightning channels you could lose all your funds!

10
site/source/guides/upgrade-hardware/naspi-upgrade.rst Normal file
View File

@@ -0,0 +1,10 @@
.. _naspi-upgrade:
======================================
Upgrading from an External Drive Setup
======================================
If you already have a server with an external drive, you can follow along from the `written guide appendix <https://community.start9.com/t/diy-embassy-one-geekworm-naspi-case/49>`_ and/or check out the video below:
.. youtube:: 355BENA42s8
:width: 100%

165
site/source/guides/upgrade-hardware/upgrade-pro.rst Normal file
View File

@@ -0,0 +1,165 @@
.. _upgrade-pro:
=============================================
Migrating From 2022 Server One to Server Pure
=============================================
This guide is for Server One users upgrading from a NASPi (pictured below). If you're using an external drive, such as a Samsung T5/T7 please go :ref:`here <external-drives>`.
.. figure:: /_static/images/hardware-pics/server-one.png
:width: 30%
You will need a high quality `USB-A to USB-A cable <https://www.amazon.com/UGREEN-Transfer-Enclosures-Printers-Cameras/dp/B00P0E3954/?th=1>`_, or a `USB-A to USB-C cable <https://www.amazon.com/AmazonBasics-Type-C-USB-Male-Cable/dp/B01GGKYKQM/?th=1>`_.
#. Shutdown your Server One.
.. figure:: /_static/images/walkthrough/shutdown.png
:width: 60%
#. Listen out for the shutdown sounds, then after few more seconds, disconnect the power.
.. raw:: HTML
<audio controls>
<source src="/_static/sounds/SHUTDOWN.mp3" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
* Shutdown sound
#. Now disconnect the USB adapter found here:
.. figure:: /_static/images/hardware-pics/naspi-jameson-loop2.png
:width: 60%
#. Connect the USB cable to the lowest blue USB port like this:
.. figure:: /_static/images/hardware-pics/usb-into-naspi-edited.jpg
:width: 60%
#. Now connect the Ethernet cable and then the power to your Server Pro
.. figure:: /_static/images/hardware-pics/pro-all.jpg
:width: 60%
#. Head to http://start.local on any device on the same LAN
#. Select "Recover"
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.png
:width: 60%
#. Select "Transfer"
.. figure:: /_static/images/setup/transfer.png
:width: 60%
#. Now connect the other end of the USB cable to either an Server Pro USB-3 port or the USB-C port:
.. figure:: /_static/images/hardware-pics/pro-all-highlighted.jpg
:width: 60%
#. Connect the power to the NASPi - you will hear this sound and can ignore it:
.. raw:: HTML
<audio controls>
<source src="/_static/sounds/BEETHOVEN.mp3" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
* Beethoven's 5th
#. Select the drive inside the NASPi (you may need to hit refresh):
.. figure:: /_static/images/setup/transfer-from.png
:width: 60%
#. Select the drive inside the Server Pro that you are migrating *to* (this will erase any data on this drive):
.. figure:: /_static/images/setup/transfer-to.png
:width: 60%
#. You will be asked to create a password. It can be the same as it was previously:
.. figure:: /_static/images/setup/screen5-set_password.png
:width: 60%
#. Your data will now transfer over - the length of this process will vary depending on how much data you have, but will likely take several hours:
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60%
#. You are now ready to proceed and use your Server Pro - it will have the same addresses and root certificate as it did before migrating.
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
:width: 60%
.. warning:: Do not unders any circumstances reassemble your Server One without wiping the SD card first and wiping the SSD during initial setup! If you do not this will cause serious problems! If you have lightning channels you could lose all your funds!
.. _external-drives:
External Drives
===============
For transferring from an USB-attached drive.
#. Shutdown your Server One
.. figure:: /_static/images/walkthrough/shutdown.png
:width: 60%
#. Listen out for the shutdown sounds, then after few more seconds, disconnect the power.
.. raw:: HTML
<audio controls>
<source src="/_static/sounds/SHUTDOWN.mp3" type="audio/mpeg">
Your browser does not support the audio element.
</audio>
* Shutdown sound
#. Now connect the Ethernet cable and then the power to your Server Pro
.. figure:: /_static/images/hardware-pics/pro-all.jpg
:width: 60%
#. Head to http://start.local on any device on the same LAN
#. Select "Recover"
.. figure:: /_static/images/setup/screen0-startfresh_or_recover.png
:width: 60%
#. Select "Transfer"
.. figure:: /_static/images/setup/transfer.png
:width: 60%
#. Now connect your Samsung T5/T7/alternative drive to any USB-3 or USB-C port on your Server Pro
#. Select this drive (you may need to hit refresh):
.. figure:: /_static/images/setup/transfer-from.png
:width: 60%
#. Select the drive inside the Server Pro that you are migrating *to* (this will erase any data on this drive):
.. figure:: /_static/images/setup/transfer-to.png
:width: 60%
#. You will be asked to create a password. It can be the same as it was previously:
.. figure:: /_static/images/setup/screen5-set_password.png
:width: 60%
#. Your data will now transfer over - the length of this process will vary depending on how much data you have, but will likely take several hours:
.. figure:: /_static/images/setup/screen6-storage_initialize.jpg
:width: 60%
#. You are now ready to proceed and use your Server Pro - it will have the same addresses and root certificate as it did before migrating.
.. figure:: /_static/images/setup/screen7-startfresh_complete.jpg
:width: 60%
.. warning:: Do not unders any circumstances reassemble your Server One without wiping the SD card first and wiping the SSD during initial setup! If you do not this will cause serious problems! If you have lightning channels you could lose all your funds!