Skip to content

Commit

Permalink
GITBOOK-92: Update release links
Browse files Browse the repository at this point in the history
  • Loading branch information
@kenrogers @gitbook-bot
kenrogers authored and gitbook-bot committed Apr 16, 2024
1 parent ea4ae0a commit 13c10b2
Showing 1 changed file with 16 additions and 17 deletions.
33 changes: 16 additions & 17 deletions nakamoto-upgrade/signing-and-stacking/running-a-signer.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ This doc will provide instructions on how to set up both using either Docker or

It will also walk through how to set up the config files to get the signer and Stacks node communicating correctly.

The Nakamoto release and thus the signer software you'll want to run is contained in the Stacks core repo Release Candidate 2.5.0.0.0, which can be found here.

### Knowledge Prerequisites

* Docker and basic knowledge of pulling and running images
Expand Down Expand Up @@ -109,13 +107,16 @@ Create a new file called `signer-config.toml`. In that file, put the contents fr

There are two options for running the signer: Docker and building from source. The recommended option is to use Docker. If you want to run as a binary, you will need to build `stacks-core` from source. Instructions for how to do this are contained below in the relevant section.

{% hint style="warning" %}
Note that at the moment the signer should only be run on testnet using these instructions. The mainnet release is still under development.
{% endhint %}

#### Running the Signer with Docker

You can run the signer as a Docker container using the [`blockstack/stacks-core:2.5.0.0.0-rc1` image](https://hub.docker.com/r/blockstack/stacks-core/tags?page=1\&name=2.5.0.0.0-rc1). When pulling the Docker image, be sure you are using the `2.5.0.0.1-rc1` tag, as the main branch will not have the signer binary.
You can run the signer as a Docker container using the [`blockstack/stacks-core:2.5.0.0.0-rc5`](https://hub.docker.com/layers/blockstack/stacks-core/2.5.0.0.0-rc5/images/sha256-5e8df14356c2e5dc9500dea0a210c9135f1f0347072a2658fbd737a81638e831?context=explore) image. When pulling the Docker image, be sure you are using the `2.5.0.0.0-rc5` tag, as the main branch will not have the signer binary.

When running the Docker container, you’ll need to ensure a few things:

* You'll want to use the `2.5.0.0.0-rc1` tag of the image, as that includes the signer binary
* The port configured as the `endpoint` (in the above example, “30000”) must be exposed to your Stacks node.
* You’ll need a volume with at least a few GB of available storage that contains the folder your `db_path` is in. In the above example, that would be /var
* You’ll need to include your `signer-config.toml` file as noted below with the first `-v` flag
Expand All @@ -126,7 +127,7 @@ Be sure to replace the `STX_SIGNER_PATH` with the correct path to your config fi

```bash
IMG="blockstack/stacks-core"
VER="2.5.0.0.0-rc1"
VER="2.5.0.0.0-rc5"
STX_SIGNER_PATH="./"
STX_SIGNER_DATA="$STX_SIGNER_PATH/data"
STX_SIGNER_CONFIG="$STX_SIGNER_PATH/signer-config.toml"
Expand All @@ -143,29 +144,27 @@ docker run -d \
```

{% hint style="info" %}
If you get an error saying that the manifest cannot be found or about the requested image platform not matching the host platform, you are probably running on system architecture other than x64 arch. Since you are using a PR release (`2.5.0.0.1-rc1`) you'll need to specify your platform with the `--platform` flag.
If you get an error saying that the manifest cannot be found or about the requested image platform not matching the host platform, you are probably running on system architecture other than x64 arch. Since you are using a PR release you'll need to specify your platform with the `--platform` flag.

For example, if you are running on M1 Mac, you would add `--platform=linux/amd64` to the above command.
{% endhint %}

Or, with a custom Dockerfile:

```docker
FROM blockstack/stacks-core:2.5.0.0.0-rc1
FROM blockstack/stacks-core:2.5.0.0.0-rc5
COPY signer-config.toml /config.toml
EXPOSE 30000
CMD ["stacks-signer", "run", "--config", "/config.toml"]
```

#### Running the Signer as a Binary

The current release does not have the stacks-signer binary. If you want to run the signer as a binary right now, you'll need to [build `stacks-core` from source](https://github.com/stacks-network/stacks-core?tab=readme-ov-file#building).
If you do not want to use Docker, you can alternatively run your stacks node as a binary.

{% hint style="info" %}
Official binaries are available from the [Stacks Core releases page on Github](https://github.com/stacks-network/stacks-core/releases). Each release includes pre-built binaries. After Nakamoto is officially released, you will be able to download the ZIP file for your server’s architecture and decompress it. Inside of that folder will be a `stacks-signer` binary.
{% endhint %}
Official binaries are available from the [Stacks Core releases page on Github](https://github.com/stacks-network/stacks-core/releases). Each release includes pre-built binaries. Download the ZIP file for your server’s architecture and decompress it. Inside of that folder is a `stacks-signer` binary.

After you run `cargo build`, you can then run the signer with the following command (be sure to replace `../signer-config.toml` with the actual path of your config file).
You can run the signer with the following command (be sure to replace `../signer-config.toml` with the actual path of your config file).

```bash
stacks-signer run --config ../signer-config.toml
Expand Down Expand Up @@ -225,12 +224,12 @@ The important aspects that you’ll need to change are:

If you are running your Stacks node on the primary testnet, it will be much faster to start with an archive of the chain state rather than syncing from genesis.

Archives can be found from [https://archive.hiro.so](https://archive.hiro.so). For the Stacks node testnet, the latest snapshot can be found at [https://archive.hiro.so/testnet/stacks-blockchain/testnet-stacks-blockchain-2.5.0.0.0-rc1-latest.tar.gz](https://archive.hiro.so/testnet/stacks-blockchain/testnet-stacks-blockchain-2.5.0.0.0-rc1-latest.tar.gz). Note that the version is specified (2.5.0.0.0-rc1). When we update versions (ie to a new RC), that URL will need to change. You can also [browse all testnet snapshots](https://archive.hiro.so/testnet/stacks-blockchain/).
Archives can be found from [https://archive.hiro.so](https://archive.hiro.so). For the Stacks node testnet, the latest snapshot can be found at [https://archive.hiro.so/testnet/stacks-blockchain/testnet-stacks-blockchain-2.5.0.0.0-rc5-latest.tar.gz](https://archive.hiro.so/testnet/stacks-blockchain/testnet-stacks-blockchain-2.5.0.0.0-rc5-latest.tar.gz). Note that the version is specified (2.5.0.0.0-rc5). When we update versions (ie to a new RC), that URL will need to change. You can also [browse all testnet snapshots](https://archive.hiro.so/testnet/stacks-blockchain/).

You’ll want to download this on the same machine that will run the Stacks node. One way to do this is:

```
curl https://archive.hiro.so/testnet/stacks-blockchain/testnet-stacks-blockchain-2.5.0.0.0-rc1-latest.tar.gz -o stacks-snapshot.tar.gz
curl https://archive.hiro.so/testnet/stacks-blockchain/testnet-stacks-blockchain-2.5.0.0.0-rc5-latest.tar.gz -o stacks-snapshot.tar.gz
tar -zxvf stacks-snapshot.tar.gz
```

Expand All @@ -257,7 +256,7 @@ An example for running the node’s Docker image with docker run is below. Be su

```bash
IMG="blockstack/stacks-core"
VER="2.5.0.0.0-rc1"
VER="2.5.0.0.0-rc5"
STX_NODE_CONFIG="./node-config.toml"

docker run -d \
Expand All @@ -274,7 +273,7 @@ docker run -d \
Or, using a custom Dockerfile:

```docker
FROM blockstack/stacks-core:2.5.0.0.0-rc1
FROM blockstack/stacks-core:2.5.0.0.0-rc5
COPY node-config.toml /config.toml
EXPOSE 20444
EXPOSE 20443
Expand All @@ -283,7 +282,7 @@ CMD ["stacks-node", "start", "--config", "/config.toml"]

#### Run a Stacks Node with a Binary

If you do not want to use Docker, you can alternatively run the signer as a binary.
If you do not want to use Docker, you can alternatively run your stacks node as a binary.

Official binaries are available from the [Stacks Core releases page on Github](https://github.com/stacks-network/stacks-core/releases). Each release includes pre-built binaries. Download the ZIP file for your server’s architecture and decompress it. Inside of that folder is a `stacks-node` binary.

Expand Down

0 comments on commit 13c10b2

Please sign in to comment.