diff --git a/README.md b/README.md index 9d116b6..00c2bde 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,10 @@ At Start9, we see great value in maintaining clear and accurate documentation fo ## Runbook -This project uses [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html) and [Restructured Text](https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html) +This project uses: +- [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html) +- [Restructured Text](https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html) +- [Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/) ### Dependencies @@ -14,7 +17,7 @@ Install sphinx and dependencies: ``` brew install sphinx-doc pip3 install sphinx-autobuild -pip3 install sphinx-book-theme +pip3 install sphinx-book-theme || pip install git+https://github.com/executablebooks/sphinx-book-theme.git@master ``` ### Development diff --git a/source/_static/default.css b/source/_static/default.css index 24ebebf..3f61bb2 100644 --- a/source/_static/default.css +++ b/source/_static/default.css @@ -69,7 +69,7 @@ h1, h2 { @media (min-width: 768px) { .bd-sidebar { - border-right: 1px solid #f8f8ff; + border-right: 0.5px solid #f8f8ff; background: none; } } @@ -175,4 +175,19 @@ nav.bd-links > ul.nav { .set-padding { padding-top: 75px!important; +} + +/* MISC */ + +.hidden { + display: none!important; +} + +.navbar-brand-box a.navbar-brand { + width: 75%; + height: auto; +} + +.navbar-brand-box { + text-align: center; } \ No newline at end of file diff --git a/source/_static/images/embassy_lan_setup.png b/source/_static/images/embassy_lan_setup.png index 3b99da6..0919d7b 100644 Binary files a/source/_static/images/embassy_lan_setup.png and b/source/_static/images/embassy_lan_setup.png differ diff --git a/source/_static/images/embassy_version.png b/source/_static/images/embassy_version.png deleted file mode 100644 index b908655..0000000 Binary files a/source/_static/images/embassy_version.png and /dev/null differ diff --git a/source/_static/images/secure_lan_setup_page.png b/source/_static/images/secure_lan_setup_page.png index 7be707e..0202f83 100644 Binary files a/source/_static/images/secure_lan_setup_page.png and b/source/_static/images/secure_lan_setup_page.png differ diff --git a/source/_static/images/secure_lan_setup_prompt.png b/source/_static/images/secure_lan_setup_prompt.png index 770d4db..a23c597 100644 Binary files a/source/_static/images/secure_lan_setup_prompt.png and b/source/_static/images/secure_lan_setup_prompt.png differ diff --git a/source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG b/source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG index 766dd8a..19def4e 100644 Binary files a/source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG and b/source/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG differ diff --git a/source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG b/source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG index 8e9e189..d077c5e 100644 Binary files a/source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG and b/source/_static/images/ssl/mobile/ssl_setup_app_complete.PNG differ diff --git a/source/_static/images/ssl/windows/windows_download_cert.png b/source/_static/images/ssl/windows/windows_download_cert.png index f4abfc4..249eabe 100644 Binary files a/source/_static/images/ssl/windows/windows_download_cert.png and b/source/_static/images/ssl/windows/windows_download_cert.png differ diff --git a/source/_static/images/ssl/windows/windows_embassy_menu.png b/source/_static/images/ssl/windows/windows_embassy_menu.png deleted file mode 100644 index 74fb642..0000000 Binary files a/source/_static/images/ssl/windows/windows_embassy_menu.png and /dev/null differ diff --git a/source/_static/images/ssl/windows/windows_lan_page.png b/source/_static/images/ssl/windows/windows_lan_page.png deleted file mode 100644 index 330b8ee..0000000 Binary files a/source/_static/images/ssl/windows/windows_lan_page.png and /dev/null differ diff --git a/source/_static/js/main.js b/source/_static/js/main.js index 877a572..a3487bf 100644 --- a/source/_static/js/main.js +++ b/source/_static/js/main.js @@ -1,6 +1,8 @@ $(document).ready(function () { // open external links in separate tab $('a[href^="http://"], a[href^="https://"]').not('a[class*=internal]').attr('target', '_blank'); + $(".fa-arrow-left").attr("class", "fas fa-times"); + $(".fa-arrow-up").attr("class", "fas fa-times"); // toggle hidable sections $(".toggle > *").hide(); $(".toggle .admonition-title").show(); @@ -8,12 +10,17 @@ $(document).ready(function () { $(this).parent().children().not(".admonition-title").toggle(400); $(this).parent().children(".admonition-title").toggleClass("open"); }) + $('.site-navigation').removeClass('collapsing'); + $('.site-navigation').removeClass('collapse'); + $('.site-navigation').addClass('show'); + // initially hide menu close button + $('.fa-times').addClass('hidden'); + $('#navbar-toggler').click(function() { + // toggle menu open/close button depending on collapsed state + if ($('#navbar-toggler').hasClass("collapsed")) { + $('.fa-times').removeClass('hidden'); + } else { + $('.fa-times').addClass('hidden'); + } + }); }); -// $(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 efb5ffe..da08e3a 100644 --- a/source/conf.py +++ b/source/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- project = 'Start9 Labs' -copyright = '2020, Start9 Labs, Inc' +copyright = '2021, Start9 Labs, Inc' # -- General configuration --------------------------------------------------- @@ -42,24 +42,10 @@ exclude_patterns = [] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -# -# import sphinx_press_theme -# html_theme_path = [sphinx_press_theme.get_html_theme_path()] -# import sphinxbootstrap4theme html_theme = 'sphinx_book_theme' - -# possible alternative themes: -# sphinxawesome_theme -# pydata_sphinx_theme -# sphinx_material -# pytorch_sphinx_theme -# sphinx-typlog-theme -# sphinx-press-theme -# msmb_theme -# sphinx-glpi-theme -# sphinx-material - +html_copy_source = True +html_last_updated_fmt = "" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -75,6 +61,11 @@ html_theme_options = { "use_repository_button": True, "extra_navbar": "", "show_navbar_depth": 1, + "use_download_button": False, + "use_edit_page_button": True, + "launch_buttons": { + "main_site": "https://start9labs.com", + }, } html_logo = "_static/logo.png" html_title = "Docs" diff --git a/source/misc-guides/tor-firefox/android.rst b/source/misc-guides/tor-firefox/android.rst index 008c3aa..c496831 100644 --- a/source/misc-guides/tor-firefox/android.rst +++ b/source/misc-guides/tor-firefox/android.rst @@ -5,50 +5,42 @@ 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. + This guide assumes you have completed :ref:`setting up Tor for Android`. Please visit this section before proceeding 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. +Once Tor is setup on your system, you can proceed to setup Firefox: -Navigate to `Network & Internet > Advanced > Private DNS` and toggle Private DNS Mode "off". +#. Download `Firefox Beta `_ from the Play Store, or `Fennec `_ from F-Droid. -.. figure:: /_static/images/tor/private_dns_off.png - :width: 50% - :alt: Private DNS toggle +#. Next, download a `Proxy Auto Config` file that will use Orbot to resolve `.onion` URLs. We have one hosted `here `_. -Next, you can proceed to setup Firefox. +#. Navigate to ``about:config`` in the Firefox URL bar: -Download `Firefox Beta `_ from the Play Store, or `Fennec `_ from F-Droid. + .. figure:: /_static/images/tor/about_config.png + :width: 50% + :alt: Firefox about config -Now, you need to download a `Proxy Auto Config` file that will use Orbot to resolve `.onion` URLs. We have one hosted `here `_. +#. 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``: -Next, navigate to ``about:config`` in the Firefox URL bar: + .. figure:: /_static/images/tor/network_proxy_type.png + :width: 50% + :alt: Firefox network proxy type setting screenshot -.. 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``: +#. 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``: +#. 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 + .. 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``. +#. 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 + .. 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. +#. 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/linux.rst b/source/misc-guides/tor-firefox/linux.rst index 8105074..67dc237 100644 --- a/source/misc-guides/tor-firefox/linux.rst +++ b/source/misc-guides/tor-firefox/linux.rst @@ -7,48 +7,50 @@ 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. +#. Open Firefox. -Enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings. +#. 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``. +#. 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 + .. 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: +#. 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:: + .. code-block:: - sudo wget -P /etc/tor https://registry.start9labs.com/sys/proxy.pac + sudo wget -P /etc/tor https://registry.start9labs.com/sys/proxy.pac -Now open your Firefox web browser, and select preferences: +#. Now open your Firefox web browser, and select preferences: -.. figure:: /_static/images/tor/firefox_preferences.png - :width: 80% - :alt: Firefox preferences screenshot + .. figure:: /_static/images/tor/firefox_preferences.png + :width: 80% + :alt: Firefox preferences screenshot - Select :menuselection:`Settings --> Preferences` + Select :menuselection:`Settings --> Preferences` -Search for the term “proxy” in the search bar in the upper right, then select the button that says `Settings…`: +#. 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 + .. 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: +#. This should open a menu that will allow you to configure your proxy settings. Select `Automatic proxy configuration URL` and paste in: -.. code-block:: + .. code-block:: - file:///etc/tor/proxy.pac + file:///etc/tor/proxy.pac -Then, check the box labeled `Proxy DNS when using SOCKS v5`: +#. Check the box labeled `Proxy DNS when using SOCKS v5`: -.. figure:: /_static/images/tor/firefox_proxy.png - :width: 80% - :alt: Firefox proxy settings screenshot + .. 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. +#. 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 +#. 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 index 38be650..9d8e0a7 100644 --- a/source/misc-guides/tor-firefox/mac.rst +++ b/source/misc-guides/tor-firefox/mac.rst @@ -7,56 +7,58 @@ 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. +#. Open Firefox. -Enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings. +#. 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``. +#. 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 + .. 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. +#. Next, download the `Proxy Auto Config` file. This file tells Firefox which URLs to use for Tor. + + #. 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: + #. Enter into the terminal: -.. code-block:: + .. code-block:: - brew install wget + brew install wget -And then: + #. And then: -.. code-block:: + .. code-block:: - wget -P /usr/local/etc/tor https://registry.start9labs.com/sys/proxy.pac + wget -P /usr/local/etc/tor https://registry.start9labs.com/sys/proxy.pac -Now open your Firefox web browser, and select preferences: +#. Open your Firefox web browser, and select preferences: -.. figure:: /_static/images/tor/firefox_preferences.png - :width: 80% - :alt: Firefox preferences screenshot + .. figure:: /_static/images/tor/firefox_preferences.png + :width: 80% + :alt: Firefox preferences screenshot - Select :menuselection:`Settings --> Preferences` + Select :menuselection:`Settings --> Preferences` -Search for the term “proxy” in the search bar in the upper right, then select the button that says `Settings…`: +#. 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 + .. 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: +#. This should open a menu that will allow you to configure your proxy settings. Select `Automatic proxy configuration URL` and paste in: -.. code-block:: + .. code-block:: - file:///usr/local/etc/tor/proxy.pac + file:///usr/local/etc/tor/proxy.pac -Then, check the box labeled `Proxy DNS when using SOCKS v5`: +#. 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 + .. 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. +#. 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 +#. 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 index ec60b7f..f4a4cdd 100644 --- a/source/misc-guides/tor-firefox/windows.rst +++ b/source/misc-guides/tor-firefox/windows.rst @@ -7,48 +7,48 @@ 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. +#. Open Firefox. -Enter ``about:config`` in the URL bar. Accept any warnings that may appear about accessing advanced settings. +#. 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``. +#. 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 + .. 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: +#. 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:: + .. code-block:: - C:\Program Files\Tor Browser\proxy.pac + C:\Program Files\Tor Browser\proxy.pac -Now open your Firefox web browser, and select options: +#. Now open your Firefox web browser, and select options: -.. figure:: /_static/images/tor/firefox_options_windows.png - :width: 80% - :alt: Firefox options screenshot + .. figure:: /_static/images/tor/firefox_options_windows.png + :width: 80% + :alt: Firefox options screenshot - Select :menuselection:`Settings --> Options` + Select :menuselection:`Settings --> Options` -Search for the term “proxy” in the search bar in the upper right, then select the button that says `Settings…`: +#. 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 + .. 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: +#. 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:: - file://C:/Program Files/Tor Browser/proxy.pac + file://C:/Program Files/Tor Browser/proxy.pac -Then, check the box labeled `Proxy DNS when using SOCKS v5`: +#. Check the box labeled `Proxy DNS when using SOCKS v5`: -.. figure:: /_static/images/tor/firefox_proxy.png - :width: 80% - :alt: Firefox proxy settings screenshot + .. 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. +#. 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 +#. 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 index 1f659c3..45bfa74 100644 --- a/source/misc-guides/tor-os/android.rst +++ b/source/misc-guides/tor-os/android.rst @@ -4,42 +4,44 @@ Running Tor on Android ********************** -First, install the Tor proxy service to your system. To do so, download Orbot from the `Play Store `_ , or from `F-Droid `_ . Once you have done so, launch Orbot. +#. First, install the Tor proxy service to your system. To do so, download Orbot from the `Play Store `_ , or from `F-Droid `_ . Once you have done so, launch Orbot. -Next, open the kebab menu in the upper right hand corner and select `Settings`: +#. Once you have done so, launch Orbot. -.. figure:: /_static/images/tor/orbot_menu.png - :width: 50% - :alt: Orbot menu +#. Next, open the kebab menu in the upper right hand corner and select `Settings`: -Then, make sure the options for `Start Orbot on Boot` and `Allow Background Starts` are checked: + .. figure:: /_static/images/tor/orbot_menu.png + :width: 50% + :alt: Orbot menu -.. figure:: /_static/images/tor/orbot_settings.png - :width: 50% - :alt: Orbot settings +#. Then, make sure the options for `Start Orbot on Boot` and `Allow Background Starts` are checked: -Go back, and tap start: + .. figure:: /_static/images/tor/orbot_settings.png + :width: 50% + :alt: Orbot settings -.. figure:: /_static/images/tor/orbot_start.png - :width: 50% - :alt: Orbot start +#. Go back, and tap start: -Orbot will start up the Tor service. Once complete, you will see: + .. figure:: /_static/images/tor/orbot_start.png + :width: 50% + :alt: Orbot start -.. figure:: /_static/images/tor/orbot_started.png - :width: 50% - :alt: Orbot started +#. Orbot will start up the Tor service. Once complete, you will see: -You can now close Orbot. + .. figure:: /_static/images/tor/orbot_started.png + :width: 50% + :alt: Orbot started + +#. You can now close Orbot. It will continue running in the background. Setting up Orbot VPN mode ------------------------- -Orbot's VPN mode allows certain applications to utilize it's Tor service. +Orbot's VPN mode allows certain applications to utilize it's Tor service. To setup: -This process also applies for GrapheneOS. +#. First disable Private DNS on your device. To do so, navigate to: -To setup, first disable Private DNS on your device. To do so, navigate to: ``Settings > Network & Internet > Advanced > Private DNS > Off`` + ``Settings > Network & Internet > Advanced > Private DNS > Off`` .. figure:: /_static/images/tor/private_dns_off.png :width: 50% @@ -47,7 +49,7 @@ To setup, first disable Private DNS on your device. To do so, navigate to: ``Set Toggle Private DNS to "off" -Next, launch Orbot and toggle VPN Mode on while on the main screen: +#. Next, launch Orbot and toggle VPN Mode on while on the main screen: .. figure:: /_static/images/tor/orbot_vpn.png :width: 50% @@ -65,3 +67,9 @@ Examples of applications that need this feature are: - Bitwarden - Zap +- Zeus + +You can also add the following browsers to the Tor-Enabled Apps list to easily access Tor addresses (`.onion` URLs): + +- Chrome +- Brave \ No newline at end of file diff --git a/source/misc-guides/tor-os/linux.rst b/source/misc-guides/tor-os/linux.rst index 8e7b9f4..59c2d32 100644 --- a/source/misc-guides/tor-os/linux.rst +++ b/source/misc-guides/tor-os/linux.rst @@ -4,10 +4,10 @@ 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: +#. Install the Tor proxy service to your system. To do so, open your terminal and run the following command: -.. code-block:: + .. 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 +#. 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 index 8784ab3..e051d54 100644 --- a/source/misc-guides/tor-os/mac.rst +++ b/source/misc-guides/tor-os/mac.rst @@ -4,37 +4,36 @@ 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. -To open your terminal, hold the command key ⌘ + spacebar. `Spotlight Search` will appear. Start typing "terminal" and select the program called `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 . -Paste in the following commands and hit . - -.. code-block:: + .. 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: +#. When this completes, you should see something like: -.. code-block:: + .. 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: +#. If you notice issues connecting to Tor websites, try restarting the Tor service. Open the terminal and run: -.. code-block:: + .. code-block:: brew services restart tor -After running this command, you should see something like: +#. After running this command, you should see something like: -.. code-block:: + .. 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 +#. 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 index 6166e76..4b9284f 100644 --- a/source/misc-guides/tor-os/windows.rst +++ b/source/misc-guides/tor-os/windows.rst @@ -4,39 +4,43 @@ 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 `_. +#. 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 + .. figure:: /_static/images/tor/tor_download_windows.png + :width: 80% + :alt: Tor download - Download Tor for Windows + 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: +#. 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`. -.. figure:: /_static/images/tor/tor_windows_install.png - :width: 80% - :alt: Tor install wizard +#. Once you have selected a language, you should see a menu like this: - Note Tor destination folder when installing + .. figure:: /_static/images/tor/tor_windows_install.png + :width: 80% + :alt: Tor install wizard -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. + Note Tor destination folder when installing -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 ````: +#. 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. -.. code-block:: +#. 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: +#. When you run this, it should look something like this: -.. figure:: /_static/images/tor/tor_windows_terminal.png - :width: 80% - :alt: Tor windows terminal + .. figure:: /_static/images/tor/tor_windows_terminal.png + :width: 80% + :alt: Tor windows terminal - Replace highlighted section with noted destination folder + 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 +#. That's it! Your Windows computer is now setup to natively use Tor. \ No newline at end of file diff --git a/source/user-manual/general/index.rst b/source/user-manual/general/index.rst index 87c32ca..57d51f5 100644 --- a/source/user-manual/general/index.rst +++ b/source/user-manual/general/index.rst @@ -13,5 +13,5 @@ An overview of EmbassyOS general capabilities. developer-options/index power notifications - secure-lan/index + lan-setup/index forgot-password \ No newline at end of file diff --git a/source/user-manual/general/secure-lan/browser.rst b/source/user-manual/general/lan-setup/browser.rst similarity index 98% rename from source/user-manual/general/secure-lan/browser.rst rename to source/user-manual/general/lan-setup/browser.rst index c6607ff..a84c598 100644 --- a/source/user-manual/general/secure-lan/browser.rst +++ b/source/user-manual/general/lan-setup/browser.rst @@ -6,6 +6,8 @@ Browser .. warning:: Make sure you have completed setup on your :ref:`device ` before continuing! +.. _brave: + Brave ===== @@ -33,6 +35,8 @@ Brave 8. Additionally, you can start a Brave private window with Tor to visit the Tor address over HTTPS (unnecessary in principle, but will circumvent annoying browser warnings). +.. _chrome: + Chrome ====== @@ -42,6 +46,8 @@ Chrome 3. You can now securely navigate to your Embassy over HTTPS! +.. _firefox: + Firefox ======== @@ -79,6 +85,8 @@ Firefox 11. You can now securely navigate to your Embassy over HTTPS! +.. _safari: + Safari ====== diff --git a/source/user-manual/general/lan-setup/desktop.rst b/source/user-manual/general/lan-setup/desktop.rst new file mode 100644 index 0000000..71610de --- /dev/null +++ b/source/user-manual/general/lan-setup/desktop.rst @@ -0,0 +1,196 @@ +******** +Desktop +******** + +Operating Systems +================= + +MacOS +----- + +1. Visit your Embassy at its Tor Address. + +2. Navigate to --> Embassy --> Connect Over LAN + +.. figure:: /_static/images/embassy_lan_setup.png + :width: 90% + :alt: LAN setup menu item + + Select the "Connect over LAN" menu item + +3. Select the "Root Certificate Authority" sub menu. This will prompt a download to save the certificate file to your machine. + +.. figure:: /_static/images/secure_lan_setup_page.png + :width: 90% + :alt: LAN setup page + + Select the "Root Certificate Authority" sub menu + +4. Select the option to open your key with Keychain Access. If you choose to save file, double click on it once downloaded. + +.. figure:: /_static/images/secure_lan_setup_prompt.png + :width: 90% + :alt: LAN setup prompt + + Open with "Keychain Access" and select "OK" + +5. Enter your computer password when prompted. It will be imported into your computer’s keychain. + +.. figure:: /_static/images/ssl/macos/certificate_untrusted.png + :width: 90% + :alt: Keychain access import menu + + Keychain access import menu + +If the keychain console did not open, press "Command + spacebar" and type “Keychain Access”, and hit enter to open it. + +6. Navigate to the "System" tab and find the certificate entitled “Embassy Local Root CA”. + +7. Double click on this certificate. A second window will pop up. + +8. Open the “Trust” dropdown and select “Always Trust” from the dropdown next to “when using this certificate”. + +.. figure:: /_static/images/ssl/macos/always_trust.png + :width: 90% + :alt: Keychain submenu + + Select "Always trust" under SSL dropdown for Embassy Local CA + +9. Close this window and enter your password to apply the settings. + +10. The “Embassy Local Root CA” cert will now read “This certificate is marked as trusted for all users” in Keychain Access. + +.. figure:: /_static/images/ssl/macos/certificate_trusted.png + :width: 90% + :alt: Keychain menu trusted certificate + + Trusted Embassy Local CA certificate + +11. Open to your favorite browser to import this certificate and follow the steps for :ref:`supported browsers `. + +Windows +------- + +1. Install `Bonjour Print Services `_ on your Windows machine. This is necessary in order to visit .local addresses on Windows. + +2. Visit your Embassy at its Tor Address. + +3. Navigate to --> Embassy --> Connect Over LAN + +.. figure:: /_static/images/embassy_lan_setup.png + :width: 90% + :alt: LAN setup menu item + + Select the "Connect over LAN" menu item + +4. Select the "Root Certificate Authority" sub menu. This will prompt a download to save the certificate file to your machine. + +.. figure:: /_static/images/secure_lan_setup_page.png + :width: 90% + :alt: LAN setup page + + Select the "Root Certificate Authority" sub menu download icon + +5. Select the option to save the *Embassy Local CA.crt* file. + +.. figure:: /_static/images/ssl/windows/windows_download_cert.png + :width: 90% + :alt: LAN setup prompt + + "Save file" when Opening Embassy Local CA.crt + +6. On your computer, right-click the “Start” menu and select “Run”. + +7. Type in “mmc” and click “OK”. When prompted on the “User Account Control” window, select “Yes” to allow this program to run. + +.. figure:: /_static/images/ssl/windows/1_windows_mmc.png + :width: 90% + :alt: Windows MMC + + Access the Windows Management Console + +8. When the Management Console opens, navigate to *File > Add/Remove Snap-in*. + +.. figure:: /_static/images/ssl/windows/2_windows_console_root.png + :width: 90% + :alt: Windows Console Root + + Add Snap-in from Console Root + +9. Select “Certificates” in the left side menu, then “Add”. This will open another window. + +.. figure:: /_static/images/ssl/windows/3_windows_add_certificates.png + :width: 90% + :alt: Add Certificates + + Add Certificates to selected snap-ins + +10. Select “Computer account” and click “Next. Leave defaulted options on the next screen and click “Finish”. + +11. When you return to the “Add or Remove Snap-ins” page, ensure “Certificates (Local Computer)” exists under “Console Root” in the “Selected snap-ins” section, then click “OK”. + +.. figure:: /_static/images/ssl/windows/4_windows_selected_snapin.png + :width: 90% + :alt: Snap-in Selected + + Certificates (Local Computer) is selected as snap-in + +12. In the left hand menu of the Management Console, navigate to Certificates (Local Computer) > Trusted Root Certification Authorities > Certificates. + +.. figure:: /_static/images/ssl/windows/5_windows_trusted_certificate_menu.png + :width: 90% + :alt: Certificates in Management Console + + Access Certificates in Management Console + +13. Right click on “Certificates”, then navigate to *All Tasks > Import*. + +.. figure:: /_static/images/ssl/windows/6_windows_import_cert.png + :width: 90% + :alt: Import certificate + + Select "Import" from Certificates sub-menu + +14. Click “Next” on the first page of the Certificate Import Wizard, then browse to the location where you saved the downloaded certificate and click “Open”. + +.. figure:: /_static/images/ssl/windows/7_windows_import_cert_wizard.png + :width: 90% + :alt: Import cert wizard + + Add downloaded certificate int he Certificate Import Wizard + +15. On the “Certificate Store” window, ensure that it says “Trusted Root Certificate Authorities” and click “Next”. + +16. Select “OK” when the import is successful. + +17. Verify the Embassy Local Root CA certificate is in the “Certificates” folder. + +.. figure:: /_static/images/ssl/windows/8_windows_successful_cert_install.png + :width: 90% + :alt: Successful cert install + + Embassy Local Root CA imported into Certificate folder + +18. You can save the settings to the console if desired or cancel. + +19. Open to your favorite browser to import this certificate and follow the steps for :ref:`supported browsers `. + +Linux +----- + +Nothing specific needs to be configured for this environment. Follow the guides below to import the certificate into your desired browser. + +Browsers +======== + +Select the browser you would like to configure to import the certificate from your desktop: + +.. toctree:: + :hidden: + + browser + +- :ref:`Brave ` +- :ref:`Chrome ` +- :ref:`Firefox ` +- :ref:`Safari ` \ No newline at end of file diff --git a/source/user-manual/general/lan-setup/index.rst b/source/user-manual/general/lan-setup/index.rst new file mode 100644 index 0000000..ceadd34 --- /dev/null +++ b/source/user-manual/general/lan-setup/index.rst @@ -0,0 +1,15 @@ +.. _ssl-setup: + +********* +LAN Setup +********* + +You can securely access your Embassy over LAN while connected to the same network. This method of communicating with your Embassy is significantly faster than Tor, and it also serves as a fallback in case the Tor network is experiencing connectivity issues. + +The guides below will walk you through the steps to install and trust your Embassy's SSL certificate, such that your communications are encrypted over HTTPS. + +.. toctree:: + :maxdepth: 2 + + desktop + mobile \ No newline at end of file diff --git a/source/user-manual/general/lan-setup/mobile.rst b/source/user-manual/general/lan-setup/mobile.rst new file mode 100644 index 0000000..70e9f7e --- /dev/null +++ b/source/user-manual/general/lan-setup/mobile.rst @@ -0,0 +1,86 @@ +****** +Mobile +****** + +Android +======= + +Unfortunately, LAN addresses (URLs ending in `.local`) are not supported on Android devices. This is because Android does not yet natively support mDNS, which is used to access LAN addresses on mobile device browsers. As a result, you cannot access your Embassy's or service's LAN address from the browser on Android. We are tracking this issue `here `_, please star it to get more attention from the development team! + +iOS +==== + +#. Navigate back to the `Start9 Setup App `_. + +#. Select your claimed Embassy to view the setup results. + +#. 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: 70% + :alt: Setup app complete + + Completed Setup App screen + +#. Select the "Embassy Local Root CA" menu item. Clicking this will prompt you to “Save to device”. + + .. figure:: /_static/images/ssl/mobile/ssl_setup_app_advanced.png + :width: 70% + :alt: Setup app advanced menu + + Setup App advanced menu + +#. You will be directed to a page in your default browser indicating next steps and that the profile has been successfully downloaded. + + .. note:: + If you have changed the default browser from Safari to Brave, the following auto save certificate to device flow will *not* work. Safari, Firefox, and Chrome work as expected. We recommend you temporarily use one of these browsers to complete this action. + +#. Be sure to complete all steps in this process! These steps are also outlined below. + + .. figure:: /_static/images/ssl/mobile/ssl_certificate_install_page.png + :width: 70% + :alt: Certificate install page + + Select "Allow" on the certificate install page + +#. Go to Settings on your iOS device. + + .. figure:: /_static/images/ssl/mobile/ssl_ipad_general_settings.png + :width: 70% + :alt: General settings + + General settings + +#. Navigate to *General > Profile(s) > Downloaded Profile > Install*. + + .. figure:: /_static/images/ssl/mobile/ssl_ipad_profiles.png + :width: 70% + :alt: Profiles + + Profiles view + + .. figure:: /_static/images/ssl/mobile/ssl_ipad_install_profile.png + :width: 70% + :alt: Install profile + + Select "Install" for Embassy Local Root CA + +#. Select “yes” to any warning prompts. + +#. Next, navigate to *General > About > Certificate Trust Settings*. + + .. figure:: /_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.png + :width: 70% + :alt: Certificate trust settings + + Select Certificate Trust Settings (scroll all the way down) + +#. Enable full trust for root certificates. + + .. figure:: /_static/images/ssl/mobile/ssl_ipad_cert_trust.png + :width: 70% + :alt: Enable full trust + + Toggle to enable full trust for root certificates. "Continue" when warning prompts. + +#. Test that this process worked successfully by navigating to the LAN address provided in the Setup App. You should no longer see warnings about the security of this site in your browser. We recommend using Start9’s own `Consulate browser `_ for a faster and better experience. \ No newline at end of file diff --git a/source/user-manual/general/secure-lan/desktop.rst b/source/user-manual/general/secure-lan/desktop.rst deleted file mode 100644 index 6e0b8f0..0000000 --- a/source/user-manual/general/secure-lan/desktop.rst +++ /dev/null @@ -1,196 +0,0 @@ -******** -Desktop -******** - -MacOS -===== - -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*. - -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. - -5. Login to Ambassador UI with the master password you created in the Setup App. - -6. Navigate to the “Embassy” tab in the menu. - -7. Find the section entitled “Secure LAN Setup”. - -.. figure:: /_static/images/embassy_lan_setup.png - :width: 90% - :alt: Secure LAN setup menu item - - Select the "Secure LAN Setup" menu item - -8. Select the "SSL Certificate" sub menu. This will prompt a download to save the certificate file to your machine. - -.. figure:: /_static/images/secure_lan_setup_page.png - :width: 90% - :alt: Secure LAN setup page - - Select the "SSL Certificate" sub menu - -9. Select the option to open your key with Keychain Access. If you choose to save file, double click on it once downloaded. - -.. figure:: /_static/images/secure_lan_setup_prompt.png - :width: 90% - :alt: Secure LAN setup prompt - - Open with "Keychain Access" and select "OK" - -10. Enter your computer password when prompted. It will be imported into your computer’s keychain. - -.. figure:: /_static/images/ssl/macos/certificate_untrusted.png - :width: 90% - :alt: Keychain access import menu - - Keychain access import menu - -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”. - -12. Double click on this certificate. A second window will pop up. - -13. Open the “Trust” dropdown and select “Always Trust” from the dropdown next to “when using this certificate”. - -.. figure:: /_static/images/ssl/macos/always_trust.png - :width: 90% - :alt: Keychain submenu - - Select "Always trust" under SSL dropdown for Embassy Local CA - -14. Close this window and enter your password to apply the settings. - -15. The “Embassy Local Root CA” cert will now read “This certificate is marked as trusted for all users” in Keychain Access. - -.. figure:: /_static/images/ssl/macos/certificate_trusted.png - :width: 90% - :alt: Keychain menu trusted certificate - - Trusted Embassy Local CA certificate - -16. Navigate to your desired browser to import this certificate and follow the steps for :ref:`supported browsers `. - -Windows -======= - -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*. - -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. - -5. Login to Ambassador UI with the master password you created in the Setup App. - -6. Navigate to the “Embassy” tab in the menu. - -7. Find the section entitled “Secure LAN Setup”. - -.. figure:: /_static/images/ssl/windows/windows_embassy_menu.png - :width: 90% - :alt: Secure LAN setup menu item - - Select the "Secure LAN Setup" menu item - -8. Select the "SSL Certificate" sub menu. This will prompt a download to save the certificate file to your machine. - -.. figure:: /_static/images/ssl/windows/windows_lan_page.png - :width: 90% - :alt: Secure LAN setup page - - Select the "SSL Certificate" sub menu download icon - -9. Select the option to save the *Embassy Local CA.crt* file. - -.. figure:: /_static/images/ssl/windows/windows_download_cert.png - :width: 90% - :alt: Secure LAN setup prompt - - "Save file" when Opening Embassy Local CA.crt - -10. On your computer, right-click the “Start” menu and select “Run”. - -11. Type in “mmc” and click “OK”. When prompted on the “User Account Control” window, select “Yes” to allow this program to run. - -.. figure:: /_static/images/ssl/windows/1_windows_mmc.png - :width: 90% - :alt: Windows MMC - - Access the Windows Management Console - -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% - :alt: Windows Console Root - - Add Snap-in from Console Root - -13. Select “Certificates” in the left side menu, then “Add”. This will open another window. - -.. figure:: /_static/images/ssl/windows/3_windows_add_certificates.png - :width: 90% - :alt: Add Certificates - - Add Certificates to selected snap-ins - -14. Select “Computer account” and click “Next. Leave defaulted options on the next screen and click “Finish”. - -15. When you return to the “Add or Remove Snap-ins” page, ensure “Certificates (Local Computer)” exists under “Console Root” in the “Selected snap-ins” section, then click “OK”. - -.. figure:: /_static/images/ssl/windows/4_windows_selected_snapin.png - :width: 90% - :alt: Snap-in Selected - - Certificates (Local Computer) is selected as snap-in - -16. In the left hand menu of the Management Console, navigate to Certificates (Local Computer) > Trusted Root Certification Authorities > Certificates. - -.. figure:: /_static/images/ssl/windows/5_windows_trusted_certificate_menu.png - :width: 90% - :alt: Certificates in Management Console - - Access Certificates in Management Console - -17. Right click on “Certificates”, then navigate to *All Tasks > Import*. - -.. figure:: /_static/images/ssl/windows/6_windows_import_cert.png - :width: 90% - :alt: Import certificate - - Select "Import" from Certificates sub-menu - -18. Click “Next” on the first page of the Certificate Import Wizard, then browse to the location where you saved the downloaded certificate and click “Open”. - -.. figure:: /_static/images/ssl/windows/7_windows_import_cert_wizard.png - :width: 90% - :alt: Import cert wizard - - Add downloaded certificate int he Certificate Import Wizard - -19. On the “Certificate Store” window, ensure that it says “Trusted Root Certificate Authorities” and click “Next”. - -20. Select “OK” when the import is successful. - -21. Verify the Embassy Local Root CA certificate is in the “Certificates” folder. - -.. figure:: /_static/images/ssl/windows/8_windows_successful_cert_install.png - :width: 90% - :alt: Successful cert install - - Embassy Local Root CA imported into Certificate folder - -22. You can save the settings to the console if desired or cancel. - -23. Navigate to your desired browser to import this certificate and follow the steps for :ref:`supported browsers `. - -Linux -===== - -Please reach out to `@ProofOfKeags `_ on `Telegram `_ if you would like assistance setting up SSL Certificates in this environment. diff --git a/source/user-manual/general/secure-lan/index.rst b/source/user-manual/general/secure-lan/index.rst deleted file mode 100644 index c5ccf37..0000000 --- a/source/user-manual/general/secure-lan/index.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. _ssl-setup: - -**************** -Secure LAN Setup -**************** - -EmbassyOS has ability to securely access your Embassy over HTTPS from any browser in addition to the already secure option of communicating over Tor. This method of connecting is faster when on the same Local Area Network (LAN). This is accomplished by HTTPS using the OpenSSL protocol. Your Embassy becomes a Certificate Authority and uses its root certificate to generate a self-signed cert for you to import on your devices. - -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, found in *Embassy > About > EmbassyOS Version*. - -.. figure:: /_static/images/embassy_version.png - :width: 90% - :alt: EmbassyOS version view - - How to view EmbassyOS version - - -.. warning:: - For EmbassyOS versions <0.2.5, please follow the setup instructions on this `blog post `_. - - -For EmbassyOS versions >=0.2.5, continue completing the setup for your device operating system: - -.. toctree:: - :maxdepth: 2 - - desktop - mobile - -Next, complete the setup for your desired browser. This guide currently covers: - -.. toctree:: - :maxdepth: 2 - - browser - -.. note:: - For security, Secure LAN Setup is only available over the Embassy's Tor address. Ensure you are setup with a :ref:`Tor enabled browser `. \ No newline at end of file diff --git a/source/user-manual/general/secure-lan/mobile.rst b/source/user-manual/general/secure-lan/mobile.rst deleted file mode 100644 index d151da7..0000000 --- a/source/user-manual/general/secure-lan/mobile.rst +++ /dev/null @@ -1,87 +0,0 @@ -****** -Mobile -****** - -iOS -==== - -1. Navigate back to the `Start9 Setup App `_. - -2. Select your claimed Embassy to view the setup results. - -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% - :alt: Setup app complete - - Completed Setup App screen - -4. Select the "Embassy Local Root CA" menu item. Clicking this will prompt you to “Save to device”. - -.. figure:: /_static/images/ssl/mobile/ssl_setup_app_advanced.png - :width: 90% - :alt: Setup app advanced menu - - Setup App advanced menu - -.. note:: At this point, you may see a yellow messaging indicating you need to reclaim your Embassy to activate this feature. Proceed with the recommendation. - -5. You will be directed to a page in Safari indicating next steps and that the profile has been successfully downloaded. Be sure to complete all steps in this process. These steps are also outlined below. - -.. figure:: /_static/images/ssl/mobile/ssl_certificate_install_page.png - :width: 90% - :alt: Certificate install page - - Select "Allow" on the certificate install page - -6. Go to Settings on your iOS device. - -.. figure:: /_static/images/ssl/mobile/ssl_ipad_general_settings.png - :width: 90% - :alt: General settings - - General settings - -7. Navigate to *General > Profile(s) > Downloaded Profile > Install*. - -.. figure:: /_static/images/ssl/mobile/ssl_ipad_profiles.png - :width: 90% - :alt: Profiles - - Profiles view - -.. figure:: /_static/images/ssl/mobile/ssl_ipad_install_profile.png - :width: 90% - :alt: Install profile - - Select "Install" for Embassy Local Root CA - -8. Select “yes” to any warning prompts. - -9. Next, navigate to *General > About > Certificate Trust Settings*. - -.. figure:: /_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.png - :width: 90% - :alt: Certificate trust settings - - Select Certificate Trust Settings (scroll all the way down) - -10. Enable full trust for root certificates. - -.. figure:: /_static/images/ssl/mobile/ssl_ipad_cert_trust.png - :width: 90% - :alt: Enable full trust - - Toggle to enable full trust for root certificates. "Continue" when warning prompts. - -11. Test that this process worked successfully by navigating to the LAN address provided in the Setup App. You should no longer see warnings about the security of this site in your browser. We recommend using Start9’s own `Consulate browser `_ for a faster and better experience. - - -Android -======= - -Unfortunately, Android devices do not yet natively support mDNS, which is used to access LAN addresses on a mobile device browser. As a result, you cannot yet access your LAN address from the browser on Android. We are tracking this issue `here `_, please star it to get more attention from the development team! - -We are also working on the `Consulate `_ for Android, which will enable this feature by default and allow you to bookmark your LAN address for efficient access to your Embassy over HTTPS. -In the meantime, you can access your Embassy on Android using the `Tor Browser `_. \ No newline at end of file