Merge pull request #623 from Start9Labs/update/initial_setup_reforms

Update/initial setup reforms
This commit is contained in:
StuPleb
2024-07-09 18:43:50 +02:00
committed by GitHub
6 changed files with 103 additions and 36 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

View File

@@ -8,7 +8,7 @@ User Manual
:includehidden:
:maxdepth: 2
initial-setup
initial-setup/index
trust-ca
connecting-lan
connecting-tor

View File

@@ -1,35 +0,0 @@
.. _initial-setup:
=============
Initial Setup
=============
.. _fresh-setup:
Starting Fresh
--------------
#. Connect your server to power and ethernet.
#. From a client device (desktop/laptop/phone) connected to the same local network as your server, open a browser and visit ``http://start.local``.
.. note:: If you are `not` using a Raspberry Pi, you can also plug a monitor and keyboard into the server. This is known as "Kiosk mode".
#. 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
---------------
If you followed the above instructions and are experiencing issues, click :ref:`here <setup-troubleshoot>` to resolve.
You can also to `reach out to support <https://start9.com/contact>`_ if you need a hand.

View File

@@ -0,0 +1,13 @@
.. _initial-setup:
===============================
Getting Started - Initial Setup
===============================
A self-hosting experience with StartOS begins with setting up your server for the first time or by wiping an existing server to completely start over. For both of these options, choose `Start Fresh`. To transfer existing server data to a new machine or a new disk, or to perform a disaster recovery from backups, choose `Recovery Options`.
.. toctree::
:maxdepth: 1
initial-setup-start-fresh
initial-setup-recovery

View File

@@ -0,0 +1,28 @@
.. _initial-setup-recovery:
================
Recovery Options
================
.. contents::
:depth: 2
:local:
Keeping existing data
---------------------
These options assume you have a working StartOS device or data disk containing StartOS services and configurations that you want to use as the source for your new server.
- :ref:`Use Existing Drive <attach-drive>`
- :ref:`Transfer <transfer-data>`
Emergency Restore from Backup
-----------------------------
This option assumes that disaster has struck and your only copy of your StartOS services are backups taken through StartOS.
- :ref:`Restore from Backup <backup-restore>`

View File

@@ -0,0 +1,61 @@
.. _initial-setup-starting-fresh:
=============
Start Fresh
=============
.. contents::
:depth: 2
:local:
Set up a new server
-----------------------
The video below demonstrations how to set up a newly purchased Start9 server. If you are familar with the process or you have recently :ref:`flashed <_flashing>` an existing server, you may want to skip the video and scroll down straight to Step 1.
.. youtube:: DzikmY4S42Y
:width: 95%
**First Steps**
#. Connect your server to power and ethernet.
#. From a client device (desktop/laptop/phone) connected to the same local network as your server, open a browser and visit ``http://start.local``.
.. note:: If you are `not` using a Raspberry Pi, you can also plug a monitor and keyboard into the server. This is known as "Kiosk mode" but is not recommedend for general use.
#. Follow the on-screen instructions.
_________
Start Over
--------------
To `Factory Reset` an existing server, you must first go through the flashing process to reinstall StartOS.
#. Flash your device with a fresh install of StartOS by following the :ref:`flashing guides <flashing>`, making sure to select `Factory Reset` when booting from external media.
.. note:: On a Raspberry Pi you will simply flash the microSD card and reinsert it, connect to power and skip to step 3.
.. figure:: /_static/images/flashing/factory-reset.png
:width: 55%
#. After install is complete, you will be prompted to remove your externally connected USB drive you used with Balena Etcher and restart.
#. From a client device (desktop/laptop/phone) connected to the same local network as your server, open a browser and visit ``http://start.local``.
#. Choose `Start Fresh` and follow the on-screen instructions.
_________
Troubleshooting
---------------
If you followed the above instructions and are experiencing issues, click :ref:`here <setup-troubleshoot>` to resolve.
You can also to `reach out to support <https://start9.com/contact>`_ if you need a hand.