From 76f514342af594dfd7938c46e069bfa57f294bd3 Mon Sep 17 00:00:00 2001 From: Matt Hill Date: Thu, 24 Feb 2022 10:43:41 -0700 Subject: [PATCH] revamp support --- site/source/support/common-issues.rst | 59 +++++++++++++++++++ site/source/support/contact.rst | 23 ++++---- site/source/support/faq/faq-basic-use.rst | 2 +- site/source/support/index.rst | 26 ++++---- site/source/support/troubleshooting/index.rst | 13 ---- .../troubleshooting/shoot-connection.rst | 19 ------ .../support/troubleshooting/shoot-embassy.rst | 29 --------- .../connecting-tor/tor-os/tor-ios.rst | 2 +- .../device-guides/limitations/lim-android.rst | 16 ++--- .../device-guides/limitations/lim-ios.rst | 16 +---- .../device-guides/limitations/lim-linux.rst | 2 +- .../device-guides/limitations/lim-mac.rst | 2 +- 12 files changed, 97 insertions(+), 112 deletions(-) create mode 100644 site/source/support/common-issues.rst delete mode 100644 site/source/support/troubleshooting/index.rst delete mode 100644 site/source/support/troubleshooting/shoot-connection.rst delete mode 100644 site/source/support/troubleshooting/shoot-embassy.rst diff --git a/site/source/support/common-issues.rst b/site/source/support/common-issues.rst new file mode 100644 index 0000000..2866a38 --- /dev/null +++ b/site/source/support/common-issues.rst @@ -0,0 +1,59 @@ +.. _common-issues: + +============= +Common Issues +============= + +Sometimes things don't go as planned. Check here for solutions to common problems with your Embassy. + +Embassy will not boot +--------------------- + +If the device will not power on at all (no lights whatsoever), then the only issues could be that the Pi is not getting the power it needs, or it is completely dead (extremely rare). If you sourced your own parts, please ensure that the power supply meets the minimum required specifications in the `DIY Guide`. If you received your device from us and it will not power up at all, please `Contact us` for assistance. + +Embassy boots into "Diagnostic Mode" +------------------------------------ + +Diagnostic Mode is a new UI that will launch in the event that no drive, or an incorrect drive (such as one from another Embassy) has been plugged into Embassy. Simply plug your external drive in and reboot (power off and on again). + +.. _setup-troubleshoot: + +During initial setup, I am unable to connect to "embassy.local". +---------------------------------------------------------------- + +* Confirm that your Embassy is plugged into both power and Ethernet. + +* Confirm the Embassy emitted two sounds when powering on: a bep and a chime. + +* Confirm your phone is **not** connected to a “Guest” network + +* Confirm your phone is **not** using a VPN. + +If you still cannot connect, try logging into your router (the directions for which can be found with a simple web search for your router model and 'how to log in'). Once you are in your router, find the device labeled 'Embassy,' and visit it's associated IP address, which will look something like: ``192.168.1.9`` + +I am unable to reach Embassy via it's ``embassy-xxxxxxxx.local`` (LAN) address +------------------------------------------------------------------------------ + +Make sure you have successfully followed the :ref:`LAN Setup` instructions for your device. If you still cannot connect, try all the solution listed under :ref:`initial setup `. + +I am unable to reach Embassy via it's ``xxxxxxxxxxxxxxxxxx.onion`` (Tor) address +-------------------------------------------------------------------------------- + +#. **Test** - Try connecting to your Embassy using the official :ref:`Tor Browser `. + #. **If Tor Browser works** - It means the issue is either with the Tor daemon on your device or with the browser settings. + #. **Solutions** + #. If you are not yet running a Tor daemon on your device, follow :ref:`these instructions `. If you are already running a Tor daemon, restart it, or in the case of Android, restart your phone. + #. If you are using Firefox, ensure it has been :ref:`properly configured ` to work with .onion URLS. + #. **If Tor Browser does not work** - It means there is an issue with your Embassy. + #. **Test** - Try visiting your Embassy over LAN from a non-Tor browser such as Firefox, Chrome, or Safari. + #. **If LAN works** - it means the issue is an issue with Tor on your Embassy. + #. **Solutions** + #. Wait an hour or so to allow Tor on your Embassy to fix itself. + #. Restart your Embassy through the UI. + #. **If LAN does not work** - It means your Embassy is experiencing general networking issues. + #. **Solutions** - Power cycle your Embassy by unplugging it and plugging it back in, then wait a few minutes before trying to connect again. + +I'm having an issue with a particular Service +--------------------------------------------- + +If a Service is crashing or acting up in some way, check the `Documentation` and `FAQ` for that particular Service. You can also check the `Logs` of a service, which might tell you what the problem is. If that is not helpful, try to restart the service to see if that clears up the issue. If you are still having issues, please reach out in one of our `Community Channels` for immediate assistance, or email support@start9labs.com for help during business hours. diff --git a/site/source/support/contact.rst b/site/source/support/contact.rst index 9b5124c..fca4477 100644 --- a/site/source/support/contact.rst +++ b/site/source/support/contact.rst @@ -7,29 +7,30 @@ Contact Us Community Channels ------------------ -`Matrix Start9 Community `_ +* `Telegram `_ - Primary community channel -`Matrix Community Developers `_ +* `Matrix `_ - Community channel tht will gradually replace Telegram. -`Matrix Start9 Tor Community (Tor required) `_ +* `Matrix Dev `_ - Primary channel for collaboration on EmbassyOS development and service packaging. -`Telegram `_ +* `Matrix Tor (Tor required) `_ - Tor-only community channel for Embassy users Social Media ------------ -`Mastodon `_ -`Twitter `_ +* `Mastodon `_ -`GitHub `_ +* `Twitter `_ + +* `GitHub `_ Email ----- -General Inquiries - info@start9labs.com +* support@start9labs.com - for getting help with your Embassy and asking general questions about Start9. -Support - support@start9labs.com +* security@start9labs.com - for reporting sensitive information or security concerns. -Operations - ops@start9labs.com +* jobs@start9labs.com - for those interested in doing work for Start9. -Affiliates - affiliate@start9labs.com +* affiliate@start9labs.com - for those interested in becoming a Start9 affiliate. diff --git a/site/source/support/faq/faq-basic-use.rst b/site/source/support/faq/faq-basic-use.rst index b43c575..56206a2 100644 --- a/site/source/support/faq/faq-basic-use.rst +++ b/site/source/support/faq/faq-basic-use.rst @@ -35,7 +35,7 @@ If you are in your home/office network with an Embassy, it is both faster and mo Can I use the .local addresses over the Tor Browser? ---------------------------------------------------- -Unfortunately, no. The Tor Browser requires all web visits to first enter the Tor network. Once you have entered the Tor network there is no way to exit the Tor network in such a way that .local/mDNS addresses resolve. +No. The Tor Browser requires all web visits to first enter the Tor network. Once you have entered the Tor network there is no way to exit the Tor network in such a way that .local/mDNS addresses resolve. Can I use .local addresses on Android? -------------------------------------- diff --git a/site/source/support/index.rst b/site/source/support/index.rst index 1dc0a95..7fa8955 100644 --- a/site/source/support/index.rst +++ b/site/source/support/index.rst @@ -4,7 +4,7 @@ Support ======= - View frequently asked questions, troubleshoot common issues, or contact support. +View frequently asked questions, troubleshoot common issues, or contact support. .. raw:: html @@ -12,6 +12,15 @@ Support
+.. topic-box:: + :title: Common Issues + :link: common-issues + :icon: scylla-icon scylla-icon--monitoring + :class: large-5 + :anchor: View + + Explore common issues and their solutions + .. topic-box:: :title: FAQ :link: faq @@ -21,19 +30,10 @@ Support Answers to Frequently Asked Questions from Embassy users -.. topic-box:: - :title: Troubleshooting - :link: troubleshooting - :icon: scylla-icon scylla-icon--monitoring - :class: large-5 - :anchor: View - - Explore common problems and their solutions - .. topic-box:: :title: Contact :link: contact - :icon: scylla-icon scylla-icon--networking + :icon: scylla-icon scylla-icon--support :class: large-5 :anchor: Get help @@ -48,6 +48,6 @@ Support :maxdepth: 1 :hidden: + common-issues faq/index - troubleshooting/index - contact + contact \ No newline at end of file diff --git a/site/source/support/troubleshooting/index.rst b/site/source/support/troubleshooting/index.rst deleted file mode 100644 index 60f61a6..0000000 --- a/site/source/support/troubleshooting/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _troubleshooting: - -=============== -Troubleshooting -=============== - -Sometimes things don't go as planned. Check here for solutions to common problems with your Embassy. - -.. toctree:: - :maxdepth: 2 - - shoot-connection - shoot-embassy diff --git a/site/source/support/troubleshooting/shoot-connection.rst b/site/source/support/troubleshooting/shoot-connection.rst deleted file mode 100644 index 916a39e..0000000 --- a/site/source/support/troubleshooting/shoot-connection.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _shoot-connection: - -=========== -Connections -=========== - -During initial setup, I am unable to connect to ``embassy.local``. ------------------------------------------------------------------- -Please ensure that the device you are attempting to connect with is on the same network as your Embassy. This cannot be a "Guest" network, or a WiFi network that is in any way separated from the network Embassy is on. - -If you still cannot connect, you can log into your router (the directions for which can be founnd with a simple web search for your router model and 'how to log in'). Once you are in your router, find the device labeled 'Embassy,' and visit it's associated IP address, which will look something like: ``192.168.1.9`` - -I am unable to reach Embassy via it's ``embassy-xxxxxxxx.local`` (LAN) address ------------------------------------------------------------------------------- -Make sure you have successfully followed the :ref:`LAN Setup` instructions for your device. If you still cannot connect, make sure you are on the same network using the solution above. If you are able to visit your Embassy via its IP address, then something is wrong in your LAN Setup. Keep in mind that different devices have different methods of resolving ``.local`` addresses, and some devices, such as :ref:`Android`, lack the ability at an OS level. - -I am unable to reach Embassy via it's ``xxxxxxxxxxxxxxxxxx.onion`` (Tor) address --------------------------------------------------------------------------------- -First, attmept to connect using :ref:`The Tor Browser`. This is a good test because Tor Browser has Tor built in. If you cannot reach your ``.onion`` with Tor Browser, reboot the Embassy by unplugging power and plugging it back in. This will reset your Tor connection. If you can reach via Tor Browser, but not with another browser, then follow the setup guides to run Tor on your device :ref:`Natively` and/or to :ref:`Configure Your Browser`. diff --git a/site/source/support/troubleshooting/shoot-embassy.rst b/site/source/support/troubleshooting/shoot-embassy.rst deleted file mode 100644 index b5b0a76..0000000 --- a/site/source/support/troubleshooting/shoot-embassy.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _shoot-embassy: - -======= -Embassy -======= - -Hardware --------- - -Embassy is making noises -======================== -The plug and play Embassy sold by Start9 has no moving parts, so the only noises it should ever make would come from its internal speaker. The following is a list of all possible sounds: - -#. - -Embassy boots into "Diagnostic Mode" -==================================== -Diagnostic Mode is a new UI that will launch in the event that no drive, or an incorrect drive (such as one from another Embassy) has been plugged into Embassy. Simply plug your external drive in and reboot (power off and on again). - -Embassy will not boot -===================== -If the device will not power on at all (no lights whatsoever), then the only issues could be that the Pi is not getting the power it needs, or it is completely dead (extremely rare). If you sourced your own parts, please ensure that the power supply meets the minimum required specificiations in the `DIY Guide`. If you received your device from us and it will not power up at all, please `Contact us` for assistance. - -Software --------- - -I'm having an issue with a particular Service -============================================= -If a Service is crashing or acting up in some way, check the `Documentation` and `FAQ` for that particular Service. You can also check the `Logs` of a service, which might tell you what the problem is. If that is not helpful, try to restart the service to see if that clears up the issue. If you are still having issues, please reach out in one of our `Community Channels` for immediate assistance, or email support@start9labs.com for help during business hours. diff --git a/site/source/user-manual/connecting/connecting-tor/tor-os/tor-ios.rst b/site/source/user-manual/connecting/connecting-tor/tor-os/tor-ios.rst index a38afd9..1036306 100644 --- a/site/source/user-manual/connecting/connecting-tor/tor-os/tor-ios.rst +++ b/site/source/user-manual/connecting/connecting-tor/tor-os/tor-ios.rst @@ -4,4 +4,4 @@ Running Tor on iOS ================== -Unfortunately, it is not currently possible to run Tor natively on iOS. Please see :ref:`iOS Limitations` for details and workarounds. +Unfortunately, it is not currently possible to run Tor natively on iOS. Please see :ref:`iOS Limitations` for details and workarounds. diff --git a/site/source/user-manual/device-guides/limitations/lim-android.rst b/site/source/user-manual/device-guides/limitations/lim-android.rst index 1e1267a..2fef9ab 100644 --- a/site/source/user-manual/device-guides/limitations/lim-android.rst +++ b/site/source/user-manual/device-guides/limitations/lim-android.rst @@ -4,14 +4,10 @@ Android ======= -Local Access ------------- -Older versions of Android (previous to version 12, and some custom ROMs, such as Graphene/Calyx) do not have native support for :ref:`mDNS` and therefore cannot resolve ``.local`` addresses. This issue has been long known by Google, and can be tracked `here `_ (Google account required to view). +LAN Access +---------- +Android versions below 12 (as well as some custom ROMs, such as Graphene/Calyx) do not have native support for :ref:`mDNS` and therefore cannot resolve ".local" addresses. -Workarounds -=========== -An app developer can add mDNS support, and some projects, such as Chromium, have long `considered it `_, but the real solution is for support to occur at the OS level. - -LineageOS ---------- -Unfortunately, there seems to be a bug in Lineage that makes using Firefox over Tor currently unusable. Currently, this feature works fine on Calyx and Graphene. +Tor Firefox on LineageOS +------------------------ +There seems to be a bug in Lineage that makes using Firefox over Tor currently unusable. Currently, this feature works fine on Calyx and Graphene. diff --git a/site/source/user-manual/device-guides/limitations/lim-ios.rst b/site/source/user-manual/device-guides/limitations/lim-ios.rst index 68620a7..2ac9d49 100644 --- a/site/source/user-manual/device-guides/limitations/lim-ios.rst +++ b/site/source/user-manual/device-guides/limitations/lim-ios.rst @@ -6,20 +6,10 @@ iOS Tor --- -It is not currently possible to run Tor natively (in the background) on iOS. The best chance for this functionality coming to iOS in the future is via the `iCepa Project `_. +It is not currently possible to run Tor natively (in the background) on iOS. This means that many iOS apps will be unable to connect to your Embassy. The best chance for a Tor background process on iOS in the future is via the `iCepa Project `_. -Workarounds -=========== -The only way to use Tor (in the background) on iOS is with apps that come with Tor built-in, such as :ref:`Zap Wallet `. For visiting Embassy UI Tor sites, you may use `Onion Browser `_ or `Start9's Consulate `_ application. +Many apps, such as :ref:`Fully Noded ` and :ref:`Zap `, support Tor natively. And any Embassy service that has a Tor UI can be accessed using `Onion Browser `_. Matrix ------ -The lack of Tor support on iOS means that Element/Matrix cannot be run on an iPhone in conjunction with your Embassy Matrix server, as that currently requires a Tor connection. This will be fixed when `Element `_ builds Tor into their app. An issue specifically in regard to this can be found `here `_. - -Workarounds -=========== -None currently known, but may be solved with forthcoming "clearnet" support on EmbassyOS. - -Spark Wallet ------------- -Unfortunately, Spark cannot currently be used in Consulate. This issue is being tracked `here `__. +The lack of background Tor support on iOS means that you cannot use `Element `_ to connect to your Embassy Matrix server. This will be fixed when `Element introduces Tor support `_ or when `iCepa Project `_ comes to fruition. diff --git a/site/source/user-manual/device-guides/limitations/lim-linux.rst b/site/source/user-manual/device-guides/limitations/lim-linux.rst index 0753b80..1f602cb 100644 --- a/site/source/user-manual/device-guides/limitations/lim-linux.rst +++ b/site/source/user-manual/device-guides/limitations/lim-linux.rst @@ -4,4 +4,4 @@ Linux ===== -Currently, Linux has no known limitations in regard to Embassy. Congratulations, Master Race... +Linux has no known limitations in regard to Embassy. diff --git a/site/source/user-manual/device-guides/limitations/lim-mac.rst b/site/source/user-manual/device-guides/limitations/lim-mac.rst index 8294450..289dfb0 100644 --- a/site/source/user-manual/device-guides/limitations/lim-mac.rst +++ b/site/source/user-manual/device-guides/limitations/lim-mac.rst @@ -4,4 +4,4 @@ Mac === -MacOS has no known limitations in regard to Embassy at this time. +MacOS has no known limitations in regard to Embassy.