reorganize

This commit is contained in:
Matt Hill
2021-01-09 10:35:31 -07:00
parent da26607f03
commit e60f4157ee
44 changed files with 128 additions and 149 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

View File

@@ -10,4 +10,4 @@ So what do you do with your Embassy? You use it to run services: Bitcoin, Lightn
Every communication between you and your Embassy is end-to-end encrypted and onion routed over the Tor network. All services are open-source and self-hosted, meaning there are no trusted third parties of any kind. Every communication between you and your Embassy is end-to-end encrypted and onion routed over the Tor network. 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<purchase>` one directly from Start9 Labs, or you can :ref:`build one yourself<diy>`. To get an Embassy, you can :ref:`purchase<purchasing>` one directly from Start9 Labs, or you can :ref:`build one yourself<diy>`.

View File

@@ -1,7 +0,0 @@
.. _purchase:
********
Purchase
********
For maximum convenience, you can buy an Embassy directly from Start9 Labs through our `Shopify Store <https://store.start9labs.com>`_. The device comes fully-assembled and pre-installed with the latest version of EmbassyOS. We do its own hardware assembly and fulfillment, and we only collect the minimal information necessary to fulfil your order. And yes, we accept Bitcoin.

View File

@@ -0,0 +1,9 @@
.. _purchasing:
**********
Purchasing
**********
For maximum convenience, you can purchase an Embassy device directly from Start9 Labs through our `Shopify Store <https://store.start9labs.com>`_. The device comes in a beutiful 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.
If you prefer to build your own Embassy, you can follow the :ref:`DIY Guide <diy>`.

View File

@@ -11,16 +11,25 @@ Here you will find guidance and information about the Start9 Embassy personal se
:caption: Getting Started :caption: Getting Started
getting-started/introduction getting-started/introduction
getting-started/purchase getting-started/purchasing
getting-started/diy getting-started/diy
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: User Manuals :caption: User Manual
user-manuals/embassyos/index user-manual/initial-setup
user-manuals/available-services/index user-manual/connecting
user-manuals/tor/index user-manual/general/index
user-manual/managing-services/index
.. toctree::
:maxdepth: 2
:caption: Misc Guides
misc-guides/available-services
misc-guides/tor-os/index
misc-guides/tor-firefox/index
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

View File

@@ -4,7 +4,7 @@
Available Services Available Services
****************** ******************
A list of currently released services for EmbassyOS. Links to the wrapper repository that contains advanced instructions and integration guides. A list of currently-available services for the Embassy.
Bitcoin-related services Bitcoin-related services
======================== ========================
@@ -20,6 +20,6 @@ Other services
============== ==============
* `Bitwarden <https://github.com/Start9Labs/bitwarden-wrapper/tree/master/docs>`_ * `Bitwarden <https://github.com/Start9Labs/bitwarden-wrapper/tree/master/docs>`_
* `Burn After Reading <https://github.com/Start9Labs/burn-after-reading>`_
* `Cups <https://github.com/Start9Labs/cups-wrapper/tree/master/docs>`_ * `Cups <https://github.com/Start9Labs/cups-wrapper/tree/master/docs>`_
* `File Browser <https://github.com/Start9Labs/filebrowser-wrapper/tree/master/docs>`_ * `File Browser <https://github.com/Start9Labs/filebrowser-wrapper/tree/master/docs>`_
* `Burn After Reading <https://github.com/Start9Labs/burn-after-reading>`_

View File

@@ -11,32 +11,36 @@ Once Tor is setup on your system, you can proceed to setup Firefox.
Download `Firefox Beta <https://play.google.com/store/apps/details?id=org.mozilla.firefox_beta>`_ from the Play Store, or Fennec for F-Droid. Download `Firefox Beta <https://play.google.com/store/apps/details?id=org.mozilla.firefox_beta>`_ from the Play Store, or Fennec for F-Droid.
Now, you need to download a `Proxy Auto Config` file that will use Orbot to resolve :code:`.onion` URLs. We have one hosted `here <https://registry.start9labs.com/sys/proxy.pac>`_. Now, you need to download a `Proxy Auto Config` file that will use Orbot to resolve `.onion` URLs. We have one hosted `here <https://registry.start9labs.com/sys/proxy.pac>`_.
Next, navigate to :code:`about:config` in the Firefox URL bar, like so: Next, navigate to ``about:config`` in the Firefox URL bar:
.. figure:: /_static/images/tor/about_config.png .. figure:: /_static/images/tor/about_config.png
:width: 80% :width: 80%
:alt: Firefox about config :alt: Firefox about config
You are going to have to change a few options in here. First, type ``network.proxy.type`` into the search bar, and set the value to ``"2"``: You are going to have to change a few options in here. First, type ``network.proxy.type`` into the search bar, and set the value to ``2``:
.. figure:: /_static/images/tor/network_proxy_type.png .. figure:: /_static/images/tor/network_proxy_type.png
:width: 80% :width: 80%
:alt: Firefox network proxy type setting screenshot :alt: Firefox network proxy type setting screenshot
Then, search for ``network.proxy.autoconfig_url``, and set the value to ``"file:///storage/emulated/0/Download/proxy.pac"``: Then, search for ``network.proxy.autoconfig_url``, and set the value to ``file:///storage/emulated/0/Download/proxy.pac``:
.. figure:: /_static/images/tor/autoconfig_url.png .. figure:: /_static/images/tor/autoconfig_url.png
:width: 80% :width: 80%
:alt: Firefox autoconfig url setting screenshot :alt: Firefox autoconfig url setting screenshot
Next, search for ``network.proxy.socks_remote_dns``, and set the value to ``"true"``: Next, search for ``network.proxy.socks_remote_dns``, and set the value to ``true``:
.. figure:: /_static/images/tor/socks_remote_dns.png .. figure:: /_static/images/tor/socks_remote_dns.png
:width: 80% :width: 80%
:alt: Firefox socks remote dns setting screenshot :alt: Firefox socks remote dns setting screenshot
Finally, search for ``dom.securecontext.whitelist_onions``, and set the value to ``"true"``: Next, search for ``dom.securecontext.whitelist_onions`` and set the value to ``true``.
Restart Firefox, and youre all set! You should now be able to navigate to :code:`.onion` URLs in Firefox. This means you can bookmark Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Password Manager <https://play.google.com/store/apps/details?id=com.x8bit.bitwarden&hl=en_US&gl=US>`_ native application. .. figure:: /_static/images/tor/firefox_whitelist_mobile.png
:width: 80%
:alt: Firefox whitelist onions screenshot
Restart Firefox, and youre all set! You should now be able to navigate to `.onion` URLs in Firefox. This means you can bookmark Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Password Manager <https://play.google.com/store/apps/details?id=com.x8bit.bitwarden&hl=en_US&gl=US>`_ native application.

View File

@@ -0,0 +1,16 @@
***************************
Configuring Firefox for Tor
***************************
.. warning::
This guide assumes you are already :ref:`running Tor on your phone or computer<running-tor>`.
Once you have completed the above guide, select your device's operating system below:
.. toctree::
:maxdepth: 1
MacOS <mac>
Windows <windows>
Linux <linux>
Android <android>

View File

@@ -7,7 +7,15 @@ Setting up Firefox with Tor on Linux
.. warning:: .. warning::
This guide assumes you have completed :ref:`setting up Tor for Linux<tor-linux>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor. This guide assumes you have completed :ref:`setting up Tor for Linux<tor-linux>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor.
Once Tor is setup on your system, you can proceed to setup Firefox. Open Firefox.
Enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings.
Search for ``dom.securecontext.whitelist_onions`` and set the value to ``true``.
.. figure:: /_static/images/tor/firefox_whitelist.png
:width: 80%
:alt: Firefox whitelist onions screenshot
Next, in order to tell Firefox which urls to use Tor for, you need a `Proxy Auto Config` file. We have one hosted `here <https://registry.start9labs.com/sys/proxy.pac>`_. To get it, you can run: Next, in order to tell Firefox which urls to use Tor for, you need a `Proxy Auto Config` file. We have one hosted `here <https://registry.start9labs.com/sys/proxy.pac>`_. To get it, you can run:
@@ -41,6 +49,6 @@ Then, check the box labeled `Proxy DNS when using SOCKS v5`:
:width: 80% :width: 80%
:alt: Firefox proxy settings screenshot :alt: Firefox proxy settings screenshot
Click :code:`OK` and then restart Firefox for the changes to take effect. Click ``OK`` and then restart Firefox for the changes to take effect.
Now youre all set! You should now be able to navigate to :code:`.onion` URLs in Firefox. This means you can bookmark Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Firefox Plugin <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_. Now youre all set! You should now be able to navigate to `.onion` URLs in Firefox. This means you can bookmark Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Firefox Plugin <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_.

View File

@@ -7,9 +7,19 @@ Setting up Firefox with Tor on MacOS
.. warning:: .. warning::
This guide assumes you have completed :ref:`setting up Tor for MacOS<tor-mac>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor. This guide assumes you have completed :ref:`setting up Tor for MacOS<tor-mac>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor.
Once Tor is setup on your system, you can proceed to setup Firefox. Open Firefox.
In order to tell Firefox which URLs to use Tor for, you need a `Proxy Auto Config` file. We have one hosted `here <https://registry.start9labs.com/sys/proxy.pac>`_. To get it, run: Enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings.
Search for ``dom.securecontext.whitelist_onions`` and set the value to ``true``.
.. figure:: /_static/images/tor/firefox_whitelist.png
:width: 80%
:alt: Firefox whitelist onions screenshot
Now, open the `Terminal` App on your Mac. You can find it in your list of Applications.
In order to tell Firefox which URLs to use Tor for, you need a `Proxy Auto Config` file. We have one hosted `here <https://registry.start9labs.com/sys/proxy.pac>`_. To get it, enter into the terminal:
.. code-block:: .. code-block::
@@ -47,6 +57,6 @@ Then, check the box labeled `Proxy DNS when using SOCKS v5`:
:width: 80% :width: 80%
:alt: Firefox proxy settings screenshot :alt: Firefox proxy settings screenshot
Click :code:`OK` and then restart Firefox for the changes to take effect. Click ``OK`` and then restart Firefox for the changes to take effect.
Now youre all set! You should now be able to navigate to :code:`.onion` URLs in Firefox. This means you can bookmark Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Firefox Plugin <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_. Now youre all set! You should now be able to navigate to `.onion` URLs in Firefox. This means you can bookmark Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Firefox Plugin <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_.

View File

@@ -7,7 +7,15 @@ Setting up Firefox with Tor on Windows
.. warning:: .. warning::
This guide assumes you have completed :ref:`setting up Tor for Windows<tor-windows>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor. This guide assumes you have completed :ref:`setting up Tor for Windows<tor-windows>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor.
Once Tor is setup on your system, you can proceed to setup Firefox. Open Firefox.
Enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings.
Search for ``dom.securecontext.whitelist_onions`` and set the value to ``true``.
.. figure:: /_static/images/tor/firefox_whitelist.png
:width: 80%
:alt: Firefox whitelist onions screenshot
Now, you need to download a `Proxy Auto Config` file that will use the Tor service to resolve .onion urls. We have one hosted `here <https://registry.start9labs.com/sys/proxy.pac>`_. Save it somewhere you wont delete it. For this example: Now, you need to download a `Proxy Auto Config` file that will use the Tor service to resolve .onion urls. We have one hosted `here <https://registry.start9labs.com/sys/proxy.pac>`_. Save it somewhere you wont delete it. For this example:
@@ -29,7 +37,7 @@ Search for the term “proxy” in the search bar in the upper right, then selec
:width: 80% :width: 80%
:alt: Firefox search screenshot :alt: Firefox search screenshot
This should open a menu that will allow you to configure your proxy settings. Select `Automatic proxy configuration URL` and paste in the path to your PAC file from earlier, prefixed with ``"file://"``. For example: This should open a menu that will allow you to configure your proxy settings. Select `Automatic proxy configuration URL` and paste in the path to your PAC file from earlier, prefixed with ``file://``. For example:
.. code-block:: .. code-block::
@@ -41,6 +49,6 @@ Then, check the box labeled `Proxy DNS when using SOCKS v5`:
:width: 80% :width: 80%
:alt: Firefox proxy settings screenshot :alt: Firefox proxy settings screenshot
Click :code:`OK` and then restart Firefox for the changes to take effect. Click ``OK`` and then restart Firefox for the changes to take effect.
Now youre all set! You should now be able to navigate to :code:`.onion` URLs in Firefox. This means you can bookmark Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Firefox Plugin <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_. Now youre all set! You should now be able to navigate to `.onion` URLs in Firefox. This means you can bookmark Cups Messenger, and use your Bitwarden Tor address in the `Bitwarden Firefox Plugin <https://addons.mozilla.org/en-US/firefox/addon/bitwarden-password-manager/>`_.

View File

@@ -1,11 +1,11 @@
.. _tor-android: .. _tor-android:
************************* **********************
Setting up Tor on Android Running Tor on Android
************************* **********************
.. warning:: .. warning::
Custom proxies are now only available in Firefox `Beta <https://play.google.com/store/apps/details?id=org.mozilla.firefox_beta&hl=en_US&gl=US>`_ or `Nightly <https://play.google.com/store/apps/details?id=org.mozilla.fenix&hl=en_US&gl=US>`_ due to a breaking change by the Firefox team. Custom proxies are now only available in `Firefox Beta <https://play.google.com/store/apps/details?id=org.mozilla.firefox_beta&hl=en_US&gl=US>`_ or `Firefox Nightly <https://play.google.com/store/apps/details?id=org.mozilla.fenix&hl=en_US&gl=US>`_ due to a breaking change by the Firefox team.
First, install the Tor proxy service to your system. To do so, open the play store and download `Orbot <https://play.google.com/store/apps/details?id=org.torproject.android>`_. Once you have done so, launch Orbot. First, install the Tor proxy service to your system. To do so, open the play store and download `Orbot <https://play.google.com/store/apps/details?id=org.torproject.android>`_. Once you have done so, launch Orbot.
@@ -42,7 +42,7 @@ Orbot's VPN mode allows certain applications to utilize it's Tor service.
This process also applies for GrapheneOS. This process also applies for GrapheneOS.
To setup, first disable Private DNS on your device. To do so, navigate to: :code:`Settings > Network & Internet > Advanced > Private DNS > Off` To setup, first disable Private DNS on your device. To do so, navigate to: ``Settings > Network & Internet > Advanced > Private DNS > Off``
.. figure:: /_static/images/tor/private_dns_off.png .. figure:: /_static/images/tor/private_dns_off.png
:width: 80% :width: 80%

View File

@@ -0,0 +1,17 @@
.. _running-tor:
*************************************
Running Tor on Your Phone or Computer
*************************************
Running Tor on your phone or computer enables apps that are not Tor-enabled to communicate over Tor.
Select your operating system to get started:
.. toctree::
:maxdepth: 1
MacOS<mac>
Windows<windows>
Linux<linux>
Android<android>

View File

@@ -1,8 +1,8 @@
.. _tor-linux: .. _tor-linux:
*********************** ********************
Setting up Tor on Linux Running Tor on Linux
*********************** ********************
All you need to do is install the Tor proxy service to your system. To do so, open your terminal and run the following command: All you need to do is install the Tor proxy service to your system. To do so, open your terminal and run the following command:

View File

@@ -1,8 +1,8 @@
.. _tor-mac: .. _tor-mac:
*********************** ********************
Setting up Tor on MacOS Running Tor on MacOS
*********************** ********************
First, you need to install the Tor proxy service to your system. This will require opening your Terminal. First, you need to install the Tor proxy service to your system. This will require opening your Terminal.

View File

@@ -1,8 +1,8 @@
.. _tor-windows: .. _tor-windows:
************************* **********************
Setting up Tor on Windows Running Tor on Windows
************************* **********************
First, you need to install the Tor proxy service to your system. Unfortunately, `torproject.org` no longer publishes a standalone Tor binary for Windows, so the recommended way to get it is with the Tor Browser Bundle. You can download it `here <https://www.torproject.org/download/>`_. First, you need to install the Tor proxy service to your system. Unfortunately, `torproject.org` no longer publishes a standalone Tor binary for Windows, so the recommended way to get it is with the Tor Browser Bundle. You can download it `here <https://www.torproject.org/download/>`_.
@@ -23,8 +23,8 @@ Once it is downloaded, go ahead and run the installer. If you want to install th
It does not matter where you set the destination folder, however you need to make note of it for later. Go ahead and finish the installation. It does not matter where you set the destination folder, however you need to make note of it for later. Go ahead and finish the installation.
Now you want to set up Tor to run as a service: to run in the background and keep itself running so you dont have to worry about it again. To do so, you need to open your Command Prompt as an administrator. Now you want to set up Tor to run as a service: to run in the background and keep itself running so you dont have to worry about it again. To do so, you need to open your Command Prompt as an administrator.
In Windows 10, you can simply type :code:`cmd` in the Windows search bar, right click on the first result, and select `Run as Administrator`. In Windows 10, you can simply type ``cmd`` in the Windows search bar, right click on the first result, and select `Run as Administrator`.
Once it opens, you can run the following commands, inserting your destination folder in place of :code:`<PATH TO>`: Once it opens, you can run the following commands, inserting your destination folder in place of ``<PATH TO>``:
.. code-block:: .. code-block::

View File

@@ -24,7 +24,7 @@ Below are a list of our recommended browsers for Tor:
* `Tor Browser <https://torproject.org/download/>`_ (Mac, Windows, Linux, Android) * `Tor Browser <https://torproject.org/download/>`_ (Mac, Windows, Linux, Android)
* `Brave <https://brave.com/>`_ (Mac, Windows, Linux) * `Brave <https://brave.com/>`_ (Mac, Windows, Linux)
.. seealso:: :ref:`Setting up Tor for browsers <tor-system-setup>` .. seealso:: :ref:`Setting up Tor for browsers <running-tor>`
.. seealso:: `Announcing the Consulate Browser! <https://medium.com/@start9labs/announcing-the-consulate-browser-76d94a8599cb>`_ .. seealso:: `Announcing the Consulate Browser! <https://medium.com/@start9labs/announcing-the-consulate-browser-76d94a8599cb>`_

View File

@@ -1,6 +1,6 @@
************** *****************
Using Services Managing Services
************** *****************
Services are self-hosted, open source projects made compatible for EmbassyOS. Each service is has been independently developed by members of the open source community. The Embassy enables configuration, customization and a one click install. Services are self-hosted, open source projects made compatible for EmbassyOS. Each service is has been independently developed by members of the open source community. The Embassy enables configuration, customization and a one click install.

View File

@@ -1,11 +0,0 @@
*********
EmbassyOS
*********
.. toctree::
:maxdepth: 2
initial-setup
connecting
general/index
using-services/index

View File

@@ -1,22 +0,0 @@
*****************
Firefox Tor Setup
*****************
.. warning::
These guides assume you have completed :ref:`setting up Tor for your operating system<tor-system-setup>`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor.
After completing the steps above to setup Tor on your operating system:
#. Go to :code:`about:config` in the URL bar.
#. Accept any warnings that may appear about accessing advanced settings.
#. Search for :code:`dom.securecontext.whitelist_onions` and set the value to :code:`true`.
#. Restart Firefox.
#. Select your platform below to complete setup:
.. toctree::
:maxdepth: 1
Android <android>
Mac <mac>
Linux <linux>
Windows <windows>

View File

@@ -1,62 +0,0 @@
.. _tor-system-setup:
**************
Setting up Tor
**************
Operating Systems
=================
Setting up Tor on your operating system enables other applications to utilize its functionality beyond Tor Browser. For example, a bitcoin wallet software that connects to a remote bitcoin node over Tor, or Firefox web browser. In the following guides, we will walk you through setting up Tor globally. That way, you can integrate other applications that use Embassy services all over Tor!
Select your operating system to get started:
.. toctree::
:maxdepth: 1
MacOS<mac>
Windows<windows>
Linux<linux>
Android<android>
.. _tor-browser-setup:
Browsers
========
To access websites that provide a Tor address (the :code:`.onion` URL), a Tor enabled browser is required.
Tor Browser
-----------
The `Tor Browser <https://torproject.org/download/>`_ works right out of the box. Simply download, launch, and plug in a :code:`.onion` URL to access a website over Tor. No extra configuration is needed. However, it is important to note that this is the least flexible option - browser extensions are not enabled, so utilizing password managers such as Bitwarden is not possible. It is also the slowest experience for ordinary web browsing due to the extra hops it makes across the internet.
Brave Browser
-------------
Alternatively, you can use `Brave <https://brave.com/>`_ to access websites over Tor. After downloading and launching, you can open a Brave Private Window with Tor by pressing :code`Option ⌥ + Command ⌘ + N`.
However, this approach is also restricting, since browser extensions are disabled in this mode as well. Ordinary web browsing is also somewhat slower in a Private Window with Tor, so you might choose to navigate between Brave browser windows for either clearnet or Tor websites. This is a somewhat less uniform experience.
Firefox Browser
---------------
Start9 recommends configuring Firefox to resolve Tor addresses. This is by far the most featureful and flexible approach. It requires a bit more work (< 5 minutes), but the resulting experience is worth the effort. It gives you the best of both worlds: you can browse clearnet websites without latency and visit Onion websites without switching browsers. And for Embassy owners, there is the added benefit of using your `Bitwarden password manager <https://medium.com/@start9labs/start9-welcomes-bitwarden-to-the-sovereign-app-store-8ad31e1a3070>`_!
After completing the steps above to setup Tor on your operating system:
#. Go to :code:`about:config` in the URL bar.
#. Accept any warnings that may appear about accessing advanced settings.
#. Search for :code:`dom.securecontext.whitelist_onions` and set the value to :code:`true`.
#. Restart Firefox.
#. Select your platform below to complete setup:
- :ref:`Android <firefox-tor-android>`
- :ref:`Linux <firefox-tor-linux>`
- :ref:`Mac <firefox-tor-mac>`
- :ref:`Windows <firefox-tor-windows>`
.. toctree::
:maxdepth: 1
:hidden:
Firefox <firefox/index>