mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-30 12:11:57 +00:00
reorganize and make room for DIY
This commit is contained in:
Matt Hill
37
source/user-manuals/embassyos/connecting.rst
Normal file
37
source/user-manuals/embassyos/connecting.rst
Normal file
@@ -0,0 +1,37 @@
|
||||
.. _connecting:
|
||||
|
||||
**********
|
||||
Connecting
|
||||
**********
|
||||
|
||||
With the :ref:`initial-setup` complete, your Embassy is now privately hosted on the Internet and can be accessed right from the browsers. Your Embassy's addresses (its Tor and LAN URLs) are completely private; no one else even knows they exists.
|
||||
|
||||
If you accidentally leak your Embassy's addresses, do not worry. You Embassy is also protected by your password; so only you can log in.
|
||||
|
||||
|
||||
Tor
|
||||
===
|
||||
|
||||
Connecting to your Embassy over :ref:`tor` requires using a browser that supports *.onion* URLs.
|
||||
|
||||
Currently, Tor is the default and our recommended approach for most users. It *just works*. The one drawback, however, is latency; onion-routed communications over Tor can be slow. For a lightning fast experience, you can connect to your Embassy over LAN (below), but this requires additional setup.
|
||||
|
||||
Below are a list of our recommended browsers for Tor:
|
||||
|
||||
* `Start9 Consulate <https://apps.apple.com/us/app/consulate/id1528124570>`_ (iOS)
|
||||
* `Firefox <https://mozilla.org/firefox/new/>`_ (Mac, Windows, Linux)
|
||||
* `Firefox Beta <https://play.google.com/store/apps/details?id=org.mozilla.firefox_beta>`_ (Android)
|
||||
* `Tor Browser <https://torproject.org/download/>`_ (Mac, Windows, Linux, Android)
|
||||
* `Brave <https://brave.com/>`_ (Mac, Windows, Linux)
|
||||
|
||||
.. seealso:: `Setting up Firefox to handle Tor addresses <https://medium.com/@start9labs/setting-up-your-firefox-web-browser-to-handle-onion-urls-b805391726e4>`_
|
||||
|
||||
.. seealso:: `Announcing the Consulate Browser! <https://medium.com/@start9labs/announcing-the-consulate-browser-76d94a8599cb>`_
|
||||
|
||||
|
||||
LAN
|
||||
===
|
||||
|
||||
Connecting to your Embassy over :ref:`lan` has the benefit of being fast! It requires that your are connected to your home network and using a browser that supports *.local* URLs, which is true for most browsers.
|
||||
|
||||
.. seealso:: :ref:`Installing and trusting your Embassy's Root Certificate Authority SSL<ssl-setup>`
|
||||
@@ -2,10 +2,7 @@
|
||||
General
|
||||
*******
|
||||
|
||||
An overview of EmbassyOS general capabilities.
|
||||
|
||||
Features
|
||||
========
|
||||
An overview of EmbassyOS general capabilities.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
@@ -2,19 +2,10 @@
|
||||
EmbassyOS
|
||||
*********
|
||||
|
||||
You can view and manage your Embassy inside the "Embassy" tab in the main menu.
|
||||
|
||||
.. figure:: /_static/images/embassy_tab.png
|
||||
:width: 90%
|
||||
:alt: Embassy Menu Tab
|
||||
|
||||
Embassy tab
|
||||
|
||||
Features
|
||||
========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
initial-setup
|
||||
connecting
|
||||
general/index
|
||||
using-services/index
|
||||
74
source/user-manuals/embassyos/initial-setup.rst
Normal file
74
source/user-manuals/embassyos/initial-setup.rst
Normal file
@@ -0,0 +1,74 @@
|
||||
.. _initial-setup:
|
||||
|
||||
*************
|
||||
Initial Setup
|
||||
*************
|
||||
|
||||
Download the Setup App
|
||||
======================
|
||||
|
||||
`App Store <https://apps.apple.com/us/app/start9-setup-app/id1528125889>`_
|
||||
|
||||
`Google Play <https://play.google.com/store/apps/details?id=com.start9labs.setup>`_
|
||||
|
||||
Power On
|
||||
========
|
||||
|
||||
Connect your Embassy to power and Ethernet.
|
||||
|
||||
.. note:: to avoid networking issues, it is recommended to use your primary router, not an extender or mesh router.
|
||||
|
||||
You will hear 2 distinct sounds:
|
||||
|
||||
* "bep" ‐ Powering on
|
||||
* "chime" ‐ Embassy is ready
|
||||
|
||||
Claim Your Embassy
|
||||
==================
|
||||
|
||||
1. Ensure your phone is connected to the same WiFi network as your router.
|
||||
|
||||
2. Inside the Setup App, enter the product key located on the bottom of your Embassy
|
||||
|
||||
.. 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 MDNS (or Zeroconf). Once in possession of the Embassy's local IP address, the Setup App can now communicate directly with the Embassy.
|
||||
|
||||
.. admonition:: Troubleshooting
|
||||
:class: toggle expand
|
||||
|
||||
#. Confirm that the Embassy is plugged into both power and Ethernet.
|
||||
#. Confirm the Embassy emitted two sounds when powering on: a bep and a chime.
|
||||
#. Confirm you are entering the correct product key.
|
||||
#. Confirm your phone is not using a VPN.
|
||||
#. Close and reopen the Setup App and try again.
|
||||
#. 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 "start9labs". Take note of the associated IP address and enter it into the Setup App in the "LAN IP Address" input field.
|
||||
|
||||
3. Create your *permanent* master password and complete setup.
|
||||
|
||||
.. admonition:: Explanation
|
||||
:class: toggle expand
|
||||
|
||||
In this step, the Setup App 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.
|
||||
* 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.
|
||||
|
||||
.. 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.
|
||||
|
||||
Setup Complete!
|
||||
===============
|
||||
|
||||
Your Embassy is now hosted on the private web. You can view and manage your Embassy by visiting its unique Tor Address from any Tor-enabled browser. The Setup App contains our recommendations for various devices.
|
||||
@@ -6,9 +6,6 @@ Services are self-hosted, open source projects made compatible for EmbassyOS. Ea
|
||||
|
||||
.. note:: Some services require configuration before starting up. You can only connect to and use a service once it is in a *running* state.
|
||||
|
||||
Features
|
||||
========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
||||
Reference in New Issue
Block a user