mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-04-01 21:13:10 +00:00
fix up navigation
This commit is contained in:
Lucy Cifferello
@@ -0,0 +1,17 @@
|
||||
.. _dg-android:
|
||||
|
||||
=======
|
||||
Android
|
||||
=======
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
------------------------
|
||||
|
||||
`Setup Tor <docs.start9.com/user-manual/configuration/tor-setup/tor-os/tor-android>`_ to run natively (in the background) on your device. This will allow you to use applications on your Android via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
---------------------------------
|
||||
|
||||
`Configure Firefox <docs.start9.com/user-manual/configuration/tor-setup/tor-firefox/torff-android>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
.. note:: Please see Android's :ref:`Known Limitations<lim-android>` to understand what is currently not possible on these devices
|
||||
@@ -0,0 +1,12 @@
|
||||
.. _dg-ios:
|
||||
|
||||
===
|
||||
iOS
|
||||
===
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
-------------------------------------
|
||||
|
||||
`Setup LAN Access <docs.start9.com/user-manual/configuration/lan-setup/lan-ios>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
|
||||
.. note:: Please see iOS's :ref:`Known Limitations<lim-ios>` to understand what is currently not possible on these devices
|
||||
@@ -0,0 +1,22 @@
|
||||
.. _dg-linux:
|
||||
|
||||
============
|
||||
Linux Guides
|
||||
============
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
-------------------------------------
|
||||
|
||||
`Setup LAN Access <docs.start9.com/user-manual/configuration/lan-setup/lan-linux>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
------------------------
|
||||
|
||||
`Setup Tor <docs.start9.com/user-manual/configuration/tor-setup/tor-os/tor-linux>`_ to run natively (in the background) on your device. This will allow you to use applications on your Linux machine via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
---------------------------------
|
||||
|
||||
`Configure Firefox <docs.start9.com/user-manual/configuration/tor-setup/tor-firefox/torff-linux>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
.. note:: Please see Linux's :ref:`Known Limitations<lim-linux>` to understand what is currently not possible on these devices
|
||||
@@ -0,0 +1,22 @@
|
||||
.. _dg-mac:
|
||||
|
||||
===
|
||||
Mac
|
||||
===
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
-------------------------------------
|
||||
|
||||
`Setup LAN Access <docs.start9.com/user-manual/configuration/lan-setup/lan-mac>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
------------------------
|
||||
|
||||
`Setup Tor <docs.start9.com/user-manual/configuration/tor-setup/tor-os/tor-mac>`_ to run natively (in the background) on your device. This will allow you to use applications on your Mac via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
---------------------------------
|
||||
|
||||
`Configure Firefox <docs.start9.com/user-manual/configuration/tor-setup/tor-firefox/torff-mac>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
.. note:: Please see Mac's :ref:`Known Limitations<lim-mac>` to understand what is currently not possible on these devices
|
||||
@@ -0,0 +1,22 @@
|
||||
.. _dg-windows:
|
||||
|
||||
=======
|
||||
Windows
|
||||
=======
|
||||
|
||||
LAN Setup (Connectivity, Performance)
|
||||
-------------------------------------
|
||||
|
||||
`Setup LAN Access <docs.start9.com/user-manual/configuration/lan-setup/lan-windows>`_ for a fast and secure connection while on your Embassy's local network.
|
||||
|
||||
Tor Setup (Connectivity)
|
||||
------------------------
|
||||
|
||||
`Setup Tor <docs.start9.com/user-manual/configuration/tor-setup/tor-os/tor-windows>`_ to run natively (in the background) on your device. This will allow you to use applications on your Windows machine via the :ref:`Tor Network<tor>` so they can communicate with your Embassy.
|
||||
|
||||
Tor Firefox Config (Connectivity)
|
||||
---------------------------------
|
||||
|
||||
`Configure Firefox <docs.start9.com/user-manual/configuration/tor-setup/tor-firefox/torff-windows>`_ to be able to use the :ref:`Tor Network<tor>` so that you can reach ``.onion`` sites without needing to change browsers.
|
||||
|
||||
.. note:: Please see Window's :ref:`Known Limitations<lim-windows>` to understand what is currently not possible on these devices
|
||||
@@ -0,0 +1,14 @@
|
||||
======================
|
||||
Device-Specific Guides
|
||||
======================
|
||||
|
||||
An overview of EmbassyOS general capabilities.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
dg-linux
|
||||
dg-mac
|
||||
dg-windows
|
||||
dg-android
|
||||
dg-ios
|
||||
13
site/source/user-manual/getting-started/index.rst
Normal file
13
site/source/user-manual/getting-started/index.rst
Normal file
@@ -0,0 +1,13 @@
|
||||
===============
|
||||
Getting Started
|
||||
===============
|
||||
|
||||
Take your first steps!
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
introduction
|
||||
purchasing
|
||||
initial-setup
|
||||
device-guides/index
|
||||
68
site/source/user-manual/getting-started/initial-setup.rst
Normal file
68
site/source/user-manual/getting-started/initial-setup.rst
Normal file
@@ -0,0 +1,68 @@
|
||||
.. _initial-setup:
|
||||
|
||||
=============
|
||||
Initial Setup - ***NEEDS COMPACTING / SIMPLIFYING***
|
||||
=============
|
||||
|
||||
.. youtube:: DmTlwp5_zvY
|
||||
|
||||
Power On
|
||||
--------
|
||||
|
||||
1. Connect your Embassy to power and Internet, normally using an ethernet port on your home Internet router.
|
||||
|
||||
.. tip:: To avoid networking issues, it is recommended to use your primary router, not an extender or mesh router.
|
||||
|
||||
2. Plug in your external drive to one of the USB 3.0 (blue) ports on Embassy.
|
||||
|
||||
Embassy will initialize, which may take 10-15min. You will hear 2 distinct sounds:
|
||||
|
||||
* "bep" ‐ Starting up
|
||||
* "chime" ‐ Embassy is ready
|
||||
|
||||
Setup Your Embassy
|
||||
------------------
|
||||
|
||||
1. Ensure the device you are using (desktop/laptop or mobile) is connected to the same network as your router.
|
||||
|
||||
.. 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 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>`.
|
||||
|
||||
3. Create your *permanent* master password and complete setup.
|
||||
|
||||
.. admonition:: Explanation
|
||||
:class: toggle expand
|
||||
|
||||
In this step, the setup process will provide your Embassy with three pieces of critical information:
|
||||
|
||||
* 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 :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. **This one responsibility is the price of sovereignty.**
|
||||
|
||||
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.
|
||||
15
site/source/user-manual/getting-started/introduction.rst
Normal file
15
site/source/user-manual/getting-started/introduction.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
.. _introduction:
|
||||
|
||||
============
|
||||
Introduction
|
||||
============
|
||||
|
||||
:ref:`Embassy<embassy>` is a new kind of personal computer - one that sits quietly on your shelf and runs all day and night. It has no screen and no keyboard. You access your Embassy from anywhere in the world in total, trustless privacy, simply by visiting its unique Tor address (.onion URL) right from the browser.
|
||||
|
||||
Embassy is composed of commonly available hardware components that can be sourced and assembled by anyone, anywhere, for a marginal fee. Embassy is powered by EmbassyOS, the open-source operating system by Start9.
|
||||
|
||||
So, what do you do with your Embassy? You use it to run services: Bitcoin, Lightning, personal cloud storage, P2P messaging, password management, etc. The list of available services is growing quickly and will eventually encompass the entirety of open-source, self-hosted software.
|
||||
|
||||
Every communication between you and your Embassy is end-to-end encrypted and onion routed over the :ref:`Tor network<tor>`. All services are open-source and self-hosted, meaning there are no trusted third parties of any kind.
|
||||
|
||||
To get an Embassy, you can :ref:`purchase<purchasing>` one directly from :ref:`Start9<start9>`, or you can :ref:`build one yourself<diy>`.
|
||||
9
site/source/user-manual/getting-started/purchasing.rst
Normal file
9
site/source/user-manual/getting-started/purchasing.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
.. _purchasing:
|
||||
|
||||
==========
|
||||
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 :ref:`EmbassyOS<embassy-os>`. 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>`.
|
||||
Reference in New Issue
Block a user