This commit is contained in:
kn0wmad
2021-12-09 16:14:11 -07:00
committed by Lucy Cifferello
parent 8f44e2e936
commit 71b8d3a192
7 changed files with 58 additions and 47 deletions

View File

@@ -1,6 +1,15 @@
.. _embassy-os:
*********
=========
EmbassyOS
*********
=========
.. _product-key:
EmbassyOS Product Key
---------------------
Whether you purchase a device, download an image, or build yourself from source, every copy of EmbassyOS has it's own unique Product Key, which is generated with the creation of each EOS image.
If you purchase a device from us, this is printed on the bottom of your Embassy. If you purchase a download, we provide you the key. If you build from source, the key is created during the build.
The first and foremost use of the Product Key is to encrypt data that is sent to Embassy at :ref:`Initial Setup<initial-setup>`. There are several other usecases. Start9 keeps an anonymous database of all Product Keys that have been purchased by us (ZERO additional data is associated) so that we can verify someone is a "paid user." Currently this is just to allow someone to get a new copy of the EOS image if they have a problem, but in future we intend to give added bonuses to customers who have chosen to pay us for a copy of the software.

View File

@@ -6,6 +6,8 @@ Start9 Labs
Start9 Labs is a small, but rapidly growing team of passionate builders. We are based in Denver, Colorado, but have team members around the world.
.. _start9-origin:
"The Origin of “Start9”
=======================

View File

@@ -1,57 +1,39 @@
.. _initial-setup:
*************
=============
Initial Setup
*************
=============
.. youtube:: DmTlwp5_zvY
Power On
========
--------
#. Connect your Embassy to power and Internet, normally using an ethernet port on your home Internet router.
#. Plug in your external drive to one of the USB 3.0 (blue) ports on Embassy.
1. Connect your Embassy to power and Internet, normally using an ethernet port on your home Internet router.
.. note:: To avoid networking issues, it is recommended to use your primary router, not an extender or mesh router.
.. tip:: To avoid networking issues, it is recommended to use your primary router, not an extender or mesh router.
You will hear 2 distinct sounds:
2. Plug in your external drive to one of the USB 3.0 (blue) ports on Embassy.
* "bep" Powering on
Embassy will initialize, which may take 10-15min. You will hear 2 distinct sounds:
* "bep" Starting up
* "chime" Embassy is ready
Claim Your Embassy
==================
Setup Your Embassy
------------------
1. Ensure the device you are using is connected to the same network as your router.
1. Ensure the device you are using (desktop/laptop or mobile) is connected to the same network as your router.
.. warning:: Sometmies a router will have a "guest WiFi network," which might be different than the network your Embassy is placed on via ethernet.
.. caution:: Sometmies a router will have a "guest WiFi network," which might be different than the network your Embassy is placed on via ethernet.
2. Visit ``embassy.local`` from a web browser.
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.
.. 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>`.
.. admonition:: Troubleshooting
:class: toggle expand
#. 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.
#. Confirm you are entering the correct product key.
#. Confirm your device you are using is not connected to a "Guest" network
#. Confirm your device is not using a VPN.
#. Try to refresh the ``embassy.local`` page.
#. Rarely, certain routers do not support mDNS. Please see the "Advanced" tab.
.. admonition:: Advanced
:class: toggle expand
If your router does not support mDNS
* 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 Google 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 setup.
3. Create your *permanent* master password and complete setup.
.. admonition:: Explanation
@@ -59,15 +41,28 @@ Claim Your Embassy
In this step, the setup process will provide your Embassy with three pieces of critical information:
* A ed25519 private key. Used by the Embassy to create a .onion public address for encrypted and anonymous communication over Tor.
* An ed25519 private key. Used by the Embassy to create a .onion public address for encrypted and anonymous communication over Tor.
* A 4096 bit RSA private key. Used by the Embassy to create a SSL certificate for encrypted communication over LAN.
* A master password. Used by the Embassy to authenticate you as its owner.
All three secrets are packaged together and transmitted to the Embassy encrypted with its product key.
All three secrets are packaged together and transmitted to the Embassy encrypted with its :ref:`Product Key<product-key>`.
.. 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.
.. 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.**
Setup Complete!
===============
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.
.. admonition:: Troubleshooting
#. 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.
#. Confirm you are entering the product key correctly and exactly.
#. Confirm your device you are using is not connected to a "Guest" network
#. 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.

View File

@@ -4,6 +4,6 @@
Purchasing
**********
For maximum convenience, you can purchase an Embassy device directly from Start9 through our `Shopify Store <https://store.start9.com>`_. The device comes in a beautiful box, fully-assembled, and pre-installed with the latest version of EmbassyOS. We do our own hardware assembly and fulfillment, and we only collect the minimal information necessary to fulfill your order. And yes, we accept Bitcoin.
For maximum convenience, you can purchase an Embassy device directly from Start9 through our `Shopify Store <https://store.start9.com>`_. The device comes in a beautiful box, fully-assembled, and pre-installed with the latest version of EmbassyOS. We do our own hardware assembly and fulfillment, and we only collect the minimal information necessary to fulfill your order. And yes, we accept Bitcoin, as well as Lightning payments.
If you prefer to build your own Embassy, you can follow the :ref:`DIY Guide <diy>`.

View File

@@ -1,8 +1,8 @@
.. _password:
.. _forgot-password:
***************
===============
Forgot Password
***************
===============
There is currently no way to reset you Embassy master password through a standard UI flow.

View File

@@ -9,7 +9,7 @@ Restart
#. Be patient while services shut down. A *tune* will play, indicating the shutdown is complete.
#. A gentle *bep* will sound when the Embassy is powered back on.
#. A *chime* will sound when the Embassy is ready to use.
#. A *chime* will sound when the Embassy is ready to use. Please be patient as a Restart will take some time.
Shutdown
========

View File

@@ -1,10 +1,15 @@
.. _updating:
******************
==================
Updating EmbassyOS
******************
==================
#. Navigate to ``Menu > Embassy``
.. _update-eos:
Enable Auto Check for Updates
-----------------------------
#. Navigate to the ``Embassy`` tab -> ``Preferences``
#. Click "Check for Updates"
#. If there is an update available, you will be prompted to install it.
#. While updating, your Embassy will emit a gentle chime every 20 seconds.