Docs updates - User Manual, Device guides, electrs apps, upgrade-diy & kit (#165)

poetry.lock

@@ -630,6 +630,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*,
 [package.extras]
 brotli = ["brotlicffi (>=0.8.0)", "brotli (>=1.0.9)", "brotlipy (>=0.6.0)"]
 secure = ["pyOpenSSL (>=0.14)", "cryptography (>=1.3.4)", "idna (>=2.0.0)", "certifi", "urllib3-secure-extra", "ipaddress"]
+socks = ["PySocks (>=1.5.6,!=1.5.7,<2.0)"]
 
 [[package]]
 name = "watchdog"

site/source/user-manual/device-guides/dg-ios.rst

@@ -9,3 +9,4 @@ To optimize your device for use with your Embassy, it is recommended to complete
 .. tip:: Please see iOS's :ref:`Known Limitations<lim-ios>` to understand what is currently not possible on these devices
 
 * :ref:`lan-ios` - Trust your Embassy's Root Certificate Authority in order to securely connect over LAN.
+* :ref:`tor-ios` - Run Tor natively (in the background) on your iOS device.  This will allow you to use applications on your device via the Tor Network so they can communicate with your Embassy.

site/source/user-manual/service-guides/bitcoin.rst

@@ -10,43 +10,74 @@ Bitcoin
 
 Here you will find guides on how to connect different kinds of Bitcoin wallets (hardware and software) to your Embassy node, to complete your sovereign Bitcoin stack!
 
-Tested Wallets
+
---------------
 .. _blockstream-green:
 
 Blockstream Green
-=================
+-----------------
+
+**Available For**
+
+ - Android/CalyxOS/GrapheneOS/LineageOS
+ - iOS
+ - Linux
+ - MacOS
+ - Windows
+ 
+**Instructions**
+ 
+ Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/blockstreamgreen/guide.md>`__.
 
-.. note:: Not Possible at this time - No ability to connect to a Bitcoin node
 
 .. _blue-wallet:
 
 BlueWallet
-==========
+----------
+
+ **Available For**
+
+  - Android/CalyxOS/GrapheneOS/LineageOS
+  - iOS
+ 
+ **Instructions**
+
+  Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/bluewallet/guide.md>`__.
 
-.. note:: Not Possible at this time - Requires Electrum Server
 
 .. _electrum:
 
-.. Electrum
+Electrum
-.. ========
+--------
+
+ **Available For**
+
+  - Android/CalyxOS/GrapheneOS/LineageOS
+  - Linux
+  - MacOS
+  - Windows
+ 
+ **Instructions**
+  
+  Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/electrum/guide.md>`__.
 
-.. .. warning:: UNTESTED
 
 .. _fully-noded:
 
 FullyNoded
-==========
+----------
 
-Available For
+ **Available For**
-.............
+
-- iOS
+  - iOS
-- Mac
+  - MacOS
+
+ **Instructions**
+ 
+  #. In Fully Noded, go to `Settings > Node Manager > +`
+  #. Enter your Bitcoin Core credentials. You can do this in one of two ways:
+    (A) Use Fully Noded to scan your QuickConnect QR code (located in `Services > Bitcoin Core > properties`); or 
+    (B) copy/paste your Bitcoin Core Tor Address (located in `Services > Bitcoin Core > Interfaces`) with :8332 appended, as well as you rpc username and password (located in `Services > Bitcoin Core > Config > RPC Settings`).
 
-Instructions
-............
-1. In Fully Noded, go to `Settings > Node Manager > +`
-2. Enter your Bitcoin Core credentials. You can do this in one of two ways: (1) Use Fully Noded to scan your QuickConnect QR code (located in `Services > Bitcoin Core > properties`); or (2) copy/paste your Bitcoin Core Tor Address (located in `Services > Bitcoin Core > Interfaces`) with :8332 appended, as well as you rpc username and password (located in `Services > Bitcoin Core > Config > RPC Settings`).
 
 .. _ledger-live:
 
@@ -57,72 +88,84 @@ Instructions
 
 .. .. warning:: UNTESTED
 
+
 .. _samourai:
 
 Samourai
-========
+--------
 
-.. note:: Not Possible at this time - Requires Dojo Stack
+ .. note:: Not Possible at this time - Requires Dojo Stack
  
-.. _sparrow:
+ .. _sparrow:
 
 Sparrow
-=======
+-------
 
-Available For
+ **Available For**
-.............
+
-- Linux
+  - Linux
-- Mac
+  - MacOS
-- Windows
+  - Windows
+ 
+ **Instructions**
+ 
+  Follow the `guide <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/integrations/sparrow/guide.md>`__.
 
-Instructions
-............
-Follow the `guide <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/integrations/sparrow/guide.md>`__.
 
 .. _specter:
 
 Specter
-=======
+-------
 
-Available For
+ **Available For**
-.............
+
-- Linux
+  - Linux
-- Mac
+  - MacOS
-- Windows
+  - Windows
+ 
+ **Instructions**
+
+  Follow the guide for `MacOS <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/integrations/specter/macos.md>`__ or `Windows <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/integrations/specter/windows.md>`__.
 
-Instructions
-............
-Follow the guide for `MacOS <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/integrations/specter/macos.md>`__ or `Windows <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/integrations/specter/windows.md>`__.
 
 .. _trezor-suite:
 
-.. Trezor Suite
+Trezor Suite
-.. ============
+------------
 
-.. .. tip:: Built for use with Trezor hardware devices
+ .. tip:: Built for use with Trezor hardware devices
+ 
+ **Available For**
+
+  - Linux
+  - MacOS
+  - Windows
+ 
+ **Instructions**
+  
+  Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/trezor/guide.md>`__.
 
-.. .. warning:: UNTESTED
 
 .. _bitcoin-cli:
 
-Using Bitcoin-Cli
+Bitcoin-Cli
------------------
+-----------
 
-Instructions for accessing the bitcoind service in order to issue commands directly.
+ Instructions for accessing the bitcoind service in order to issue commands directly.
  
-.. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause through SSH access.
+ .. warning:: This is an advanced feature and should be used with caution. Start9 is not responsible for any damage you might cause through SSH access.
  
-1. First, you will need SSH access.  Please see the :ref:`setup instructions <ssh>` for details.
+ #. First, you will need SSH access.  Please see the :ref:`setup instructions <ssh>` for details.
-2. Access your Embassy and then you can interact with the bitcoind docker container using the following syntax::
+ #. Access your Embassy and then you can interact with the bitcoind docker container using the following syntax::
  
     sudo docker exec -ti bitcoind.embassy bitcoin-cli COMMAND
  
-.. tip:: For example ``sudo docker exec -ti bitcoind.embassy bitcoin-cli getnetworkinfo``
+ .. tip:: For example ``sudo docker exec -ti bitcoind.embassy bitcoin-cli getnetworkinfo``
  
-A list of possible commands can be found `here <https://chainquery.com/bitcoin-cli>`__.
+ A list of possible commands can be found `here <https://chainquery.com/bitcoin-cli>`__.
  
-You can also drop into a shell using::
+ You can also drop into a shell using::
  
     sudo docker exec -ti bitcoind.embassy bash
 
-and then enter ``bitcoin-cli`` commands.  When you are finished, simply type ``exit``...
+ and then enter ``bitcoin-cli`` commands.  When you are finished, simply type ``exit``...

site/source/user-manual/ssh.rst

@@ -91,7 +91,7 @@ Setup
 
     .. code-block:: bash
 
-        sudo bash
+        sudo -i
 
 #. Using Vim or Nano, add the following 2 lines to ``/etc/tor/torrc``
 

site/source/user-manual/upgrade-02/upgrade-diy.rst

@@ -27,9 +27,9 @@ Hardware Requirements
 Flashing
 --------
 
-#. Once you have all these you will need to download an 0.3.0 image from https://images.start9.com. This is free for all existing users. Anyone who is running 0.2.x who compiled it themselves will need to either compile 0.3.0 themselves or purchase an 0.3.0 image.
+#. Once you have all these you will need to download an 0.3.0 image from https://images.start9.com. This is free for all existing users. Anyone who is running 0.2.x who compiled it themselves will need to either compile 0.3.0 themselves or download an 0.3.0 image.
 
-#. Once you have the image, flash it on to the 16GB SD card - the new one, **NOT** the one currently in your Embassy!
+#. Once you have the image, flash it on to the 32GB SD card - the new one, **NOT** the one currently in your Embassy!
 
 .. tip:: The flashing software we recommend is `Balena Etcher <https://www.balena.io/etcher/>`_
 
@@ -50,14 +50,14 @@ You may like to follow along with this video for clarity while migrating:
 
 #. Then take the new SD card with 0.3.0 on it and place it into the microSD card slot on your Embassy (not into the adaptor - that is for the old SD card!)
 
-#. Next, plug the SSD into one of the USB 3.0 ports (blue) on your Embassy, then reconnect the Ethernet cable if not already connected.
+#. Next, plug the SSD into one of the USB 3.0 (blue) ports on your Embassy, then reconnect the Ethernet cable if not already connected.
 
 #. Now the power cable can be connected and the Embassy powered up.
 
 Power Up
 --------
 
-#. Embassy will power up and then initialize, a process of less than 5 minutes if you purchased an image, or about 10-20 minutes if you built from source. Once complete you will hear a _bep_ to indicate it is initialized and then a _chime_ sound to indicate it is online.
+#. Embassy will power up and then initialize, a process of less than 5 minutes if you downloaded the image, or about 10-20 minutes if you built from source. Once complete you will hear a _bep_ to indicate it is initialized and then a _chime_ sound to indicate it is online.
 
 #. On your computer, open up a browser and go to http://embassy.local
 
@@ -87,14 +87,14 @@ Power Up
    .. figure:: /_static/images/setup/migrate4.png
       :width: 60%
 
-#. You will now need to make a password for your Embassy. It needs to be a strong password. This password protects your Embassy. It can be the same one that you used prior to migration, or a new one.  Either way, make it strong, and make a backup of it.  Without this you will **LOSE ALL ACCESS** to your Embassy!
+#. You will now need to make a password for your Embassy. It needs to be a strong password. This password protects your Embassy. It can be the same one that you used prior to migration, or a new one.  Either way, make it strong, and make a backup of it.
 
 #. Embassy will now recover all your data from your old Embassy and once finished, you will hear a _bep_, followed by a _chime_.
 
    .. figure:: /_static/images/setup/migrate5.png
       :width: 60%
 
-#. Now you will be provided with both a Tor and LAN address with which you can access your Embassy. A file download will contain this important information, which you should keep somewhere safe.  It is also a good idea to make bookmarks on the devices that you will use to access your Embassy.
+#. Now you will be provided with both a Tor and LAN address with which you can access your Embassy. A file offered for download will contain this important information, which you should keep somewhere safe.  It is also a good idea to make bookmarks on the devices that you will use to access your Embassy.
 
    .. figure:: /_static/images/setup/migrate6.png
       :width: 60%

site/source/user-manual/upgrade-02/upgrade-kit.rst

@@ -27,7 +27,7 @@ You may like to follow along with this video for clarity while migrating:
 
 #. Next, remove the OLD SD card that is in your Embassy and place it into the SD card adaptor, and then connect the adaptor to any USB port on your Embassy.
 
-#. Then take the NEW 16GB microSD card with 0.3.0 on it and place it into the microSD card slot on your Embassy. Be careful not to confuse the two microSD cards!
+#. Then take the NEW 32GB microSD card with 0.3.0 on it and place it into the microSD card slot on your Embassy. Be careful not to confuse the two microSD cards!
 
 #. Next, plug the SSD into one of the USB 3.0 ports (the blue ones) on your Embassy, then reconnect the Ethernet cable if not already connected.
 
@@ -57,7 +57,7 @@ Power Up
 
    .. note:: If it does not show up, please power down Embassy, unplug it, plug it back in, and boot Embassy again
 
-#. You will now need to make a password for your Embassy. It needs to be a strong password. This password protects your Embassy. It can be the same one that you used prior to migration, or a new one.  Either way, make it strong, and make a backup of it.  Without this you will **LOSE ALL ACCESS** to your Embassy!
+#. You will now need to make a password for your Embassy. It needs to be a strong password. This password protects your Embassy. It can be the same one that you used prior to migration, or a new one.  Either way, make it strong, and make a backup of it.
 
 #. Embassy will now recover all your data from your old Embassy and once finished, you will hear a _bep_, followed by a _chime_.