Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-04-01 21:13:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Many minor updates and screenshots added

Browse Source
This commit is contained in:
kn0wmad
2021-12-17 17:47:25 -07:00
committed by Lucy Cifferello
parent 4c1d6a0e70
commit 01b8dad941
44 changed files with 294 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
site/source/user-manual/getting-started/index.rst
View File

@@ -1,3 +1,5 @@
.. _getting-started:
===============
Getting Started
===============
@@ -10,4 +12,5 @@ Take your first steps!
introduction
purchasing
initial-setup
recover
device-guides/index

57
site/source/user-manual/getting-started/initial-setup.rst
View File

@@ -1,13 +1,15 @@
.. _initial-setup:
=============
Initial Setup - ***NEEDS COMPACTING / SIMPLIFYING***
Initial Setup - ***COMPACT / SIMPLIFY??***
=============
.. youtube:: DmTlwp5_zvY
Connect and Power Up
--------------------
Power On
--------
Check out our quick setup video below, and follow along with the steps in this guide:
.. youtube:: DmTlwp5_zvY
1. Connect your Embassy to power and Internet, normally using an ethernet port on your home Internet router.
@@ -29,12 +31,32 @@ Setup Your Embassy
2. Visit ``embassy.local`` from your web browser. You will be prompted to enter your :ref:`Product Key`. This is found on the bottom side of your device.
.. figure:: /_static/images/setup/setup0.png
:width: 60%
:alt: Enter Product Key
.. admonition:: Explanation
:class: toggle expand
The product key is used to discover your Embassy's IP address on the Local Area Network using a hashing function and a protocol named :ref:`MDNS (or Zeroconf) <mdns>`.
3. Create your *permanent* master password and complete setup.
3. Next, select "Start Fresh" if this is your first time using an Embassy. If you'd like to "Recover" from an existing Embassy, please follow that guide :ref:`here<recover>`.
.. figure:: /_static/images/setup/setup1.png
:width: 60%
:alt: Fresh Install
4. Select your storage drive. You should only have one drive plugged into your Embassy at this time, but always verify it is what you expect before clicking (such as, is it a 1TB drive?)
.. figure:: /_static/images/setup/setup2.png
:width: 60%
:alt: Select Drive
5. Create your *permanent* master password and complete setup.
.. figure:: /_static/images/setup/setup3.png
:width: 60%
:alt: Enter a New Password
.. admonition:: Explanation
:class: toggle expand
@@ -49,13 +71,27 @@ Setup Your Embassy
.. warning:: There is also currently no way to change your password. Choose a strong master password. Write it down. Store it somewhere safe. DO NOT LOSE IT. If you lose this password, you may be forced to reset the device, resulting in permanent loss of data. **This one responsibility is the price of sovereignty.**
6. That's it!
.. figure:: /_static/images/setup/setup4.png
:width: 60%
:alt: Setup Complete
Your Embassy is now hosted on the private web! After setup is complete you will be presented with connection information. You can view and manage your Embassy by visiting its unique Tor Address from any Tor-enabled browser, or by accessing it's ``.local`` address from your LAN (see :ref:`LAN Setup<lan-setup>` for assistance).
Enjoy!
------
Your Embassy is now hosted on the private web! After setup is complete you will be presented with connection information. You can view and manage your Embassy by visiting its unique Tor Address from any Tor-enabled browser, or by accessing it's ``.local`` address from your LAN.
.. figure:: /_static/images/setup/setup5.png
:width: 60%
:alt: Fresh Embassy
Upon accessing your Embassy for the first time, you will be greeted with an empty Services page. Start9 firmly believe that the only software that should be on your device is the software you choose to be on there. So go ahead and visit the Marketplace to get your first Service!!
.. admonition:: Troubleshooting
Troubleshooting
---------------
Try these steps if you have any issues with setup.
#. Confirm that the Embassy is plugged into both power and Ethernet, with the USB drive in a USB 3.0 (blue) slot.
#. Confirm the Embassy emitted two sounds when powering on: a bep and a chime.
@@ -64,5 +100,8 @@ Your Embassy is now hosted on the private web! After setup is complete you will
#. Confirm your device is not using a VPN.
#. Try to refresh the ``embassy.local`` page.
#. Very rarely, a router may not support mDNS. In this case:
* On your desktop or laptop computer, navigate to your router configuration settings within the browser. This is usually an IP address such as 192.168.1.1. A simple web search will usually reveal how to access the router configuration settings for a particular brand.
* Once in the router config settings, find the section that lists the devices on your network. You should see an item labeled "embassy". Take note of the associated IP address and enter it into your browser's URL field to enter the setup.
- On your desktop or laptop computer, navigate to your router configuration settings within the browser. This is usually an IP address such as 192.168.1.1. A simple web search will usually reveal how to access the router configuration settings for a particular brand.
- Once in the router config settings, find the section that lists the devices on your network. You should see an item labeled "embassy". Take note of the associated IP address and enter it into your browser's URL field to enter the setup.
If you are still having issues, please reach out to us for :ref:`Assistance<contact>`.

15
site/source/user-manual/getting-started/recover.rst Normal file
View File

@@ -0,0 +1,15 @@
.. _recover:
===============
Recover Embassy
===============
.. _recover-02x:
Recover Embassy from version series 0.2.x
-----------------------------------------
.. _recover-03x:
Recover Embassy from Version Series 0.3.x
-----------------------------------------