diff --git a/site/source/_static/images/flashing/factory-reset.png b/site/source/_static/images/flashing/factory-reset.png new file mode 100644 index 0000000..d3bb4dd Binary files /dev/null and b/site/source/_static/images/flashing/factory-reset.png differ diff --git a/site/source/user-manual/index.rst b/site/source/user-manual/index.rst index 6e1a5ad..210487d 100644 --- a/site/source/user-manual/index.rst +++ b/site/source/user-manual/index.rst @@ -8,7 +8,7 @@ User Manual :includehidden: :maxdepth: 2 - initial-setup + initial-setup/index trust-ca connecting-lan connecting-tor diff --git a/site/source/user-manual/initial-setup.rst b/site/source/user-manual/initial-setup.rst deleted file mode 100644 index 929fe81..0000000 --- a/site/source/user-manual/initial-setup.rst +++ /dev/null @@ -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 ` - - :ref:`Transfer ` - - :ref:`Restore from Backup ` - -.. _setup-troubleshooting: - -Troubleshooting ---------------- -If you followed the above instructions and are experiencing issues, click :ref:`here ` to resolve. - -You can also to `reach out to support `_ if you need a hand. diff --git a/site/source/user-manual/initial-setup/index.rst b/site/source/user-manual/initial-setup/index.rst new file mode 100644 index 0000000..6729808 --- /dev/null +++ b/site/source/user-manual/initial-setup/index.rst @@ -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 \ No newline at end of file diff --git a/site/source/user-manual/initial-setup/initial-setup-recovery.rst b/site/source/user-manual/initial-setup/initial-setup-recovery.rst new file mode 100644 index 0000000..67e3e97 --- /dev/null +++ b/site/source/user-manual/initial-setup/initial-setup-recovery.rst @@ -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 ` + - :ref:`Transfer ` + + +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 ` + + + diff --git a/site/source/user-manual/initial-setup/initial-setup-start-fresh.rst b/site/source/user-manual/initial-setup/initial-setup-start-fresh.rst new file mode 100644 index 0000000..5d1fc8f --- /dev/null +++ b/site/source/user-manual/initial-setup/initial-setup-start-fresh.rst @@ -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 `, 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 ` to resolve. + +You can also to `reach out to support `_ if you need a hand.