GitBook: No commit message

Author: kenrogers

docs/operate/readme/run-a-bitcoin-node.md

@@ -2,7 +2,7 @@
 
 {% stepper %}
 {% step %}
-### Requirements
+#### Requirements
 
 This guide is written for a Unix based system. It's reasonable to expect some modifications will be required for other operating systems.
 
@@ -23,7 +23,7 @@ When started, the Bitcoin node will take several days to reach chain tip.
 {% endstep %}
 
 {% step %}
-### Add bitcoin user and set file ownership
+#### Add bitcoin user and set file ownership
 
 Run the following commands:
 
@@ -38,7 +38,7 @@ $ sudo chown -R bitcoin:bitcoin /bitcoin /etc/bitcoin/
 {% endstep %}
 
 {% step %}
-### Bitcoin config
+#### Bitcoin config
 
 Below is a sample config used to sync a bitcoin node - feel free to adjust as needed.
 
@@ -107,7 +107,7 @@ disablewallet=1
 {% endstep %}
 
 {% step %}
-### Systemd unit file
+#### Systemd unit file
 
 Reference: https://github.com/bitcoin/bitcoin/blob/master/contrib/init/bitcoind.service
 
@@ -198,7 +198,7 @@ WantedBy=multi-user.target
 {% endstep %}
 
 {% step %}
-### Enable and start the Bitcoin service
+#### Enable and start the Bitcoin service
 
 Run:
 
@@ -212,7 +212,7 @@ $ sudo systemctl start bitcoin.service
 {% endstep %}
 
 {% step %}
-### Track sync progress
+#### Track sync progress
 
 {% hint style="info" %}
 Once started, you may track the sync progress:

docs/operate/readme/run-a-node-with-digital-ocean.md

@@ -10,37 +10,37 @@ Build code is hosted on this [Github repository](https://github.com/stacksfounda
 
 {% stepper %}
 {% step %}
-### Create the Droplet from the Marketplace
+#### Create the Droplet from the Marketplace
 
 Go to the [Stacks Blockchain page](https://marketplace.digitalocean.com/apps/stacks-blockchain) in DigitalOcean's marketplace. Click on `Create Stacks Blockchain Droplet`.
 {% endstep %}
 
 {% step %}
-### Choose plan and region
+#### Choose plan and region
 
 Choose a plan (it will only allow you to select a droplet that meets the minimum requirements) and your preferred datacenter region.
 {% endstep %}
 
 {% step %}
-### Authentication
+#### Authentication
 
 Enter a root password or [enable SSH keys](https://docs.digitalocean.com/products/droplets/how-to/add-ssh-keys/) if you prefer.
 {% endstep %}
 
 {% step %}
-### Create the Droplet
+#### Create the Droplet
 
 You can leave the rest of the options as they are and click on `Create Droplet`.
 {% endstep %}
 
 {% step %}
-### Wait for creation
+#### Wait for creation
 
 You will need to wait a few seconds for the droplet to get created. Once created click on it to see more information.
 {% endstep %}
 
 {% step %}
-### Access the Droplet
+#### Access the Droplet
 
 Congratulations! You are now running the Stacks Blockchain. You can click on `Console` for a terminal window to open or login using SSH to the public IP you've been assigned to with user `root`.
 {% endstep %}

docs/operate/readme/run-a-node-with-docker.md

@@ -33,7 +33,7 @@ The `<network>` placeholder used below can be replaced with one of:
 
 {% stepper %}
 {% step %}
-### Clone the repository
+#### Clone the repository
 
 Clone the stacks-blockchain-docker repository locally and change into the directory:
 
@@ -45,7 +45,7 @@ git clone https://github.com/stacks-network/stacks-blockchain-docker && cd stack
 {% endstep %}
 
 {% step %}
-### Start the services
+#### Start the services
 
 Start the docker-compose services for the chosen network:
 

docs/operate/readme/run-a-node-with-quicknode.md

@@ -4,13 +4,13 @@
 
 {% stepper %}
 {% step %}
-### Create a QuickNode account
+#### Create a QuickNode account
 
 Sign up on QuickNode: https://www.quicknode.com/signup
 {% endstep %}
 
 {% step %}
-### Create an endpoint
+#### Create an endpoint
 
 Once signed in, click "Create an endpoint". Select:
 
@@ -22,13 +22,13 @@ After that you'll have an API endpoint URL you can use to connect to Stacks.
 {% endstep %}
 
 {% step %}
-### Install the Stacks network package
+#### Install the Stacks network package
 
 Install the `@stacks/network` package in your frontend project.
 {% endstep %}
 
 {% step %}
-### Import the network class
+#### Import the network class
 
 In your frontend code, import the network class:
 
@@ -40,7 +40,7 @@ import { StacksTestnet } from "@stacks/network";
 {% endstep %}
 
 {% step %}
-### Configure the network with your QuickNode endpoint
+#### Configure the network with your QuickNode endpoint
 
 Create the network instance using your QuickNode endpoint URL:
 
@@ -54,7 +54,7 @@ Replace \<QUICKNODE\_ENDPOINT\_HERE> with the full endpoint URL provided by Quic
 {% endstep %}
 
 {% step %}
-### Use with @stacks/transactions
+#### Use with @stacks/transactions
 
 You can now call transactions and other Stacks RPC methods as you normally would using the `@stacks/transactions` library, passing the `network` instance where required.
 

docs/operate/readme/run-a-pruned-bitcoin-node.md

@@ -36,7 +36,7 @@ What this means is that in practice, a stacks-blockchain node:
 
 {% stepper %}
 {% step %}
-### Add bitcoin user and set file ownership
+#### Add bitcoin user and set file ownership
 
 ```shell
 $ sudo mkdir -p /bitcoin/mainnet
@@ -47,7 +47,7 @@ $ sudo chown -R bitcoin:bitcoin /bitcoin /etc/bitcoin/
 {% endstep %}
 
 {% step %}
-### Bitcoin Config
+#### Bitcoin Config
 
 Below is a sample config used to sync a pruned bitcoin node - feel free to adjust as needed.
 
@@ -136,7 +136,7 @@ disablewallet=1
 {% endstep %}
 
 {% step %}
-### Systemd unit file
+#### Systemd unit file
 
 ref: https://github.com/bitcoin/bitcoin/blob/master/contrib/init/bitcoind.service
 
@@ -223,7 +223,7 @@ WantedBy=multi-user.target
 {% endstep %}
 
 {% step %}
-### Enable and start the Bitcoin service
+#### Enable and start the Bitcoin service
 
 ```shell
 $ sudo systemctl daemon-reload
@@ -233,7 +233,7 @@ $ sudo systemctl start bitcoin.service
 {% endstep %}
 
 {% step %}
-### Track sync progress
+#### Track sync progress
 
 {% hint style="info" %}
 Once started, you may track the sync progress:

docs/operate/run-a-miner/miner-prerequisites.md

@@ -23,15 +23,15 @@ Two options here — either are fine but it's recommended to mount the chainstat
 
 {% stepper %}
 {% step %}
-### Separate disks for chainstate(s) and OS
+#### Separate disks for chainstate(s) and OS
 
 * mount a dedicated disk for bitcoin at `/bitcoin` of 1TB
 * mount a dedicated disk for stacks-blockchain at `/stacks-blockchain` of at least 100GB
 * root volume `/` of at least 25GB
 {% endstep %}
 
 {% step %}
-### Combined Disk for all data
+#### Combined Disk for all data
 
 * root volume `/` of at least 1TB
 {% endstep %}

docs/operate/run-a-sbtc-signer/README.md

@@ -1,4 +1,4 @@
-# How to Run sBTC Signer
+# Run a sBTC Signer
 
 {% hint style="info" %}
 This documentation provides guidelines, best-practices and recommendations for running an sBTC Signer. Review it and adapt it to your infrastructure policy before deploying it.
@@ -14,19 +14,19 @@ It is of the utmost importance to follow the recommendations below.
 
 {% stepper %}
 {% step %}
-### Prevent unauthorized access to signer infrastructure
+#### Prevent unauthorized access to signer infrastructure
 
 Prevent unauthorized access to the sBTC Signer infrastructure (the signer itself, its private key, and the associated PostgreSQL database).
 {% endstep %}
 
 {% step %}
-### Keep an offline, secure backup of the Signer private key
+#### Keep an offline, secure backup of the Signer private key
 
 Keep an offline, secure backup of the sBTC Signer private key.
 {% endstep %}
 
 {% step %}
-### Regularly backup PostgreSQL database
+#### Regularly backup PostgreSQL database
 
 Regularly backup the PostgreSQL database and store it in a secure location.
 {% endstep %}
@@ -42,11 +42,11 @@ Below are the **minimum required specs** to be able to run a sBTC signer.
 * 4GB memory
 * 50GB storage
 
-Note that these are in _addition_ to the hardware requirements for running a Stacks node and Bitcoin node outlined in the [How to Run a Signer doc](https://app.gitbook.com/s/4cpTb2lbw0LAOuMHrvhA/run-a-signer).
+Note that these are in _addition_ to the hardware requirements for running a Stacks node and Bitcoin node outlined in the [How to Run a Signer doc](../run-a-signer/).
 
 ## Connection diagram
 
-<figure><img src="../.gitbook/assets/image (8).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/image%20(8).png" alt=""><figcaption></figcaption></figure>
 
 ## Configure your Bitcoin node
 
@@ -69,19 +69,19 @@ The signer connects to Bitcoin Core via RPC and polls for new bitcoin blocks. Th
 
 {% stepper %}
 {% step %}
-### Bitcoin Core validates a new block
+#### Bitcoin Core validates a new block
 
 Bitcoin Core validates a new block.
 {% endstep %}
 
 {% step %}
-### Signer detects the block via RPC polling
+#### Signer detects the block via RPC polling
 
 Signer detects the block via RPC polling.
 {% endstep %}
 
 {% step %}
-### Signer processes relevant sBTC transactions
+#### Signer processes relevant sBTC transactions
 
 Signer processes relevant sBTC transactions.
 {% endstep %}

docs/operate/run-a-sbtc-signer/best-practices-for-running-an-sbtc-signer.md

@@ -1,4 +1,4 @@
-# Best Practices for running an sBTC Signer
+# Best Practices for Running a sBTC Signer
 
 The following best practices suggest how to create a resilient setup for running your sBTC Signer.
 
@@ -16,13 +16,13 @@ The following best practices suggest how to create a resilient setup for running
 
 {% stepper %}
 {% step %}
-### Import the backup
+#### Import the backup
 
 Import the backup into a fresh PostgreSQL instance. The database alone is sufficient — you do not need to spin up a Stacks or Bitcoin node or the sBTC signer.
 {% endstep %}
 
 {% step %}
-### Run the verification query
+#### Run the verification query
 
 Execute the following query:
 
@@ -51,7 +51,7 @@ The most recent `aggregate_key` is the first row.
 {% endstep %}
 
 {% step %}
-### Compare with the on-chain aggregate key
+#### Compare with the on-chain aggregate key
 
 Fetch the current aggregate pubkey from the sbtc-registry contract and compare it to the most recent `aggregate_key` from the DB query:
 
@@ -118,4 +118,3 @@ You can use Prometheus metrics to monitor signer health. For example, see how Al
 * Ensure that multiple, trusted system administrators can manage and maintain your sBTC Signer instance.
 * Where feasible, system administrators should span different time zones.
 * Document your operations procedures and ensure that relevant personnel have access to them.
-