diff --git a/source/getting-started/diy.rst b/source/getting-started/diy.rst index 5dce64f..033fec7 100644 --- a/source/getting-started/diy.rst +++ b/source/getting-started/diy.rst @@ -12,16 +12,22 @@ DIY Guide By popular demand, we are pleased to present this "Do it Yourself" (DIY) guide for the Start9 Embassy personal server! +.. warning:: This DIY guide is for EmbassyOS version 0.2.13. A substantive change will be made to this guide for EmbassyOS v0.3.0 scheduled for release in July. When 0.3.0 launches it will REQUIRE hardware updates. Please `contact us `_ for additional information. + + + Motivation ========== There are four reasons you might prefer to build your own Embassy instead of purchasing one from us. -#. You already have a Raspberry Pi and would like to re-purpose it. +#. You already own the necessary hardware and would like to re-purpose it. -#. You want to save on shipping costs. +#. You live outside the US and want to save on shipping costs. -#. You prefer not to divulge your physical shipping address. +#. You do not trust Start9's supply chain. + +#. You do not want to share your shipping address. #. You just like building things. @@ -90,4 +96,4 @@ Whether you purchase EmbassyOS from us or build it yourself, you need to flash i #. Once the image is flashed and verified, you may remove the micro SD and insert it into your Embassy. #. The Embassy is now ready for use, and you may following the normal :ref:`setup ` instructions. ``*`` -``*`` The first time you power it on, your Embassy will make more noises than future attempts, and it may take several minutes to finally complete. \ No newline at end of file +``*`` The first time you power it on, your Embassy will make more noises than future attempts, and it may take several minutes to finally complete. diff --git a/source/misc-guides/tor-firefox/desktop.rst b/source/misc-guides/tor-firefox/desktop.rst index 87e5175..5c2a501 100644 --- a/source/misc-guides/tor-firefox/desktop.rst +++ b/source/misc-guides/tor-firefox/desktop.rst @@ -18,18 +18,17 @@ Setting up Firefox with Tor on Desktop :alt: Firefox whitelist onions screenshot 4. Download a `Proxy Auto Config` file to inform Firefox how to use the Tor daemon running on your computer. You can get Start9's standard file by following the OS-specific instructions below: + Windows: -Windows: - -Click `here `_ to get the file and save the file somewhere you won’t delete it. Please remember the location you save the file in if you do not use our example location. For this example: + Click `here `_ to get the file and save the file somewhere you won’t delete it. Please remember the location you save the file in if you do not use our example location. For this example: .. code-block:: C:\Program Files\Tor Browser\proxy.pac -Mac: + Mac: -Open the `Terminal` App on your Mac. You can find it in your list of Applications. In the terminal, enter: + Open the ``Terminal`` App on your Mac. You can find it in your list of Applications. In the terminal, enter: .. code-block:: @@ -41,9 +40,9 @@ Open the `Terminal` App on your Mac. You can find it in your list of Application wget -P /usr/local/etc/tor https://registry.start9labs.com/sys/proxy.pac -Linux: + Linux: -From a terminal, enter: + From a terminal, enter: .. code-block:: @@ -56,36 +55,35 @@ From a terminal, enter: :width: 80% :alt: Firefox options screenshot - Select :menuselection:`Settings --> Options` + Select :menuselection:``Settings --> Options`` -6. Search for the term “proxy” in the search bar in the upper right, then select the button that says `Settings…`: +6. 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 -7. 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: +7. 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: + Windows: -Windows: + .. code-block:: - .. code-block:: + file://C:/Program Files/Tor Browser/proxy.pac - file://C:/Program Files/Tor Browser/proxy.pac + Mac: -Mac: + .. code-block:: - .. code-block:: + file:///usr/local/etc/tor/proxy.pac - file:///usr/local/etc/tor/proxy.pac + Linux: -Linux: + .. code-block:: - .. code-block:: + file:///etc/tor/proxy.pac - file:///etc/tor/proxy.pac - -8. Then, check the box labeled `Proxy DNS when using SOCKS v5`: +8. Then, check the box labeled ``Proxy DNS when using SOCKS v5``: .. figure:: /_static/images/tor/firefox_proxy.png :width: 80% @@ -93,4 +91,4 @@ Linux: 9. Click ``OK`` and then restart Firefox for the changes to take effect. -10. 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 `_. +10. 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 `_. diff --git a/source/misc-guides/tor-os/mac.rst b/source/misc-guides/tor-os/mac.rst index 880df34..f10677a 100644 --- a/source/misc-guides/tor-os/mac.rst +++ b/source/misc-guides/tor-os/mac.rst @@ -100,6 +100,6 @@ or .. code-block:: - arch -x86_64 services start tor + arch -x86_64 brew services start tor depending on your device (as explained above). This will start Tor and ensure that it is always running, even after a restart. diff --git a/source/support/FAQ/bitcoin-faq.rst b/source/support/FAQ/bitcoin-faq.rst index a1c958d..f7dfb75 100644 --- a/source/support/FAQ/bitcoin-faq.rst +++ b/source/support/FAQ/bitcoin-faq.rst @@ -18,7 +18,7 @@ The block index error is normal and goes away after the Bitcoin blockchain has s Does the Embassy run a full archival Bitcoin node? -------------------------------------------------- The Embassy runs a full node, but does not run a full *archival* node, it's pruned. This means it does not store the entire Blockchain. As it syncs, it discards blocks and transactions it does not need. -It is fully validating and verifying consensus all the way from Genesis. Really, the only reason to store the entire Blockchain is if you want to run a block explorer. Learn more here: :ref:`node`. All this being said, it will be possible to run a full archival node on the Embassy in mid-2021, bringing this addtional functionality to those that would like it. +It is fully validating and verifying consensus all the way from Genesis. Really, the only reason to store the entire Blockchain is if you want to run a block explorer. Learn more here: :ref:`node`. All this being said, it will be possible to run a full archival node on the Embassy in mid-2021, bringing this additional functionality to those that would like it. What actions, specifically, are only possible with an archival, or ‘unpruned’ node? ----------------------------------------------------------------------------------- @@ -90,11 +90,18 @@ The reason there is so much confusion about these 3 concepts is that the Bitcoin Please note: of the wallets listed (Specter/Sparrow/Electrum), only Specter is currently able to use Embassy as it's node, but the other two should be available soon. - Why would I want to run a lightning node? ----------------------------------------- The Lightning Network (LN) is a second 'layer,' built on top of the Bitcoin Protocol. As a result all transactions on LN are backed up by the full security of the Bitcoin network. Lightning is designed for instant payments between nodes, but similar to running a Bitcoin node, running your own is the only way to be sovereign. When you have your own node, you will have the convenience of linking a Lightning wallet, for use on the go. It is also possible to earn an income (granted a very small one at this time), if you are willing to learn how to become a 'routing node.' +How can I get started with Lightning and open my first channel? +--------------------------------------------------------------- +You can check out our `"Using Lightning" video `_ and learn the basics, including opening a channel with Start9. + +.. youtube:: rAvoUNsobws + +Please remember to always open a "Private" channel with us, or your channel is likely to be closed. Please don't hesitate to reach out to us with any questions. + I opened a Lightning channel, but my local balance is lower than I expected. Where is the remainder? ----------------------------------------------------------------------------------------------------- A fee to close the channel (onchain) is set aside at opening. diff --git a/source/support/FAQ/services-faq.rst b/source/support/FAQ/services-faq.rst index ae0c120..e0518c8 100644 --- a/source/support/FAQ/services-faq.rst +++ b/source/support/FAQ/services-faq.rst @@ -62,6 +62,7 @@ Stop and Restart the Service. What is happening if I cannot connect with another user on Mastodon? -------------------------------------------------------------------- You can only follow someone who has an account on a Mastodon server that supports Tor. It is a new feature, so many instances do not have it yet. +Other issues are typically related to the tor connection, check your tor daemon, orbot, or try to restart the service. Can the browser extension be used with Bitwarden hosted on the embassy? ----------------------------------------------------------------------- @@ -73,6 +74,11 @@ As the Embassy produces a Tor Hidden Service for each service, BTCPayServer is o We understand that this can be a frustrating limitation, and adding clearnet support is high on our list of priorities for the Embassy. This will allow a number of services to have better interoperability with the broader Web. +I'm having issues connecting to users or rooms in Matrix/Synapse, what can I do? +-------------------------------------------------------------------------------- +Most issues in Matrix will be due to improper setup, or tor connectivity issues. Please follow the directions in the Synapse web interface closely, and be sure that you have a good tor connection on the device you are trying to connect with. +Please reach out to us if you are still unable to connect. + I don't see an answer to my question regarding a certain service. Is there more documentation? ----------------------------------------------------------------------------------------------- While we are intent on providing the most friendly experience possible to our customers, ultimately it will be impossible for Start9 to create documentation and tutorials for every service we make available on the Embassy. Each service *should* have its own documentation produced by the service developers themselves, and we will do our best keep track, consolidate, and link to it. Also, much of the reason good tutorials don't exist is simply because no one in the community has taken the time to produce it. If you come across something useful or write something up yourself, please let us know and we will promote it. Otherwise we will do our best to answer questions as they arise and gradually build out tutorials where they are lacking. diff --git a/source/support/FAQ/setup-faq.rst b/source/support/FAQ/setup-faq.rst index 7f2eb7c..6dffc5a 100644 --- a/source/support/FAQ/setup-faq.rst +++ b/source/support/FAQ/setup-faq.rst @@ -10,12 +10,16 @@ How do I know if my Embassy is running? --------------------------------------- After plugging into power and your router, you will hear 2 distinct sounds: first, a “bep” ‐ indicating the device is powering on, and second, a “chime” ‐ indicating the device is ready for setup. +My Embassy is really hot! Is this normal? +------------------------------------------ +Yes, the Embassy's case is actually doing 'double duty' as a heat sync. This means that the metal of the case is actually touching the chips on the circuit board and drawing their heat out and away. This is known as "passive cooling," as no fan (and therefore no additional energy) is required to cool the system. + 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 do I need the Bonjour service (Windows only)? -------------------------------------------------- +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. My Tor sites aren't loading, what should I do? @@ -45,3 +49,7 @@ If you are having trouble with this, you might consider letting the Embassy out Why am I having trouble using my Embassy via the Brave browser? --------------------------------------------------------------- Unfortunately, Brave does not treat .onion addresses in a 'secure context.' This is a known issue in Brave that is being tracked `here `_. + +Is it true that iOS has some limited functionality in regard to the Embassy? +---------------------------------------------------------------------------- +The short answer is yes, but not much. Unfortunately, Apple does not allow any ability for Tor to run in the background (everything on the Embassy runs over Tor). Most of your Embassy services can be run with Tor-native apps, inside Consulate, or with another Tor browser, with the exception of RTL, Spark, and Matrix. Zap and Zeus wallets can be used in place of RTL/Spark, and we hope a Tor-native Element client will be available soon to allow for the use of Matrix. \ No newline at end of file diff --git a/source/support/FAQ/usage-faq.rst b/source/support/FAQ/usage-faq.rst index 5a4ac76..00a3b4a 100644 --- a/source/support/FAQ/usage-faq.rst +++ b/source/support/FAQ/usage-faq.rst @@ -4,7 +4,8 @@ Basic Usage Is it easy to use? ------------------ -Yes! The Embassy is designed to be plugged into power and internet, and after a short setup, is immediately ready to use. Getting services is as easy as getting apps for a smartphone. +Yes! The Embassy is designed to be plugged into power and internet, and after a short setup, is immediately ready to use. Getting Services is as easy as getting apps for a smartphone. +As with anything new, you should expect to spend a little time learning the functions and features, and keep in mind that some Services may be more complex to understand and use than others. So I can run my own cloud? -------------------------- diff --git a/source/user-manual/general/lan-setup/browser-setup.rst b/source/user-manual/general/lan-setup/browser-setup.rst index a976816..54689a3 100644 --- a/source/user-manual/general/lan-setup/browser-setup.rst +++ b/source/user-manual/general/lan-setup/browser-setup.rst @@ -17,18 +17,6 @@ Select the browser you would like to configure to import the certificate from yo - :ref:`Firefox ` - :ref:`Safari ` -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 ` - .. _brave: Brave