Skip to content

Commit 519dfce

Browse files
fabrizio-stackswileyj
authored andcommitted
Fixes after Jesse review
1 parent c6cf7dd commit 519dfce

7 files changed

Lines changed: 22 additions & 15 deletions

File tree

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@
66

77
This guide is a step-by-step walkthrough for setting up and running a signer. It covers only the signer infrastructure: the signer software and the Stacks node it connects to.
88

9-
If you are not familiar with the concept of signing, be sure to check out the [Stackers and Signing concept guide](https://app.gitbook.com/s/H74xqoobupBWwBsVMJhK/block-production/signing).
9+
If you are not familiar with the concept of signing, be sure to check out the [Stackers and Signing concept guide](../../learn/block-production/signing.md).
1010

1111
### Background and High-Level Process
1212

1313
To run a signer you'll run a signer and a Stacks node side-by-side. Specifically, run a follower node. The signer monitors events from the Stacks node and uses the generated account (see Preflight Setup) to sign incoming Stacks blocks sent from the Stacks node.
1414

15-
This doc provides instructions to set up both using either Docker or the release binaries available in the [stacks core releases](https://github.com/stacks-network/stacks-core/releases) repository, and how to configure them so the signer and Stacks node communicate correctly.
15+
This doc provides instructions to set up both using either Docker or the release binaries available in the [stacks core releases](https://github.com/stacks-network/stacks-core/releases/latest) repository, and how to configure them so the signer and Stacks node communicate correctly.
1616

1717
### Knowledge Prerequisites
1818

1919
* Docker and basic knowledge of pulling and running images
20-
* Basic knowledge of [Stacks accounts](https://app.gitbook.com/s/H74xqoobupBWwBsVMJhK/network-fundamentals/wallets-and-accounts)
20+
* Basic knowledge of [Stacks accounts](../../learn/network-fundamentals/wallets-and-accounts.md)
2121

2222
{% stepper %}
2323
{% step %}
@@ -114,13 +114,13 @@ Signers are intended to work with a local node. The node<->signer connection is
114114

115115
## Create a Configuration File
116116

117-
Create a file named `signer-config.toml`. Populate it with the example signer config file contents from the [Sample Configuration Files](https://app.gitbook.com/s/GVj1Z9vMuEOMe7oH7Wnq/node-operations/signer-configuration) page. Each field is described on that page.
117+
Create a file named `signer-config.toml`. Populate it with the example signer config file contents from the [Sample Configuration Files](../../reference/node-operations/signer-configuration.md) page. Each field is described on that page.
118118

119119
***
120120

121121
## Running the Signer
122122

123-
Two options: Docker (recommended) or binary. Binaries are available on the [Stacks Core releases page](https://github.com/stacks-network/stacks-core/releases).
123+
Two options: Docker (recommended) or binary. Binaries are available on the [Stacks Core releases page](https://github.com/stacks-network/stacks-core/releases/latest).
124124

125125
### Running the Signer with Docker
126126

@@ -168,7 +168,7 @@ CMD ["stacks-signer", "run", "--config", "/config.toml"]
168168

169169
### Running the Signer as a Binary
170170

171-
Download the pre-built binaries from the [Stacks Core releases page on Github](https://github.com/stacks-network/stacks-core/releases), unzip the archive for your architecture. It includes the `stacks-signer` binary.
171+
Download the pre-built binaries from the [Stacks Core releases page on Github](https://github.com/stacks-network/stacks-core/releases/latest), unzip the archive for your architecture. It includes the `stacks-signer` binary.
172172

173173
Run the signer:
174174

@@ -229,7 +229,7 @@ Start the Stacks node after the signer is running. The node will not run unless
229229

230230
### Stacks Node Configuration
231231

232-
Create `node-config.toml`. See the [Sample Configuration Files](https://app.gitbook.com/s/GVj1Z9vMuEOMe7oH7Wnq/node-operations/signer-configuration) page for the full contents.
232+
Create `node-config.toml`. See the [Sample Configuration Files](../../reference/node-operations/signer-configuration.md) page for the full contents.
233233

234234
Important fields to change:
235235

@@ -296,7 +296,7 @@ If you get connection refused errors, you may need to point `events_observer.end
296296

297297
### Run a Stacks Node with a Binary
298298

299-
Download the pre-built `stacks-node` binary from the [Stacks Core releases](https://github.com/stacks-network/stacks-core/releases).
299+
Download the pre-built `stacks-node` binary from the [Stacks Core releases](https://github.com/stacks-network/stacks-core/releases/latest).
300300

301301
Start the node:
302302

docs/operate/run-a-signer/best-practices-to-run-a-signer.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,13 @@ sudo systemctl status stacks-signer.service
193193
sudo systemctl status stacks-node.service
194194
```
195195

196+
View logs with:
197+
198+
```bash
199+
journalctl -xefu stacks-signer
200+
journalctl -xefu stacks-node
201+
```
202+
196203
### Backup signer keys in cold-storage
197204

198205
* Keep an offline, secure backup of all Signer private keys (e.g., hardware security modules or encrypted storage devices).

docs/operate/run-a-signer/signer-quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
If you want to get up and running as an active signer as quickly as possible, here is a list of the commands you need to run and actions to take.
1818

19-
If you are not familiar with how signing works yet, be sure to check out the [Signing concept guide](https://app.gitbook.com/s/H74xqoobupBWwBsVMJhK/block-production/signing).
19+
If you are not familiar with how signing works yet, be sure to check out the [Signing concept guide](../../learn/block-production/signing.md).
2020

2121
{% hint style="danger" %}
2222
The CLI examples below may show outdated release versions. For the latest releases, always refer to the links above in the top info block.
@@ -88,7 +88,7 @@ From this file, you'll need the `privateKey` value.
8888

8989
**Download the stacks-signer binary**
9090

91-
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 [latest signer release ZIP file](https://github.com/stacks-network/stacks-core/releases/latest) for your server’s architecture and decompress it. Inside of that folder is a `stacks-signer` binary.
91+
Official binaries are available from the [Stacks Core releases page on Github](https://github.com/stacks-network/stacks-core/releases/latest). Each release includes pre-built binaries. Download the [latest signer release ZIP file](https://github.com/stacks-network/stacks-core/releases/latest) for your server’s architecture and decompress it. Inside of that folder is a `stacks-signer` binary.
9292

9393
Assuming a `Linux x64 glibc` machine, the commands to download and uncompress the signer binary look like this:
9494

@@ -201,7 +201,7 @@ We have created guides for running both a [full Bitcoin node](../run-a-node/run-
201201
202202
**Download the stacks-node binary**
203203
204-
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 [latest node release ZIP file](https://github.com/stacks-network/stacks-core/releases/latest) for your server’s architecture and decompress it. Inside of that folder is a `stacks-node` binary.
204+
Official binaries are available from the [Stacks Core releases page on Github](https://github.com/stacks-network/stacks-core/releases/latest). Each release includes pre-built binaries. Download the [latest node release ZIP file](https://github.com/stacks-network/stacks-core/releases/latest) for your server’s architecture and decompress it. Inside of that folder is a `stacks-node` binary.
205205
206206
Assuming a `Linux x64 glibc` machine, the commands to download and uncompress the node binary look like this:
207207

docs/operate/stacking-stx/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Stacking STX
22

3-
Stacking is the process of locking STX tokens to support the network's consensus and earn BTC rewards. If you aren't familiar with how stacking works, read the [Stacking](https://app.gitbook.com/s/H74xqoobupBWwBsVMJhK/block-production/stacking) and [Stackers and Signing](https://app.gitbook.com/s/H74xqoobupBWwBsVMJhK/block-production/signing) concept guides first.
3+
Stacking is the process of locking STX tokens to support the network's consensus and earn BTC rewards. If you aren't familiar with how stacking works, read the [Stacking](../../learn/block-production/stacking.md) and [Stackers and Signing](../../learn/block-production/signing.md) concept guides first.
44

55
Stacking utilizes the `pox-4` contract. You can view it on the [Explorer](https://explorer.hiro.so/txid/SP000000000000000000002Q6VF78.pox-4?chain=mainnet) and review the detailed [stacking contract walkthrough](/broken/spaces/GVj1Z9vMuEOMe7oH7Wnq/pages/fc4fa1c229d8cb4deedf49de6dc1de0dc0b1ed72) to understand what each function does.
66

docs/operate/stacking-stx/operate-a-pool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This guide covers how to operate a stacking pool: accepting delegated STX from stackers, committing them to reward cycles, and managing the pool's stacked position.
44

55
{% hint style="info" %}
6-
This guide assumes you are familiar with stacking at a conceptual level. If not, read the [Stacking](https://app.gitbook.com/s/H74xqoobupBWwBsVMJhK/block-production/stacking) concept guide first.
6+
This guide assumes you are familiar with stacking at a conceptual level. If not, read the [Stacking](../../learn/block-production/stacking.md) concept guide first.
77
{% endhint %}
88

99
If you want to delegate your STX to a pool instead, see the [Stack with a Pool](stack-with-a-pool.md) guide.

docs/operate/stacking-stx/solo-stacking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This guide covers everything you need to stack independently as a solo stacker: starting, extending, increasing, and stopping your stacking position.
44

55
{% hint style="info" %}
6-
This guide assumes you are familiar with stacking at a conceptual level. If not, read the [Stacking](https://app.gitbook.com/s/H74xqoobupBWwBsVMJhK/block-production/stacking) concept guide first.
6+
This guide assumes you are familiar with stacking at a conceptual level. If not, read the [Stacking](../../learn/block-production/stacking.md) concept guide first.
77
{% endhint %}
88

99
Solo stacking requires meeting the minimum STX threshold and either running a signer or collaborating with one. The minimum amount is dynamic and can be found at the [pox endpoint](https://api.mainnet.hiro.so/v2/pox) under `min_threshold_ustx` (1 STX = 1,000,000 uSTX).

docs/operate/stacking-stx/stack-with-a-pool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This guide covers delegated stacking from the **delegator** perspective: how to delegate your STX to a pool, increase your delegation, revoke it, and stop stacking.
44

55
{% hint style="info" %}
6-
This guide assumes you are familiar with stacking at a conceptual level. If not, read the [Stacking](https://app.gitbook.com/s/H74xqoobupBWwBsVMJhK/block-production/stacking) concept guide first.
6+
This guide assumes you are familiar with stacking at a conceptual level. If not, read the [Stacking](../../learn/block-production/stacking.md) concept guide first.
77
{% endhint %}
88

99
Delegating is the most common stacking scenario. It applies when you do not meet the minimum STX threshold to solo stack and want a pool operator to stack on your behalf. This is a **non-custodial** delegation. Your STX do not leave your wallet.

0 commit comments

Comments
 (0)