restructure docs

This commit is contained in:
Matt Hill
2023-11-06 12:34:37 -07:00
parent 80651a6609
commit fe79d71e7c
150 changed files with 404 additions and 1866 deletions

View File

@@ -0,0 +1,26 @@
.. _bitcoin-cli:
===========
Bitcoin CLI
===========
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.
#. First, you will need SSH access. Please see the :ref:`setup instructions <ssh>` for details.
#. Access your server and then you can interact with the bitcoind docker container using the following syntax:
.. code-block:: bash
sudo docker exec -ti bitcoind.embassy bitcoin-cli COMMAND
.. tip:: For example ``sudo docker exec -ti bitcoind.embassy bitcoin-cli getnetworkinfo``
A list of possible commands can be found `here <https://developer.bitcoin.org/reference/rpc/>`__.
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``...

View File

@@ -0,0 +1,176 @@
.. _bitcoin-integrations:
====================
Bitcoin Integrations
====================
.. contents::
:depth: 2
:local:
Here you will find guides on how to connect different kinds of Bitcoin wallets (hardware and software) to your server's node, to complete your sovereign Bitcoin stack!
.. _blockstream-green:
Blockstream Green
-----------------
**Available For**
- Android
- iOS
- Linux
- macOS
- Windows
**Instructions**
Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/blockstreamgreen/guide.md>`__.
.. _blue-wallet-bitcoin:
BlueWallet
----------
**Available For**
- Android
- iOS
**Instructions**
Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/bluewallet/guide.md>`__.
.. _electrum:
Electrum
--------
**Available For**
- Android
- Linux
- macOS
- Windows
**Instructions**
Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/electrum/guide.md>`__.
.. _fully-noded:
FullyNoded
----------
**Available For**
- iOS
- 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`).
.. _ledger-live:
.. Ledger Live
.. ===========
.. .. tip:: Built for use with Ledger hardware devices
.. .. warning:: UNTESTED
.. _nunchuk:
Nunchuk
-------
**Available For**
- Android
- iOS
- Linux
- macOS
- Windows
**Instructions**
#. Install the `Electrs` service from the Start9 Marketplace
#. Follow the `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/nunchuk/guide.md>`__.
.. _samourai:
Samourai
--------
.. note:: Not Possible at this time - Requires Dojo Stack
.. _sparrow:
Sparrow
-------
**Available For**
- Linux
- macOS
- Windows
**Instructions**
Connect Sparrow directly to your `Bitcoin Core`:
* Follow this `guide <https://github.com/Start9Labs/bitcoind-wrapper/blob/master/docs/integrations/sparrow/guide.md>`__.
**CAUTION** Until we get per-user rpc restrictions built into Bitcoin Core, this is technically more dangerous than using the electrum server method, because it requires createwallet and similar RPC calls. However, exploiting it relies on there being a vulnerability in Bitcoin Core. Likely there isn't, but if this makes you uneasy, please use the electrs method below.
**OPTIONAL** (but less reliable) -- Connect Sparrow to Electrs via Tor:
#. Install the `Electrs` service from the Start9 Marketplace
#. Follow this `guide <https://github.com/Start9Labs/electrs-wrapper/blob/master/docs/integrations/sparrow/guide.md>`__.
.. _specter-wallet:
Specter
-------
**Available For**
- Linux
- macOS
- StartOS
- 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>`__.
.. _trezor-suite:
Trezor Suite
------------
.. 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>`__.

View File

@@ -0,0 +1,60 @@
.. _blockchain-copy:
====================
Blockchain Migration
====================
.. contents::
:depth: 2
:local:
.. 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.
If you have already synced the Bitcoin blockchain to the tip on one server, and would like to skip IBD on another server, follow this guide.
.. note:: The following guide requires that you have already :ref:`setup SSH on both Start9 servers<ssh>`.
In this guide, we will refer to your synced server as example-aaa.local and the server with no Bitcoin synced as example-bbb.local. Of course, please replace example-aaa and example-bbb with your corresponding Start9 servers' unique `adjective-noun` names.
**Install but don't start Bitcoin Core on the blockchain-less server**
#. Log into `https://example-bbb.local` and install Bitcoin Core (**Marketplace > Bitcoin > Bitcoin Core > Install**). Do *NOT* yet **CONFIGURE** or **START** Bitcoin Core.
**Prep your server with the synced blockchain**
#. Stop the Bitcoin Core service on `https://example-aaa.local` (**Services > Bitcoin Core > Stop**)
#. :ref:`Open an ssh session <connecting-via-ssh>` to example-aaa.local
#. Once at the shell, perform the following commands
.. code-block:: bash
sudo -i
mkdir -m 0700 -p .ssh
ssh-keygen -t ed25519 -N '' -f .ssh/example-bbb.key
chmod 600 .ssh/example-bbb.key*
cat .ssh/example-bbb.key.pub
#. Copy the output from the cat command into example-bbb's **System > SSH > Add New Key** text field:
.. figure:: /_static/images/walkthrough/ssh_key_add.jpg
#. Back on the shell of example-aaa.local, do the following (don't forget to replace example-bbb in the rsync command below before you perform it):
.. code-block:: bash
cd /embassy-data/package-data/volumes/bitcoind/data/main/
rsync -e "ssh -i ~/.ssh/example-bbb.key" -povgr --append-verify --rsync-path="sudo mkdir -p /embassy-data/package-data/volumes/bitcoind/data/main ; sudo rsync" ./{blocks,chainstate} start9@example-bbb.local:/embassy-data/package-data/volumes/bitcoind/data/main/
#. Wait some hours until the copy is complete. On a gigabit network, the limiting factor will be the write speed of your SSD on the receiving server. When it is complete, clean up a bit:
.. code-block:: bash
rm .ssh/example-bbb.key*
exit
#. Switch back to `https://example-bbb.local`, selecting **Services > Bitcoin Core**, **CONFIGURE**, configure it as desired, **SAVE** and then **START** your Bitcoin Core service. You should see it begin at 99%+ pre-synced.
#. You can now restart your Bitcoin Core service on `https://example-aaa.local` via **Services > Bitcoin Core > Start**.
.. _bitcoin-service:

View File

@@ -0,0 +1,14 @@
.. _bitcoin-service:
=======
Bitcoin
=======
These guides will help you to setup external tools to connect or interact with Bitcoin, such as a wallet.
.. toctree::
:maxdepth: 1
bitcoin-integrations
bitcoin-cli
blockchain-copy