diff --git a/site/03-todo.md b/site/03-todo.md index f6f53cc..88f7ef1 100644 --- a/site/03-todo.md +++ b/site/03-todo.md @@ -1,9 +1,8 @@ # ToDo - [ ] Refactor and update Roadmap -- [ ] Document colours - [ ] Document diagnostic UI -- [ ] Update principles, privacy, about, etc +- [ ] Document Bug Reporting - [ ] Footer links need update (or removal?) - [ ] Add screenshots and details - [ ] Verify ALL links (especially in device guides as they are all external) @@ -16,22 +15,18 @@ - [ ] There are many issues that should be closed by 0.3 docs release, check that this is the case (some issues await new processes in order to test) - [ ] Below checklist (wiped as completed) - diff --git a/site/source/_static/images/embassy_lan_setup.png b/site/source/_static/images/embassy_lan_setup.png deleted file mode 100644 index 0919d7b..0000000 Binary files a/site/source/_static/images/embassy_lan_setup.png and /dev/null differ diff --git a/site/source/_static/images/embassy_lan_setup.svg b/site/source/_static/images/embassy_lan_setup.svg new file mode 100644 index 0000000..c9ec9e8 Binary files /dev/null and b/site/source/_static/images/embassy_lan_setup.svg differ diff --git a/site/source/_static/images/embassy_lan_setup0.svg b/site/source/_static/images/embassy_lan_setup0.svg new file mode 100644 index 0000000..2875585 Binary files /dev/null and b/site/source/_static/images/embassy_lan_setup0.svg differ diff --git a/site/source/_static/images/ssl/windows/1_windows_mmc.png b/site/source/_static/images/ssl/windows/1_windows_mmc.svg similarity index 100% rename from site/source/_static/images/ssl/windows/1_windows_mmc.png rename to site/source/_static/images/ssl/windows/1_windows_mmc.svg diff --git a/site/source/_static/images/ssl/windows/2_windows_console_root.png b/site/source/_static/images/ssl/windows/2_windows_console_root.svg similarity index 100% rename from site/source/_static/images/ssl/windows/2_windows_console_root.png rename to site/source/_static/images/ssl/windows/2_windows_console_root.svg diff --git a/site/source/_static/images/ssl/windows/3_windows_add_certificates.png b/site/source/_static/images/ssl/windows/3_windows_add_certificates.svg similarity index 100% rename from site/source/_static/images/ssl/windows/3_windows_add_certificates.png rename to site/source/_static/images/ssl/windows/3_windows_add_certificates.svg diff --git a/site/source/_static/images/ssl/windows/4_windows_selected_snapin.png b/site/source/_static/images/ssl/windows/4_windows_selected_snapin.svg similarity index 100% rename from site/source/_static/images/ssl/windows/4_windows_selected_snapin.png rename to site/source/_static/images/ssl/windows/4_windows_selected_snapin.svg diff --git a/site/source/_static/images/ssl/windows/5_windows_trusted_certificate_menu.png b/site/source/_static/images/ssl/windows/5_windows_trusted_certificate_menu.svg similarity index 100% rename from site/source/_static/images/ssl/windows/5_windows_trusted_certificate_menu.png rename to site/source/_static/images/ssl/windows/5_windows_trusted_certificate_menu.svg diff --git a/site/source/_static/images/ssl/windows/6_windows_import_cert.png b/site/source/_static/images/ssl/windows/6_windows_import_cert.svg similarity index 100% rename from site/source/_static/images/ssl/windows/6_windows_import_cert.png rename to site/source/_static/images/ssl/windows/6_windows_import_cert.svg diff --git a/site/source/_static/images/ssl/windows/7_windows_import_cert_wizard.png b/site/source/_static/images/ssl/windows/7_windows_import_cert_wizard.svg similarity index 100% rename from site/source/_static/images/ssl/windows/7_windows_import_cert_wizard.png rename to site/source/_static/images/ssl/windows/7_windows_import_cert_wizard.svg diff --git a/site/source/_static/images/ssl/windows/8_windows_successful_cert_install.png b/site/source/_static/images/ssl/windows/8_windows_successful_cert_install.svg similarity index 100% rename from site/source/_static/images/ssl/windows/8_windows_successful_cert_install.png rename to site/source/_static/images/ssl/windows/8_windows_successful_cert_install.svg diff --git a/site/source/_static/images/ssl/windows/windows_download_cert.png b/site/source/_static/images/ssl/windows/windows_download_cert.png deleted file mode 100644 index 249eabe..0000000 Binary files a/site/source/_static/images/ssl/windows/windows_download_cert.png and /dev/null differ diff --git a/site/source/_static/images/tor/tor_download_windows.png b/site/source/_static/images/tor/tor_download_windows.svg similarity index 100% rename from site/source/_static/images/tor/tor_download_windows.png rename to site/source/_static/images/tor/tor_download_windows.svg diff --git a/site/source/_static/images/tor/tor_windows_install.png b/site/source/_static/images/tor/tor_windows_install.svg similarity index 100% rename from site/source/_static/images/tor/tor_windows_install.png rename to site/source/_static/images/tor/tor_windows_install.svg diff --git a/site/source/_static/images/tor/tor_windows_terminal.png b/site/source/_static/images/tor/tor_windows_terminal.svg similarity index 100% rename from site/source/_static/images/tor/tor_windows_terminal.png rename to site/source/_static/images/tor/tor_windows_terminal.svg diff --git a/site/source/support/faq/faq-basic-use.rst b/site/source/support/faq/faq-basic-use.rst index e12e52e..8dded4d 100644 --- a/site/source/support/faq/faq-basic-use.rst +++ b/site/source/support/faq/faq-basic-use.rst @@ -29,7 +29,7 @@ Can I move my Embassy to another location? What happens when I do this? ------------------------------------------------------------------------ Yes, you can move the Embassy to another network. Your service tor addresses will remain the same. Remember that you can only access via LAN if you are accessing with a device on the same network as your Embassy. -What’s the advantage of using the .local address over the .onion address? +What's the advantage of using the .local address over the .onion address? ------------------------------------------------------------------------- If you are in your home/office network with an Embassy, it is both faster and more private since the connection never leaves your household/office. The downside is that it won’t work if you’re on the go. @@ -39,7 +39,7 @@ Unfortunately, no. The Tor Browser requires all web visits to first enter the T Can I use .local addresses on Android? -------------------------------------- -This will depend on your Android device. This support was added in Android 12, but may not yet be added to custom ROMs, such as Calyx, Graphene, or Lineage. Please see :ref:`Android Limitations` for more deatils. +This will depend on your Android device. This support was added in Android 12, but may not yet be added to custom ROMs, such as Calyx, Graphene, or Lineage. Please see :ref:`Android Limitations` for more deatils. Can I have multiple users on my Embassy? ---------------------------------------- @@ -61,7 +61,7 @@ This can be useful, as you may want to wipe a service and start anew. For exampl Do I need to delete existing backups before doing a new backup? Or does a new backup override the old backup? ------------------------------------------------------------------------------------------------------------- -No, you don’t need to delete the old backups. The technology we use updates the existing backup. +No, you don't need to delete the old backups. The technology we use updates the existing backup. Can I clone my Embassy SSD for backup purposes? ----------------------------------------------- diff --git a/site/source/support/faq/faq-troubleshooting.rst b/site/source/support/faq/faq-troubleshooting.rst index 8213b76..cea6c62 100644 --- a/site/source/support/faq/faq-troubleshooting.rst +++ b/site/source/support/faq/faq-troubleshooting.rst @@ -20,9 +20,11 @@ What if I can't connect to my Embassy? -------------------------------------- Please ensure your phone / computer is connected to the same wired or wireless network as your Embassy. Be careful that you are not on a separate or "guest" network. +.. _why-bonjour: + Why do I need the Bonjour service (Windows)? -------------------------------------------- -Because a major use case of Bonjour is wireless printing over the LAN, but your Windows machine can also use Bonjour to discover and connect with other devices on the LAN. In this case the Embassy. +A major use-case of Bonjour is wireless printing over the LAN, but your Windows machine can also use Bonjour to discover and connect with other devices on the :ref:`Local Network`. In this case your Embassy. If Windows were to add support for reaching ``.local`` addresses, as is done in Linux and Mac, this would no longer be necessary. My Tor sites aren't loading, what should I do? ---------------------------------------------- diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-linux.rst b/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-linux.rst index 9310257..a1a73aa 100644 --- a/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-linux.rst +++ b/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-linux.rst @@ -4,24 +4,22 @@ Linux ===== -Nothing specific needs to be configured for this environment, so you just need the certificate from your Embassy. +Nothing specific needs to be configured for the Linux environment, so you just need to download the certificate from your Embassy. #. Visit your Embassy at its Tor Address. -#. Navigate to --> Embassy --> Connect Over LAN + .. note:: Using this encrypted Tor connection is required for security reasons. - .. figure:: /_static/images/embassy_lan_setup.png +#. Navigate to the :ref:`Embassy tab` -> Settings -> LAN + + .. figure:: /_static/images/embassy_lan_setup.svg :width: 90% :alt: LAN setup menu item - Select the "Connect over LAN" menu item +#. Click "Download Root CA". This will prompt a download to save the certificate file to your machine. -#. 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 + .. figure:: /_static/images/embassy_lan_setup0.svg :width: 90% :alt: LAN setup page - Select the "Root Certificate Authority" sub menu - -Then open your favorite browser to import this certificate and follow the steps for :ref:`browser setup `. +Then open your favorite browser to import this certificate and follow the steps for :ref:`browser setup `. diff --git a/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-windows.rst b/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-windows.rst index 6aec652..ad2a194 100644 --- a/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-windows.rst +++ b/site/source/support/user-manual/configuration/lan-setup/lan-os/lan-windows.rst @@ -4,46 +4,39 @@ Windows ======= -#. Install `Bonjour Print Services `_ on your Windows machine. This is necessary in order to visit .local addresses on Windows. -#. If you are having issues running Bonjour after installing, you might have had Bonjour previously installed. To fix: +Unfortunately, Windows does not have mDNS support built-in, which is necessary in order to visit .local addresses, so we recommend using the Bonjour service. Check out this :ref:`FAQ answer` for details. - #. Check out this video: https://www.youtube.com/watch?v=9ECCB3bqNDQ - #. Uninstall Bonjour completely via ``system settings -> remove programs`` - #. Reinstall Bonjour Printer Driver package (download at https://support.apple.com/kb/DL999?locale=en_US) - #. Restart Windows - #. Note: Uninstalling Bonjour via the setup package seems to be not enough to solve the issue. Bonjour must be uninstalled via windows system settings. +#. Install `Bonjour Print Services `_ on your Windows machine. + + .. tip:: If you are experiencing issues after installing Bonjour, you might have had a previous or failed install. To fix: + + #. Check out this video: https://www.youtube.com/watch?v=9ECCB3bqNDQ + #. Uninstall Bonjour completely via ``system settings -> remove programs`` + #. Reinstall Bonjour Printer Driver package (download at https://support.apple.com/kb/DL999?locale=en_US) + #. Restart Windows + #. Note: Uninstalling Bonjour via the setup package seems to be not enough to solve the issue. Bonjour must be uninstalled via windows system settings. #. Visit your Embassy at its Tor Address. -#. Navigate to --> Embassy --> Connect Over LAN + .. note:: Using this encrypted Tor connection is required for security reasons. - .. figure:: /_static/images/embassy_lan_setup.png +#. Navigate to the :ref:`Embassy tab` -> Settings -> LAN + + .. figure:: /_static/images/embassy_lan_setup.svg :width: 90% :alt: LAN setup menu item - Select the "Connect over LAN" menu item +#. Click "Download Root CA". This will prompt a download to save the certificate file to your machine. -#. 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 + .. figure:: /_static/images/embassy_lan_setup0.svg :width: 90% :alt: LAN setup page - Select the "Root Certificate Authority" sub menu download icon - -#. 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 - -#. On your computer, right-click the “Start” menu and select “Run”. +#. Back in Windows, right-click the “Start” menu and select “Run”. #. 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 + .. figure:: /_static/images/ssl/windows/1_windows_mmc.svg :width: 90% :alt: Windows MMC @@ -51,7 +44,7 @@ Windows #. When the Management Console opens, navigate to *File > Add/Remove Snap-in*. - .. figure:: /_static/images/ssl/windows/2_windows_console_root.png + .. figure:: /_static/images/ssl/windows/2_windows_console_root.svg :width: 90% :alt: Windows Console Root @@ -59,7 +52,7 @@ Windows #. Select “Certificates” in the left side menu, then “Add”. This will open another window. - .. figure:: /_static/images/ssl/windows/3_windows_add_certificates.png + .. figure:: /_static/images/ssl/windows/3_windows_add_certificates.svg :width: 90% :alt: Add Certificates @@ -69,7 +62,7 @@ Windows #. 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 + .. figure:: /_static/images/ssl/windows/4_windows_selected_snapin.svg :width: 90% :alt: Snap-in Selected @@ -77,7 +70,7 @@ Windows #. 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 + .. figure:: /_static/images/ssl/windows/5_windows_trusted_certificate_menu.svg :width: 90% :alt: Certificates in Management Console @@ -85,7 +78,7 @@ Windows #. Right click on “Certificates”, then navigate to *All Tasks > Import*. - .. figure:: /_static/images/ssl/windows/6_windows_import_cert.png + .. figure:: /_static/images/ssl/windows/6_windows_import_cert.svg :width: 90% :alt: Import certificate @@ -93,7 +86,7 @@ Windows #. 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 + .. figure:: /_static/images/ssl/windows/7_windows_import_cert_wizard.svg :width: 90% :alt: Import cert wizard @@ -105,7 +98,7 @@ Windows #. Verify the Embassy Local Root CA certificate is in the “Certificates” folder. - .. figure:: /_static/images/ssl/windows/8_windows_successful_cert_install.png + .. figure:: /_static/images/ssl/windows/8_windows_successful_cert_install.svg :width: 90% :alt: Successful cert install diff --git a/site/source/support/user-manual/configuration/tor-setup/tor-os/tor-windows.rst b/site/source/support/user-manual/configuration/tor-setup/tor-os/tor-windows.rst index 964a95c..d7a1f47 100644 --- a/site/source/support/user-manual/configuration/tor-setup/tor-os/tor-windows.rst +++ b/site/source/support/user-manual/configuration/tor-setup/tor-os/tor-windows.rst @@ -4,9 +4,9 @@ Windows ======= -#. 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 `_. +#. Unfortunately, `The Tor Project `_ 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 + .. figure:: /_static/images/tor/tor_download_windows.svg :width: 80% :alt: Tor download @@ -16,7 +16,7 @@ Windows #. Once you have selected a language, you should see a menu like this: - .. figure:: /_static/images/tor/tor_windows_install.png + .. figure:: /_static/images/tor/tor_windows_install.svg :width: 80% :alt: Tor install wizard @@ -42,7 +42,7 @@ Windows #. When you run this, it should look something like this: - .. figure:: /_static/images/tor/tor_windows_terminal.png + .. figure:: /_static/images/tor/tor_windows_terminal.svg :width: 80% :alt: Tor windows terminal