diff --git a/.gitignore b/.gitignore index b89f8c0..0afcafa 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .DS_Store .vscode/ -build/ \ No newline at end of file +build/ +build-send.sh \ No newline at end of file diff --git a/source/_static/default.css b/source/_static/default.css index 83bde84..2524443 100644 --- a/source/_static/default.css +++ b/source/_static/default.css @@ -5,7 +5,7 @@ body, h1, h2, h3, h4, nav, .topbar, .topbar-main, .tocsection, .form-control, .b h1 { font-size: 2rem; - margin-top: 2rem; + margin-top: 3.5rem; } h2 { @@ -25,7 +25,6 @@ p, nav a { letter-spacing: 0.75px; } - a, a:visited, .headerlink { color: #ff4961!important; } @@ -60,13 +59,14 @@ h1, h2 { display: inline; } -.main-content { - margin-top: 1rem; +.bd-sidebar { + background: none; } @media (min-width: 768px) { .bd-sidebar { border-right: 1px solid #f8f8ff; + background: none; } } @@ -101,7 +101,7 @@ code { } .container-fluid, .container-lg, .container-md, .container-sm, .container-xl { - width: 80%; + width: 90%; } .admonition { @@ -159,4 +159,16 @@ code { nav.bd-links .fa-chevron-up:hover, nav.bd-links .fa-chevron-down:hover { color: #ff4960; +} + +nav.bd-links > ul.nav { + padding-right: 8px; +} + +.highlight > pre { + background-color: lightgray; +} + +.set-padding { + padding-top: 75px!important; } \ No newline at end of file diff --git a/source/_static/images/diy/balena.png b/source/_static/images/diy/balena.png new file mode 100644 index 0000000..9096519 Binary files /dev/null and b/source/_static/images/diy/balena.png differ diff --git a/source/_static/images/diy/pi.png b/source/_static/images/diy/pi.png new file mode 100644 index 0000000..8e4fa20 Binary files /dev/null and b/source/_static/images/diy/pi.png differ diff --git a/source/_static/images/diy/pins.png b/source/_static/images/diy/pins.png new file mode 100644 index 0000000..d9409a6 Binary files /dev/null and b/source/_static/images/diy/pins.png differ diff --git a/source/_static/images/tor/about_config.png b/source/_static/images/tor/about_config.png new file mode 100644 index 0000000..349ecbe Binary files /dev/null and b/source/_static/images/tor/about_config.png differ diff --git a/source/_static/images/tor/autoconfig_url.png b/source/_static/images/tor/autoconfig_url.png new file mode 100644 index 0000000..0bb3dfe Binary files /dev/null and b/source/_static/images/tor/autoconfig_url.png differ diff --git a/source/_static/images/tor/firefox_options_windows.png b/source/_static/images/tor/firefox_options_windows.png new file mode 100644 index 0000000..d7b742b Binary files /dev/null and b/source/_static/images/tor/firefox_options_windows.png differ diff --git a/source/_static/images/tor/firefox_preferences.png b/source/_static/images/tor/firefox_preferences.png new file mode 100644 index 0000000..8848ca5 Binary files /dev/null and b/source/_static/images/tor/firefox_preferences.png differ diff --git a/source/_static/images/tor/firefox_proxy.png b/source/_static/images/tor/firefox_proxy.png new file mode 100644 index 0000000..5a2f34d Binary files /dev/null and b/source/_static/images/tor/firefox_proxy.png differ diff --git a/source/_static/images/tor/firefox_search.png b/source/_static/images/tor/firefox_search.png new file mode 100644 index 0000000..5688da0 Binary files /dev/null and b/source/_static/images/tor/firefox_search.png differ diff --git a/source/_static/images/tor/firefox_whitelist.png b/source/_static/images/tor/firefox_whitelist.png new file mode 100644 index 0000000..cfb4dc6 Binary files /dev/null and b/source/_static/images/tor/firefox_whitelist.png differ diff --git a/source/_static/images/tor/firefox_whitelist_mobile.png b/source/_static/images/tor/firefox_whitelist_mobile.png new file mode 100644 index 0000000..8f78043 Binary files /dev/null and b/source/_static/images/tor/firefox_whitelist_mobile.png differ diff --git a/source/_static/images/tor/network_proxy_type.png b/source/_static/images/tor/network_proxy_type.png new file mode 100644 index 0000000..75956a0 Binary files /dev/null and b/source/_static/images/tor/network_proxy_type.png differ diff --git a/source/_static/images/tor/orbot_apps.png b/source/_static/images/tor/orbot_apps.png new file mode 100644 index 0000000..f0b3e49 Binary files /dev/null and b/source/_static/images/tor/orbot_apps.png differ diff --git a/source/_static/images/tor/orbot_menu.png b/source/_static/images/tor/orbot_menu.png new file mode 100644 index 0000000..f7166da Binary files /dev/null and b/source/_static/images/tor/orbot_menu.png differ diff --git a/source/_static/images/tor/orbot_settings.png b/source/_static/images/tor/orbot_settings.png new file mode 100644 index 0000000..aa91e6f Binary files /dev/null and b/source/_static/images/tor/orbot_settings.png differ diff --git a/source/_static/images/tor/orbot_start.png b/source/_static/images/tor/orbot_start.png new file mode 100644 index 0000000..a6c44bd Binary files /dev/null and b/source/_static/images/tor/orbot_start.png differ diff --git a/source/_static/images/tor/orbot_started.png b/source/_static/images/tor/orbot_started.png new file mode 100644 index 0000000..f430236 Binary files /dev/null and b/source/_static/images/tor/orbot_started.png differ diff --git a/source/_static/images/tor/orbot_vpn.png b/source/_static/images/tor/orbot_vpn.png new file mode 100644 index 0000000..8371b0f Binary files /dev/null and b/source/_static/images/tor/orbot_vpn.png differ diff --git a/source/_static/images/tor/private_dns_off.png b/source/_static/images/tor/private_dns_off.png new file mode 100644 index 0000000..86a65f3 Binary files /dev/null and b/source/_static/images/tor/private_dns_off.png differ diff --git a/source/_static/images/tor/socks_remote_dns.png b/source/_static/images/tor/socks_remote_dns.png new file mode 100644 index 0000000..d758689 Binary files /dev/null and b/source/_static/images/tor/socks_remote_dns.png differ diff --git a/source/_static/images/tor/tor_download_windows.png b/source/_static/images/tor/tor_download_windows.png new file mode 100644 index 0000000..54d0dcc Binary files /dev/null and b/source/_static/images/tor/tor_download_windows.png differ diff --git a/source/_static/images/tor/tor_windows_install.png b/source/_static/images/tor/tor_windows_install.png new file mode 100644 index 0000000..c78ef1e Binary files /dev/null and b/source/_static/images/tor/tor_windows_install.png differ diff --git a/source/_static/images/tor/tor_windows_terminal.png b/source/_static/images/tor/tor_windows_terminal.png new file mode 100644 index 0000000..ddcfd54 Binary files /dev/null and b/source/_static/images/tor/tor_windows_terminal.png differ diff --git a/source/_static/js/main.js b/source/_static/js/main.js index 6620bf7..877a572 100644 --- a/source/_static/js/main.js +++ b/source/_static/js/main.js @@ -9,3 +9,11 @@ $(document).ready(function () { $(this).parent().children(".admonition-title").toggleClass("open"); }) }); +// $(window).on('load', function () { +// console.log("loaded") + +// $('a').click(function () { +// console.log('tag clicked') +// $("body.scrolled").addClass("set-padding") +// }) +// }) diff --git a/source/conf.py b/source/conf.py index 960db99..efb5ffe 100644 --- a/source/conf.py +++ b/source/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- project = 'Start9 Labs' -copyright = '2020, Start9 Labs' +copyright = '2020, Start9 Labs, Inc' # -- General configuration --------------------------------------------------- diff --git a/source/getting-started/diy.rst b/source/getting-started/diy.rst new file mode 100644 index 0000000..7006df2 --- /dev/null +++ b/source/getting-started/diy.rst @@ -0,0 +1,88 @@ +.. _diy: + +********* +DIY Guide +********* + +.. figure:: /_static/images/diy/pi.png + :width: 40% + :alt: Raspberry Pi + + Raspberry Pi Board + +By popular demand, we are pleased to present this "Do it Yourself" (DIY) guide for the Start9 Embassy personal server! + +Motivation +========== + +There are four reasons you might prefer to build your own Embassy instead of purchasing one from us. + +#. You already have a Raspberry Pi and would like to re-purpose it. + +#. You want to save on shipping costs. + +#. You prefer not to divulge your physical shipping address. + +#. You just like building things. + +Hardware +======== + +Components +---------- +#. `Raspberry Pi 4B (4GB) `_ +#. `Power supply for Raspberry Pi 4B `_ +#. Case for Raspberry Pi 4B (`passive cooling recommended `_ `*`) +#. `High endurance microSD `_ (recommended 128GB or more) +#. `GPIO mini speaker/buzzer `_ +#. Ethernet cable +#. MicroSD → USB adapter (if no microSD port on your computer) + +`*` If you use a fan, **DO NOT** use the official Raspberry Pi fan, as it requires the same GPIO pins as the audio speaker. Instead, we recommend `this fan `_. + +Assembly Instructions +--------------------- + +1. Insert mini speaker/buzzer into GPIO pins 6/8/10/12 with the word "speaker" facing out, `away from the board`. + +.. figure:: /_static/images/diy/pins.png + :width: 60% + :alt: Speaker board spec + +That's it. Place the Raspberry Pi 4 board (with speaker attached), into its case. + +Getting EmbassyOS +================= + +Purchasing +---------- + +You can purchase EmbassyOS `here `_. This is by far the easiest path to get up and running. + +Depending on your Internet speed, the download should take between 5 and 30 minutes. + +Building from Source +-------------------- + +If you have the proper tooling and are comfortable using the command line, you can build EmbassyOS from `source `_, which is made available under the `Start9 Personal Use License `_. + +Installing EmbassyOS +==================== + +Whether you purchase EmbassyOS from us or build it yourself, you need to flash it onto a microSD card. + +1. Download `balenaEtcher `_ onto your Mac, Windows, or Linux computer. +2. Insert the microSD card into your computer, either directly or using an adapter. +3. Open balenaEtcher. +4. Click `Select Image`, then find and select your copy of EmbassyOS. +5. Click `Select Target`, then find and select your micro SD card. +6. Click `Flash!` You may be asked to (1) approve the unusually large disk target or (2) enter your password. Both are normal. + +.. figure:: /_static/images/diy/balena.png + :width: 60% + :alt: Balena Etcher Dashboard + +7. Once the image is flashed and verified, you may remove the micro SD and insert it into your Embassy. +8. The Embassy is now ready for use, and you may following the normal :ref:`setup ` instructions. ``*`` + +``*`` The first time you power it on, your Embassy will make more noises than future attempts, and it may take several minutes to finally complete. \ No newline at end of file diff --git a/source/getting-started/introduction.rst b/source/getting-started/introduction.rst new file mode 100644 index 0000000..5b8eb92 --- /dev/null +++ b/source/getting-started/introduction.rst @@ -0,0 +1,13 @@ +************ +Introduction +************ + +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 Labs. + +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 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` one directly from Start9 Labs, or you can :ref:`build one yourself`. \ No newline at end of file diff --git a/source/getting-started/purchasing.rst b/source/getting-started/purchasing.rst new file mode 100644 index 0000000..f405745 --- /dev/null +++ b/source/getting-started/purchasing.rst @@ -0,0 +1,9 @@ +.. _purchasing: + +********** +Purchasing +********** + +For maximum convenience, you can purchase an Embassy device directly from Start9 Labs through our `Shopify Store `_. 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. + +If you prefer to build your own Embassy, you can follow the :ref:`DIY Guide `. \ No newline at end of file diff --git a/source/getting-started/setup/index.rst b/source/getting-started/setup/index.rst deleted file mode 100644 index 30c61f9..0000000 --- a/source/getting-started/setup/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _initial-setup: - -************* -Initial Setup -************* - -.. toctree:: - :maxdepth: 2 - - 0.2.x \ No newline at end of file diff --git a/source/index.rst b/source/index.rst index 043d625..039030a 100644 --- a/source/index.rst +++ b/source/index.rst @@ -10,15 +10,26 @@ Here you will find guidance and information about the Start9 Embassy personal se :maxdepth: 2 :caption: Getting Started - getting-started/setup/index - getting-started/connecting + getting-started/introduction + getting-started/purchasing + getting-started/diy .. toctree:: :maxdepth: 2 - :caption: User Manuals + :caption: User Manual - user-manuals/embassyos/index - user-manuals/available-services/index + user-manual/initial-setup + user-manual/connecting + 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:: :maxdepth: 2 diff --git a/source/misc-guides/available-services.rst b/source/misc-guides/available-services.rst new file mode 100644 index 0000000..6eda297 --- /dev/null +++ b/source/misc-guides/available-services.rst @@ -0,0 +1,25 @@ +.. _available-services: + +****************** +Available Services +****************** + +A list of currently-available services for the Embassy. + +Bitcoin-related services +======================== + +* `Bitcoin `_ +* `Bitcoin Proxy `_ +* `Lightning Network Daemon (LND) `_ +* `c-lightning `_ +* `Ride the Lightning (RTL) `_ +* `Spark Wallet `_ + +Other services +============== + +* `Bitwarden `_ +* `Burn After Reading `_ +* `Cups `_ +* `File Browser `_ \ No newline at end of file diff --git a/source/misc-guides/tor-firefox/android.rst b/source/misc-guides/tor-firefox/android.rst new file mode 100644 index 0000000..135bb97 --- /dev/null +++ b/source/misc-guides/tor-firefox/android.rst @@ -0,0 +1,54 @@ +.. _firefox-tor-android: + +************************************** +Setting up Firefox with Tor on Android +************************************** + +.. warning:: + This guide assumes you have completed :ref:`setting up Tor for Android`. 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 will need to edit your phone's private DNS setting. + +Navigate to `Network & Internet > Advanced > Private DNS` and toggle Private DNS Mode "off". + +.. figure:: /_static/images/private_dns.png + :width: 50% + :alt: Private DNS toggle + +Next, you can proceed to setup Firefox. + +Download `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 `.onion` URLs. We have one hosted `here `_. + +Next, navigate to ``about:config`` in the Firefox URL bar: + +.. figure:: /_static/images/tor/about_config.png + :width: 50% + :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``: + +.. figure:: /_static/images/tor/network_proxy_type.png + :width: 50% + :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``: + +.. figure:: /_static/images/tor/autoconfig_url.png + :width: 50% + :alt: Firefox autoconfig url setting screenshot + +Next, search for ``network.proxy.socks_remote_dns``, and set the value to ``true``: + +.. figure:: /_static/images/tor/socks_remote_dns.png + :width: 50% + :alt: Firefox socks remote dns setting screenshot + +Next, search for ``dom.securecontext.whitelist_onions`` and set the value to ``true``. + +.. figure:: /_static/images/tor/firefox_whitelist_mobile.png + :width: 50% + :alt: Firefox whitelist onions screenshot + +Restart Firefox, and you’re 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 `_ native application. \ No newline at end of file diff --git a/source/misc-guides/tor-firefox/index.rst b/source/misc-guides/tor-firefox/index.rst new file mode 100644 index 0000000..493112b --- /dev/null +++ b/source/misc-guides/tor-firefox/index.rst @@ -0,0 +1,18 @@ +.. _configure_firefox_tor: + +*************************** +Configuring Firefox for Tor +*************************** + +.. warning:: + This guide assumes you are already :ref:`running Tor on your phone or computer`. + +Once you have completed the above guide, select your device's operating system below: + +.. toctree:: + :maxdepth: 1 + + MacOS + Windows + Linux + Android \ No newline at end of file diff --git a/source/misc-guides/tor-firefox/linux.rst b/source/misc-guides/tor-firefox/linux.rst new file mode 100644 index 0000000..8105074 --- /dev/null +++ b/source/misc-guides/tor-firefox/linux.rst @@ -0,0 +1,54 @@ +.. _firefox-tor-linux: + +************************************ +Setting up Firefox with Tor on Linux +************************************ + +.. warning:: + This guide assumes you have completed :ref:`setting up Tor for Linux`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor. + +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 `_. To get it, you can run: + +.. code-block:: + + sudo wget -P /etc/tor https://registry.start9labs.com/sys/proxy.pac + +Now open your Firefox web browser, and select preferences: + +.. figure:: /_static/images/tor/firefox_preferences.png + :width: 80% + :alt: Firefox preferences screenshot + + Select :menuselection:`Settings --> Preferences` + +Search for the term “proxy” in the search bar in the upper right, then select the button that says `Settings…`: + +.. figure:: /_static/images/tor/firefox_search.png + :width: 80% + :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: + +.. code-block:: + + file:///etc/tor/proxy.pac + +Then, check the box labeled `Proxy DNS when using SOCKS v5`: + +.. figure:: /_static/images/tor/firefox_proxy.png + :width: 80% + :alt: Firefox proxy settings screenshot + +Click ``OK`` and then restart Firefox for the changes to take effect. + +Now you’re 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 `_. \ No newline at end of file diff --git a/source/misc-guides/tor-firefox/mac.rst b/source/misc-guides/tor-firefox/mac.rst new file mode 100644 index 0000000..38be650 --- /dev/null +++ b/source/misc-guides/tor-firefox/mac.rst @@ -0,0 +1,62 @@ +.. _firefox-tor-mac: + +************************************ +Setting up Firefox with Tor on MacOS +************************************ + +.. warning:: + This guide assumes you have completed :ref:`setting up Tor for MacOS`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor. + +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, 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 `_. To get it, enter into the terminal: + +.. code-block:: + + brew install wget + +And then: + +.. code-block:: + + wget -P /usr/local/etc/tor https://registry.start9labs.com/sys/proxy.pac + +Now open your Firefox web browser, and select preferences: + +.. figure:: /_static/images/tor/firefox_preferences.png + :width: 80% + :alt: Firefox preferences screenshot + + Select :menuselection:`Settings --> Preferences` + +Search for the term “proxy” in the search bar in the upper right, then select the button that says `Settings…`: + +.. figure:: /_static/images/tor/firefox_search.png + :width: 80% + :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: + +.. code-block:: + + file:///usr/local/etc/tor/proxy.pac + +Then, check the box labeled `Proxy DNS when using SOCKS v5`: + +.. figure:: /_static/images/tor/firefox_proxy.png + :width: 80% + :alt: Firefox proxy settings screenshot + +Click ``OK`` and then restart Firefox for the changes to take effect. + +Now you’re 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 `_. \ No newline at end of file diff --git a/source/misc-guides/tor-firefox/windows.rst b/source/misc-guides/tor-firefox/windows.rst new file mode 100644 index 0000000..ec60b7f --- /dev/null +++ b/source/misc-guides/tor-firefox/windows.rst @@ -0,0 +1,54 @@ +.. _firefox-tor-windows: + +************************************** +Setting up Firefox with Tor on Windows +************************************** + +.. warning:: + This guide assumes you have completed :ref:`setting up Tor for Windows`. Please visit this section first before you proceed as it is required for Firefox to properly work with Tor. + +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 `_. Save it somewhere you won’t delete it. For this example: + +.. code-block:: + + C:\Program Files\Tor Browser\proxy.pac + +Now open your Firefox web browser, and select options: + +.. figure:: /_static/images/tor/firefox_options_windows.png + :width: 80% + :alt: Firefox options screenshot + + Select :menuselection:`Settings --> Options` + +Search for the term “proxy” in the search bar in the upper right, then select the button that says `Settings…`: + +.. figure:: /_static/images/tor/firefox_search.png + :width: 80% + :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: + +.. code-block:: + + file://C:/Program Files/Tor Browser/proxy.pac + +Then, check the box labeled `Proxy DNS when using SOCKS v5`: + +.. figure:: /_static/images/tor/firefox_proxy.png + :width: 80% + :alt: Firefox proxy settings screenshot + +Click ``OK`` and then restart Firefox for the changes to take effect. + +Now you’re 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 `_. \ No newline at end of file diff --git a/source/misc-guides/tor-os/android.rst b/source/misc-guides/tor-os/android.rst new file mode 100644 index 0000000..495785d --- /dev/null +++ b/source/misc-guides/tor-os/android.rst @@ -0,0 +1,70 @@ +.. _tor-android: + +********************** +Running Tor on Android +********************** + +.. warning:: + Custom proxies are now only available in `Firefox Beta `_ or `Firefox Nightly `_ 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 `_. Once you have done so, launch Orbot. + +Next, open the kebab menu in the upper right hand corner and select `Settings`: + +.. figure:: /_static/images/tor/orbot_menu.png + :width: 50% + :alt: Orbot menu + +Then, make sure the options for `Start Orbot on Boot` and `Allow Background Starts` are checked: + +.. figure:: /_static/images/tor/orbot_settings.png + :width: 50% + :alt: Orbot settings + +Go back, and tap start: + +.. figure:: /_static/images/tor/orbot_start.png + :width: 50% + :alt: Orbot start + +Orbot will start up the Tor service. Once complete, you will see: + +.. figure:: /_static/images/tor/orbot_started.png + :width: 50% + :alt: Orbot started + +You can now close Orbot. + +Setting up Orbot VPN mode +------------------------- + +Orbot's VPN mode allows certain applications to utilize it's Tor service. + +This process also applies for GrapheneOS. + +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 + :width: 50% + :alt: Private DNS off + + Toggle Private DNS to "off" + +Next, launch Orbot and toggle VPN Mode on while on the main screen: + +.. figure:: /_static/images/tor/orbot_vpn.png + :width: 50% + :alt: Orbot vpn mode + + Toggle VPN Mode to "on" + +Under `Tor-Enabled Apps`, select the gear to add applications that need to be proxied through VPN mode to utilize Tor. + +.. figure:: /_static/images/tor/orbot_apps.png + :width: 50% + :alt: Orbot apps + +Examples of applications that need this feature are: + +- Bitwarden +- Zap diff --git a/source/misc-guides/tor-os/index.rst b/source/misc-guides/tor-os/index.rst new file mode 100644 index 0000000..328c50c --- /dev/null +++ b/source/misc-guides/tor-os/index.rst @@ -0,0 +1,17 @@ +.. _running-tor: + +*********** +Running Tor +*********** + +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 + Windows + Linux + Android \ No newline at end of file diff --git a/source/misc-guides/tor-os/linux.rst b/source/misc-guides/tor-os/linux.rst new file mode 100644 index 0000000..8e7b9f4 --- /dev/null +++ b/source/misc-guides/tor-os/linux.rst @@ -0,0 +1,13 @@ +.. _tor-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: + +.. code-block:: + + sudo apt update && sudo apt install tor + +That's it! Your Linux machine is now setup to natively use Tor. \ No newline at end of file diff --git a/source/misc-guides/tor-os/mac.rst b/source/misc-guides/tor-os/mac.rst new file mode 100644 index 0000000..8784ab3 --- /dev/null +++ b/source/misc-guides/tor-os/mac.rst @@ -0,0 +1,40 @@ +.. _tor-mac: + +******************** +Running Tor on MacOS +******************** + +First, you need to install the Tor proxy service to your system. This will require opening your Terminal. + +To open your terminal, hold the command key ⌘ + spacebar. `Spotlight Search` will appear. Start typing "terminal" and select the program called `Terminal`. + + +Paste in the following commands and hit . + +.. code-block:: + + which brew || /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" + brew install tor + brew services start tor + +When this completes, you should see something like: + +.. code-block:: + + ==> Successfully started `tor` (label: homebrew.mxcl.tor) + +If you notice issues connecting to Tor websites, try restarting the Tor service. Open the terminal and run: + +.. code-block:: + + brew services restart tor + +After running this command, you should see something like: + +.. code-block:: + + Stopping `tor`... (might take a while) + ==> Successfully stopped `tor` (label: homebrew.mxcl.tor) + ==> Successfully started `tor` (label: homebrew.mxcl.tor) + +That's it! Your Mac is now setup to natively use Tor. \ No newline at end of file diff --git a/source/misc-guides/tor-os/windows.rst b/source/misc-guides/tor-os/windows.rst new file mode 100644 index 0000000..6166e76 --- /dev/null +++ b/source/misc-guides/tor-os/windows.rst @@ -0,0 +1,42 @@ +.. _tor-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 `_. + +.. figure:: /_static/images/tor/tor_download_windows.png + :width: 80% + :alt: Tor download + + Download Tor for Windows + +Once it is downloaded, go ahead and run the installer. If you want to install the program outside of your user directory, you will have to right click and select `Run as Administrator`. Once you have selected a language, you should see a menu like this: + +.. figure:: /_static/images/tor/tor_windows_install.png + :width: 80% + :alt: Tor install wizard + + Note Tor destination folder when installing + +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 don’t 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 ``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-block:: + + sc create tor start=auto binPath="\Tor Browser\Browser\TorBrowser\Tor\tor.exe -nt-service" + sc start tor + +When you run this, it should look something like this: + +.. figure:: /_static/images/tor/tor_windows_terminal.png + :width: 80% + :alt: Tor windows terminal + + Replace highlighted section with noted destination folder + +That's it! Your Windows computer is now setup to natively use Tor. \ No newline at end of file diff --git a/source/getting-started/connecting.rst b/source/user-manual/connecting.rst similarity index 63% rename from source/getting-started/connecting.rst rename to source/user-manual/connecting.rst index 03d8533..2307e02 100644 --- a/source/getting-started/connecting.rst +++ b/source/user-manual/connecting.rst @@ -12,25 +12,29 @@ If you accidentally leak your Embassy's addresses, do not worry. You Embassy is Tor === -Connecting to your Embassy over :ref:`tor` requires using a browser that supports *.onion* URLs. +Connecting to your Embassy over :ref:`tor` requires using a browser that supports :code:`.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 `_ (iOS) -* `Firefox `_ (Mac, Windows, Linux, Android) +* `Firefox `_ (Mac, Windows, Linux) +* `Firefox Beta `_ (Android) * `Tor Browser `_ (Mac, Windows, Linux, Android) -* `Brave `_ (Mac, Windows, Linux, Android) +* `Brave `_ (Mac, Windows, Linux) -.. seealso:: `Setting up Firefox to handle Tor addresses `_ - -.. seealso:: `Announcing the Consulate Browser! `_ +.. seealso:: + :ref:`Setting up Tor for browsers ` + + :ref:`configure_firefox_tor` + + `Announcing the Consulate Browser! `_ LAN === -Connecting to your Embassy over :ref:`lan` has the benefit of being fast! It requires using a browser that supports *.local* URLs, which is true for most browsers. +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. -This option is considered *advanced*, since it requires :ref:`installing and trusting your Embassy's Root Certificate Authority SSL` on any phone or laptop you use to connect. \ No newline at end of file +.. seealso:: :ref:`Installing and trusting your Embassy's Root Certificate Authority SSL` \ No newline at end of file diff --git a/source/user-manuals/embassyos/general/developer-options/alt-marketplace.rst b/source/user-manual/general/developer-options/alt-marketplace.rst similarity index 100% rename from source/user-manuals/embassyos/general/developer-options/alt-marketplace.rst rename to source/user-manual/general/developer-options/alt-marketplace.rst diff --git a/source/user-manuals/embassyos/general/developer-options/index.rst b/source/user-manual/general/developer-options/index.rst similarity index 100% rename from source/user-manuals/embassyos/general/developer-options/index.rst rename to source/user-manual/general/developer-options/index.rst diff --git a/source/user-manuals/embassyos/general/developer-options/ssh-setup.rst b/source/user-manual/general/developer-options/ssh-setup.rst similarity index 67% rename from source/user-manuals/embassyos/general/developer-options/ssh-setup.rst rename to source/user-manual/general/developer-options/ssh-setup.rst index 4858576..a7c07d5 100644 --- a/source/user-manuals/embassyos/general/developer-options/ssh-setup.rst +++ b/source/user-manual/general/developer-options/ssh-setup.rst @@ -4,9 +4,11 @@ SSH Setup ********* -#. Click ``Developer Options > SSH Keys`` +#. Navigate to *Developer Options > SSH Keys* #. Click the ``+`` button in the lower right hand corner. #. Paste in your SSH key. -#. You can now access your Embassy from the command line using ``ssh pi@`` +#. You can now access your Embassy from the command line using:: + + ssh pi@ .. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause through SSH access. \ No newline at end of file diff --git a/source/user-manuals/embassyos/general/embassy-config.rst b/source/user-manual/general/embassy-config.rst similarity index 54% rename from source/user-manuals/embassyos/general/embassy-config.rst rename to source/user-manual/general/embassy-config.rst index 861e87d..ed0d76e 100644 --- a/source/user-manuals/embassyos/general/embassy-config.rst +++ b/source/user-manual/general/embassy-config.rst @@ -2,7 +2,7 @@ Config Options ************** -Click ``config``. Here you can set custom configurations for your Embassy. Currently, changing the ``Device Name`` is the only option. +Click "Config". Here you can set custom configurations for your Embassy. Currently, changing the Device Name is the only option. .. figure:: /_static/images/embassy_config.png :width: 90% diff --git a/source/user-manuals/embassyos/general/forgot-password.rst b/source/user-manual/general/forgot-password.rst similarity index 62% rename from source/user-manuals/embassyos/general/forgot-password.rst rename to source/user-manual/general/forgot-password.rst index 689d086..4b8a2d5 100644 --- a/source/user-manuals/embassyos/general/forgot-password.rst +++ b/source/user-manual/general/forgot-password.rst @@ -11,12 +11,28 @@ If you already have :ref:`SSH keys registered with your Embassy` **OR * SSH: - * Use the command line to gain remote access to your Embassy, then run:: + * Use the command line to gain SSH access to your Embassy:: + + ssh pi@start9-[network-id].local + + * Check if you have sqlite3 installed. If not, install it:: + + which sqlite3 + sudo apt install sqlite3 + + * Access the sqlite3 terminal:: sudo sqlite3 /root/agent/start9_agent.sqlite3 + + * Run:: + delete from account; .quit + * Exit the SSH session:: + + exit + * You can now use the Start9 Setup App to reclaim your Embassy and set a new password. * Linux computer: @@ -31,9 +47,12 @@ If you already have :ref:`SSH keys registered with your Embassy` **OR which sqlite3 sudo apt install sqlite3 + * Access the sqlite3 terminal:: + + sudo sqlite3 /root/agent/start9_agent.sqlite3 + * Run:: - sudo sqlite3 [mount folder]/root/agent/start9_agent.sqlite3 delete from account; .quit @@ -48,4 +67,4 @@ If you already have :ref:`SSH keys registered with your Embassy` **OR No SSH/Linux ============ -The only way to regain access to your Embassy is to :ref:`contact the Start9 dev team` directly to obtain a new operating system image. This is equivalent to a factory reset; all data will be lost. \ No newline at end of file +You must factory reset your device by re-installing EmbassyOS, resulting in permanent loss of data. Visit the `image downloader `_ to obtain a new EmbassyOS image, then follow the `installation instructions `_. \ No newline at end of file diff --git a/source/user-manuals/embassyos/general/index.rst b/source/user-manual/general/index.rst similarity index 72% rename from source/user-manuals/embassyos/general/index.rst rename to source/user-manual/general/index.rst index 5ac982a..87c32ca 100644 --- a/source/user-manuals/embassyos/general/index.rst +++ b/source/user-manual/general/index.rst @@ -2,10 +2,7 @@ General ******* -An overview of EmbassyOS general capabilities. - -Features -======== +An overview of EmbassyOS general capabilities. .. toctree:: :maxdepth: 2 diff --git a/source/user-manuals/embassyos/general/notifications.rst b/source/user-manual/general/notifications.rst similarity index 83% rename from source/user-manuals/embassyos/general/notifications.rst rename to source/user-manual/general/notifications.rst index 3e25e1d..f627e42 100644 --- a/source/user-manuals/embassyos/general/notifications.rst +++ b/source/user-manual/general/notifications.rst @@ -2,7 +2,7 @@ Notifications ************* -You can view and manage your Notifications inside the ``Notifications`` tab in the main menu. They include: +You can view and manage your Notifications inside the "Notifications" tab in the main menu. They include: * successful or failed EmbassyOS updates * successful or failed service installations diff --git a/source/user-manuals/embassyos/general/power.rst b/source/user-manual/general/power.rst similarity index 100% rename from source/user-manuals/embassyos/general/power.rst rename to source/user-manual/general/power.rst diff --git a/source/user-manuals/embassyos/general/secure-lan/browser.rst b/source/user-manual/general/secure-lan/browser.rst similarity index 71% rename from source/user-manuals/embassyos/general/secure-lan/browser.rst rename to source/user-manual/general/secure-lan/browser.rst index 80d9137..c6607ff 100644 --- a/source/user-manuals/embassyos/general/secure-lan/browser.rst +++ b/source/user-manual/general/secure-lan/browser.rst @@ -11,15 +11,13 @@ Brave 1. Navigate to your Brave Settings in a new tab. -2. On the left hand sidebar, select ``Additional Settings > Privacy and Security``. +2. On the left hand sidebar, navigate to *Additional Settings > Privacy and Security*. 3. Add the bottom of the section, select "Manage Certificates". .. figure:: /_static/images/ssl/browser/brave_security_settings.png :width: 90% - :alt: Brave security settings - - Brave privacy and security settings page + :alt: Brave privacy and security settings page 4. If you see a trusted “Embassy Local Root CA”, open a new tab to apply the certificate. If this does not work, quit and restart Brave. @@ -27,9 +25,7 @@ Brave .. figure:: /_static/images/ssl/browser/brave_view_certs.png :width: 90% - :alt: Brave manage certs - - Brave Manage Certificates sub-menu on MacOS + :alt: Brave Manage Certificates sub-menu on MacOS 6. Obtain the LAN address provided in the Setup App and enter it in a new tab. @@ -61,9 +57,11 @@ Firefox Firefox privacy and security settings page -4. Click “Import” and open the downloaded ``Embassy Local Root CA.crt`` file on your device. If you cannot find this, make sure you completed the :ref:`device setup steps `. +4. Select the "Authorities" tab from the "Certificate Manager". -5. When prompted, check “Trust this CA to identity websites” and select “OK”. +5. Click “Import” and open the downloaded *Embassy Local Root CA.crt* file on your device. If you cannot find this, make sure you completed the :ref:`device setup steps `. + +6. When prompted, check “Trust this CA to identity websites” and select “OK”. .. figure:: /_static/images/ssl/browser/firefox_security_settings.png :width: 90% @@ -71,17 +69,17 @@ Firefox Firefox import certificate page -6. Ensure the “Embassy Local Root CA” exists under “Start9 Labs”. +7. Ensure the “Embassy Local Root CA” exists under “Start9 Labs”. -7. Click “OK” to save. +8. Click “OK” to save. -8. Open a new tab in Firefox to apply the changes. If this does not work, quit and restart Firefox. +9. Open a new tab in Firefox to apply the changes. If this does not work, quit and restart Firefox. -9. Navigate to the LAN address provided in the Setup App. +10. Navigate to the LAN address provided in the Setup App. -10. You can now securely navigate to your Embassy over HTTPS! +11. You can now securely navigate to your Embassy over HTTPS! Safari ====== -Once you have completed the steps to install a SSL certificate on your device, simply open a new tab to apply the changes. If this does not work, quit and restart Safari. You can now security navigate to the LAN address for your Embassy! \ No newline at end of file +Once you have completed the steps to install a SSL certificate on your device, simply open a new tab to apply the changes. If this does not work, quit and restart Safari. You can now securely navigate to the LAN address for your Embassy! \ No newline at end of file diff --git a/source/user-manuals/embassyos/general/secure-lan/desktop.rst b/source/user-manual/general/secure-lan/desktop.rst similarity index 86% rename from source/user-manuals/embassyos/general/secure-lan/desktop.rst rename to source/user-manual/general/secure-lan/desktop.rst index 5b00d5d..6e0b8f0 100644 --- a/source/user-manuals/embassyos/general/secure-lan/desktop.rst +++ b/source/user-manual/general/secure-lan/desktop.rst @@ -5,11 +5,11 @@ Desktop MacOS ===== -1. Copy the Tor address from the Setup App. It is safe to message this address to yourself so that you can paste it in a browser. +1. In the Setup App, select your claimed Embassy to view the setup results. Navigate to the "Tor" menu item and copy the Tor address. It is safe to message this address to yourself so that you can paste it in a browser. 2. Navigate to a :ref:`Tor enabled browser `. -3. Your browser might display a warning screen. You can typically navigate to ``Advanced > Accept the risk and continue``. +3. Your browser might display a warning screen. You can typically navigate to *Advanced > Accept the risk and continue*. 4. Allow the page to load with your Tor address over HTTP. Using HTTPS is less performant and unnecessary because Tor v3 is self authenticating. @@ -49,9 +49,9 @@ MacOS Keychain access import menu -If the keychain console did not open, press ``Command + spacebar`` and type “Keychain Access”, and hit enter to open it. +If the keychain console did not open, press "Command + spacebar" and type “Keychain Access”, and hit enter to open it. -11. Navigate to the “System” tab and find the certificate entitled “Embassy Local Root CA”. +11. Navigate to the "System" tab and find the certificate entitled “Embassy Local Root CA”. 12. Double click on this certificate. A second window will pop up. @@ -78,11 +78,11 @@ If the keychain console did not open, press ``Command + spacebar`` and type “K Windows ======= -1. Copy the Tor address from the Setup App. It is safe to message this address to yourself so that you can paste it in a browser. +1. In the Setup App, select your claimed Embassy to view the setup results. Navigate to the "Tor" menu item and copy the Tor address. It is safe to message this address to yourself so that you can paste it in a browser. 2. Navigate to a :ref:`Tor enabled browser `. -3. Your browser might display a warning screen. You can typically navigate to ``Advanced > Accept the risk and continue``. +3. Your browser might display a warning screen. You can typically navigate to *Advanced > Accept the risk and continue*. 4. Allow the page to load with your Tor address over HTTP. Using HTTPS is less performant and unnecessary because Tor v3 is self authenticating. @@ -106,7 +106,7 @@ Windows Select the "SSL Certificate" sub menu download icon -9. Select the option to save the ``Embassy Local CA.crt`` file. +9. Select the option to save the *Embassy Local CA.crt* file. .. figure:: /_static/images/ssl/windows/windows_download_cert.png :width: 90% @@ -124,7 +124,7 @@ Windows Access the Windows Management Console -12. When the Management Console opens, navigate to ``File > Add/Remove Snap-in``. +12. When the Management Console opens, navigate to *File > Add/Remove Snap-in*. .. figure:: /_static/images/ssl/windows/2_windows_console_root.png :width: 90% @@ -158,7 +158,7 @@ Windows Access Certificates in Management Console -17. Right click on “Certificates”, then select ``All Tasks > Import``. +17. Right click on “Certificates”, then navigate to *All Tasks > Import*. .. figure:: /_static/images/ssl/windows/6_windows_import_cert.png :width: 90% diff --git a/source/user-manuals/embassyos/general/secure-lan/index.rst b/source/user-manual/general/secure-lan/index.rst similarity index 73% rename from source/user-manuals/embassyos/general/secure-lan/index.rst rename to source/user-manual/general/secure-lan/index.rst index c718aff..c5ccf37 100644 --- a/source/user-manuals/embassyos/general/secure-lan/index.rst +++ b/source/user-manual/general/secure-lan/index.rst @@ -8,7 +8,7 @@ EmbassyOS has ability to securely access your Embassy over HTTPS from any browse The following guides will take you through the steps to install and trust the SSL certificate generated from your Embassy. -First, determine your current version of EmbassyOS from the menu at ``Embassy > About > EmbassyOS Version``. +First, determine your current version of EmbassyOS, found in *Embassy > About > EmbassyOS Version*. .. figure:: /_static/images/embassy_version.png :width: 90% @@ -18,11 +18,10 @@ First, determine your current version of EmbassyOS from the menu at ``Embassy > .. warning:: - For EmbassyOS versions ``<0.2.5``, please follow the setup instructions on this `blog post `_. + For EmbassyOS versions <0.2.5, please follow the setup instructions on this `blog post `_. - For EmbassyOS versions ``>=0.2.5``, continue below. -Complete the setup for your device operating system: +For EmbassyOS versions >=0.2.5, continue completing the setup for your device operating system: .. toctree:: :maxdepth: 2 diff --git a/source/user-manuals/embassyos/general/secure-lan/mobile.rst b/source/user-manual/general/secure-lan/mobile.rst similarity index 93% rename from source/user-manuals/embassyos/general/secure-lan/mobile.rst rename to source/user-manual/general/secure-lan/mobile.rst index b016eb5..d151da7 100644 --- a/source/user-manuals/embassyos/general/secure-lan/mobile.rst +++ b/source/user-manual/general/secure-lan/mobile.rst @@ -2,7 +2,6 @@ Mobile ****** - iOS ==== @@ -10,7 +9,7 @@ iOS 2. Select your claimed Embassy to view the setup results. -3. Find the "Advanced" menu item at the bottom of the Setup App screen. +3. Find the "LAN (advanced)" menu item at the bottom of the Setup App screen. .. figure:: /_static/images/ssl/mobile/ssl_setup_app_complete.png :width: 90% @@ -44,7 +43,7 @@ iOS General settings -7. Navigate to ``General > Profile(s) > Downloaded Profile > Install``. +7. Navigate to *General > Profile(s) > Downloaded Profile > Install*. .. figure:: /_static/images/ssl/mobile/ssl_ipad_profiles.png :width: 90% @@ -60,7 +59,7 @@ iOS 8. Select “yes” to any warning prompts. -9. Next, navigate to ``General > About > Certificate Trust Settings``. +9. Next, navigate to *General > About > Certificate Trust Settings*. .. figure:: /_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.png :width: 90% diff --git a/source/user-manuals/embassyos/general/updating.rst b/source/user-manual/general/updating.rst similarity index 75% rename from source/user-manuals/embassyos/general/updating.rst rename to source/user-manual/general/updating.rst index c9690ae..dabfa5d 100644 --- a/source/user-manuals/embassyos/general/updating.rst +++ b/source/user-manual/general/updating.rst @@ -2,8 +2,9 @@ Updating EmbassyOS ****************** -#. Click ``Check for Updates`` +#. Navigate to ``Menu > Embassy`` +#. 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. -.. note:: Ensure you have a stable Internet connection, and do not unplug your Embassy during an update. Updates usually complete within a few minutes, but depending on the size of the update and you Internet bandwidth, they can sometimes take up to an hour. \ No newline at end of file +.. note:: Ensure you have a stable Internet connection, and do not unplug your Embassy during an update. Updates usually complete within a few minutes, but depending on the size of the update and your Internet bandwidth, they can sometimes take up to an hour. \ No newline at end of file diff --git a/source/user-manuals/embassyos/general/wifi.rst b/source/user-manual/general/wifi.rst similarity index 97% rename from source/user-manuals/embassyos/general/wifi.rst rename to source/user-manual/general/wifi.rst index d5ee6e8..846f795 100644 --- a/source/user-manuals/embassyos/general/wifi.rst +++ b/source/user-manual/general/wifi.rst @@ -2,7 +2,7 @@ Setting up WiFi *************** -#. Click ``WiFi``. +#. Click "WiFi". #. Click the ``+`` button in the lower right corner. #. Select the appropriate country. #. Enter your WiFi SSID and password. diff --git a/source/getting-started/setup/0.2.x.rst b/source/user-manual/initial-setup.rst similarity index 61% rename from source/getting-started/setup/0.2.x.rst rename to source/user-manual/initial-setup.rst index a0eadc7..225b79f 100644 --- a/source/getting-started/setup/0.2.x.rst +++ b/source/user-manual/initial-setup.rst @@ -1,38 +1,34 @@ -************** -Version 0.2.x -************** +.. _initial-setup: -Ensure your phone is connected to the same WiFi network as your router. +************* +Initial Setup +************* -Power On -======== - -Connect your Embassy to power and Ethernet using the provided cables. - -.. admonition:: Tips - :class: toggle expand - - Ethernet cable may be plugged into your router or any live Ethernet port. - - You will hear 2 distinct sounds - - * bep ‐ Powering on - - * chime ‐ Embassy is ready - -Setup App -========= - -Download the "Start9 Setup App" +Download the Setup App +====================== `App Store `_ `Google Play `_ +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. Inside the Setup App, enter the product key located on the bottom of 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 @@ -43,8 +39,10 @@ Claim Your Embassy :class: toggle expand #. Confirm that the Embassy is plugged into both power and Ethernet. - #. Confirm the Embassy emitted a two sounds when powering on: a bep and a chime. + #. 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 connected to a "Guest" network + #. 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. @@ -56,7 +54,7 @@ Claim Your Embassy * 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. -2. Create your all powerful and irreplaceable master password +3. Create your *permanent* master password and complete setup. .. admonition:: Explanation :class: toggle expand @@ -64,17 +62,14 @@ Claim Your Embassy 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. - * Your master password, used by the Embassy to authenticate you as its one and only master. If you lose this password, there is no way to access your Embassy ever again. You will be forced to reset the device, resulting in permanent loss of data. + * 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. -.. admonition:: Tips - :class: toggle expand - - Choose a strong master password. Physically write it down. Store it somewhere safe. DO NOT LOSE IT. +.. 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 ``.onion`` URL from any Tor-enabled browser. The Setup App contains our recommendations for various devices. \ No newline at end of file +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. diff --git a/source/user-manuals/embassyos/services/backups.rst b/source/user-manual/managing-services/backups.rst similarity index 100% rename from source/user-manuals/embassyos/services/backups.rst rename to source/user-manual/managing-services/backups.rst diff --git a/source/user-manuals/embassyos/services/index.rst b/source/user-manual/managing-services/index.rst similarity index 90% rename from source/user-manuals/embassyos/services/index.rst rename to source/user-manual/managing-services/index.rst index 99430a0..3ad560a 100644 --- a/source/user-manuals/embassyos/services/index.rst +++ b/source/user-manual/managing-services/index.rst @@ -1,14 +1,11 @@ -******** -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. .. 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 diff --git a/source/user-manuals/embassyos/services/installing.rst b/source/user-manual/managing-services/installing.rst similarity index 79% rename from source/user-manuals/embassyos/services/installing.rst rename to source/user-manual/managing-services/installing.rst index 7bd14ee..d9ee6c1 100644 --- a/source/user-manuals/embassyos/services/installing.rst +++ b/source/user-manual/managing-services/installing.rst @@ -7,11 +7,11 @@ Install / Uninstall Installing ========== -To add a new service, find it's listing inside the Service Marketplace: ``Marketplace > [Service Name] > Install``. +To add a new service, find it's listing inside the Service Marketplace: *Marketplace > [Service Name] > Install*. Depending on the size of the service and your Internet connection, installation should take between 60 seconds and a few minutes. -After installation, you can view the service's instructions by navigating to ``Services > [Service Name] > Instructions`` +After installation, you can view the service's instructions by navigating to *Services > [Service Name] > Instructions* .. note:: You can only start and use a service once its dependencies are met, its :ref:`configuration` complete, and is in a *running* state. @@ -21,10 +21,10 @@ Updating To see if an update is available for a service, you can click the *refresh* button inside the dashboard of the installed service or by visiting its listing in the Service Marketplace. -If an update is available, simply click ``Update`` and confirm the action. +If an update is available, simply click "Update" and confirm the action. Uninstalling ============ -To remove a service, navigate to ``Services > [Service Name] > Uninstall``. \ No newline at end of file +To remove a service, navigate to *Services > [Service Name] > Uninstall*. \ No newline at end of file diff --git a/source/user-manuals/embassyos/services/instructions.rst b/source/user-manual/managing-services/instructions.rst similarity index 80% rename from source/user-manuals/embassyos/services/instructions.rst rename to source/user-manual/managing-services/instructions.rst index 47b9825..b7f1d5e 100644 --- a/source/user-manuals/embassyos/services/instructions.rst +++ b/source/user-manual/managing-services/instructions.rst @@ -2,7 +2,7 @@ Instructions ************ -To view the instructions for a particular service, navigate to ``Services > [Service Name] > Instructions``. +To view the instructions for a particular service, navigate to *Services > [Service Name] > Instructions*. .. figure:: /_static/images/bitcoin_instructions.png :width: 90% diff --git a/source/user-manuals/embassyos/services/logs.rst b/source/user-manual/managing-services/logs.rst similarity index 86% rename from source/user-manuals/embassyos/services/logs.rst rename to source/user-manual/managing-services/logs.rst index d347bfc..9ea5d56 100644 --- a/source/user-manuals/embassyos/services/logs.rst +++ b/source/user-manual/managing-services/logs.rst @@ -2,6 +2,6 @@ Viewing Logs ************ -``Services > [Service Name] > Logs`` +Naviage to *Services > [Service Name] > Logs* Every service emits logs while it is in a *running* state. Logs give an *under-the-hood* glimpse of a service and can be extremely useful for debugging purposes. To a non-technical user, logs may look like gibberish, and sometimes there is nothing to see at all. \ No newline at end of file diff --git a/source/user-manuals/embassyos/services/managing-deps.rst b/source/user-manual/managing-services/managing-deps.rst similarity index 100% rename from source/user-manuals/embassyos/services/managing-deps.rst rename to source/user-manual/managing-services/managing-deps.rst diff --git a/source/user-manuals/embassyos/services/properties.rst b/source/user-manual/managing-services/properties.rst similarity index 89% rename from source/user-manuals/embassyos/services/properties.rst rename to source/user-manual/managing-services/properties.rst index d633795..905fa50 100644 --- a/source/user-manuals/embassyos/services/properties.rst +++ b/source/user-manual/managing-services/properties.rst @@ -2,7 +2,7 @@ Properties ********** -``Services > [Service Name] > Properties`` +Navigate to *Services > [Service Name] > Properties* Properties are both static and dynamic information about a service. They could be almost anything: a default username/password, an invite code, or a list of peers - anything the service developer thought might be useful. diff --git a/source/user-manuals/embassyos/services/service-config.rst b/source/user-manual/managing-services/service-config.rst similarity index 93% rename from source/user-manuals/embassyos/services/service-config.rst rename to source/user-manual/managing-services/service-config.rst index 9906cf5..41419a2 100644 --- a/source/user-manuals/embassyos/services/service-config.rst +++ b/source/user-manual/managing-services/service-config.rst @@ -4,7 +4,7 @@ Service Config ************** -``Services > [Service Name] > Config`` +Navigate to *Services > [Service Name] > Config* After installation or update, some services require configuration before they can be started. diff --git a/source/user-manuals/available-services/index.rst b/source/user-manuals/available-services/index.rst deleted file mode 100644 index 6e0fa9d..0000000 --- a/source/user-manuals/available-services/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _available-services: - -****************** -Available Services -****************** - -A list of currently released services for EmbassyOS. Links to the wrapper repository that contains advanced instructions and integration guides. - - `Bitcoin `_ - - `Bitwarden `_ - - `Cups `_ - - `File Browser `_ \ No newline at end of file diff --git a/source/user-manuals/embassyos/index.rst b/source/user-manuals/embassyos/index.rst deleted file mode 100644 index f745da7..0000000 --- a/source/user-manuals/embassyos/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -********* -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 - - general/index - services/index \ No newline at end of file