mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 10:21:53 +00:00
first sweep
This commit is contained in:
Matt Hill
@@ -1,51 +0,0 @@
|
||||
.. _connect:
|
||||
|
||||
Connecting to the Embassy
|
||||
=========================
|
||||
|
||||
WiFi
|
||||
----
|
||||
|
||||
Once the Embassy has been setup while connected to the router, it can be configured to be accessible only from a wireless network. This option can be found in the `Embassy` tab in the dashboard menu under `WiFi`. From here, the desired wireless network credentials can be entered by selecting the (+) sign in the lower right hand corner. Either `save` to persist the network for later use, or `save and connect` to immediately use the provided network.
|
||||
|
||||
.. seealso:: :ref:`connecting-wifi`
|
||||
|
||||
After successfully connected to a configured WiFi network, the Embassy can be unplugged from the router and relocated anywhere it's power supply can reach.
|
||||
|
||||
.. _browser-access:
|
||||
|
||||
Browser
|
||||
-------
|
||||
|
||||
The Embassy dashboard can be accessed in two distinct ways:
|
||||
|
||||
#. By visiting the Tor address in a Tor enabled browser. You can visit it from anywhere in the world via the Tor network. Please be advised that the Tor network is censored in some places.
|
||||
|
||||
Depending on your device operating system and browser preference, there exists several methods for reaching the Embassy dashboard:
|
||||
|
||||
|
||||
* MacOS / Windows:
|
||||
|
||||
Any browser that supports Tor (ie. a SOCKS5 proxy), such as:
|
||||
|
||||
* A private window with Tor in `Brave <https://brave.com/>`_
|
||||
* The `Tor Browser <https://www.torproject.org/download/>`_
|
||||
* `Firefox <https://www.mozilla.org/en-US/firefox/mobile/>`_
|
||||
|
||||
.. seealso:: `Setting up Firefox to handle Tor addresses <https://medium.com/@start9labs/setting-up-your-firefox-web-browser-to-handle-onion-urls-b805391726e4>`_
|
||||
|
||||
* iOS
|
||||
Download the Consulate `app <https://apps.apple.com/us/app/consulate/id1528124570>`_ in the Apple App Store.
|
||||
|
||||
.. seealso:: `Announcing the Consulate Browser! <https://medium.com/@start9labs/announcing-the-consulate-browser-76d94a8599cb>`_
|
||||
|
||||
* Android
|
||||
Download the `Tor Browser <https://www.torproject.org/download/>`_
|
||||
`Firefox <https://www.mozilla.org/en-US/firefox/mobile/>`_
|
||||
|
||||
.. seealso:: `Setting up Firefox to handle Tor addresses on Android <https://medium.com/@start9labs/setting-up-your-firefox-web-browser-to-handle-onion-urls-android-65b36801c0d2>`_
|
||||
|
||||
* FDroid
|
||||
Coming Soon!
|
||||
|
||||
#. This option is considered an **advanced** feature. By visiting the local address after setting up a SSL certificate on the Embassy. This means that the remote device and Embassy server must be in physical proximity and connected to the same WiFi network in order to communicate. Once this is setup, the Embassy can be accessed from any browser while on the Local Area Network (LAN) with little latency and with no extra configuration options needed.
|
||||
36
source/getting-started/connecting.rst
Normal file
36
source/getting-started/connecting.rst
Normal file
@@ -0,0 +1,36 @@
|
||||
.. _connecting:
|
||||
|
||||
**********
|
||||
Connecting
|
||||
**********
|
||||
|
||||
With the :ref:`initial-setup` complete, your Embassy is now privately hosted on the Internet and can be accessed right from the borwser. 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 uing 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, Android)
|
||||
* `Tor Browser <https://torproject.org/download/>`_ (Mac, Windows, Linux, Android)
|
||||
* `Brave <https://brave.com/>`_ (Mac, Windows, Linux, Android)
|
||||
|
||||
.. 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 uing a browser that supports *.local* URLs, which is true for most browsers.
|
||||
|
||||
This option is considered *advanced*, since it requires :ref:`installing and trusting your Embassy's Root Certificate Authority SSL<ssl-setup>` on any phone or laptop you use to connect.
|
||||
@@ -1,11 +0,0 @@
|
||||
.. _dashboard:
|
||||
|
||||
Accessing dashboard
|
||||
-------------------
|
||||
|
||||
Acquire your Tor address from the Setup App. Plug it into the URL bar of any Tor enabled browser. Login using the master password supplied during the setup process.
|
||||
|
||||
.. seealso:: :ref:`connect`
|
||||
|
||||
|
||||
After you are logged into your dashboard (link), navigate to the Marketplace tab from the menu. Here, you can view the services available to download. Once downloaded, you can view these in the Services tab in the menu.
|
||||
11
source/getting-started/initial-setup.rst
Normal file
11
source/getting-started/initial-setup.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
.. _initial-setup:
|
||||
|
||||
*************
|
||||
Initial Setup
|
||||
*************
|
||||
|
||||
Ensure your phone is connected to the same WiFi network as your router.
|
||||
|
||||
Visit the appropriate setup instructions for your version:
|
||||
|
||||
`Setup0.2.x <https://start9labs.com/devices/embassy/setup?version=0.2.0>`_
|
||||
@@ -1,8 +0,0 @@
|
||||
.. _marketplace:
|
||||
|
||||
Exploring Services in Marketplace
|
||||
---------------------------------
|
||||
|
||||
The Start9 Marketplace currently hosts the available service to install on your Embassy. Soon, any developer will be able to submit a service to this marketplace for review. Submitted services will follow our :ref:`sdk` Guide to conform to the standards necessary for Embassy software services to run.
|
||||
|
||||
The review will consist of code review (we want services to work very well), user experience testing acceptance (we want services to be a dead simple and pleasant experience), documentation of instructions (we want it to be clear to users and developers how to run and contribute), and a security vulnerability audit (we want to prevent any malware being installed).
|
||||
@@ -1,12 +0,0 @@
|
||||
.. _setup-guide:
|
||||
|
||||
Setup Guide
|
||||
===========
|
||||
|
||||
Ensure your phone is connected to the same WiFi network as your router.
|
||||
|
||||
Visit the appropriate setup instructions for your version:
|
||||
|
||||
`Setup0.2.x <https://start9labs.com/devices/embassy/setup?version=0.2.0>`_
|
||||
|
||||
After completing the above guide, it no longer matters if the device and Embassy WiFi network differ - the Embassy can be reached anywhere in the world using its Tor address in a Tor enabled browser. :ref:`post-setup`
|
||||
@@ -1,8 +0,0 @@
|
||||
.. _unboxing:
|
||||
|
||||
Unboxing the Embassy
|
||||
====================
|
||||
|
||||
We have strived to create a “batteries included” product, so the box you receive includes all necessary components to run and backup your Embassy. The included brochure diagram demonstrates how to plug in the device for initial setup. Scanning the brochure QR code will redirect to the setup instructions for your Embassy OS version.
|
||||
|
||||
The included USB stick can be used for service backups right out of the box. Simply plug it into the Embassy and navigate to the desired service you want to back up from the `Services` tab in the dashboard menu.
|
||||
Reference in New Issue
Block a user