Skip to content

Commit 3bb15b0

Browse files
authored
fix(docs): adding greater emphasis on staking keys backup (#986)
2 parents 0fba07f + 8ea7531 commit 3bb15b0

File tree

3 files changed

+42
-9
lines changed

3 files changed

+42
-9
lines changed

docs/run-node/2-from-source.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ Make sure to check the [hardware requirements](/run-node/system-requirements) be
122122

123123
3. (Optional) If you plan to [register your node as a validator](/run-node/register-validator).
124124
Make sure to copy the staking keys to a persistent directory outside the default location.
125+
Consider also backing up these keys to a secure vault of your choice.
125126
This is important for ensuring that your staking keys are not lost if the node is restarted or updated.
126127

127128
<Tabs groupId="network" block>

docs/run-node/3-using-docker.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,7 @@ You can run your node using either the [Docker CLI](#using-docker-cli) directly
261261

262262
4. **(Optional)** If you plan to [register your node as a validator](/run-node/register-validator).
263263
Make sure to copy the staking keys to a persistent directory outside the default location.
264+
Consider also backing up these keys to a secure vault of your choice.
264265
This is important for ensuring that your staking keys are not lost if the node is restarted or updated.
265266

266267
<Tabs groupId="network" block>
@@ -490,6 +491,7 @@ Docker Compose simplifies node management by defining the entire configuration i
490491

491492
5. **(Optional)** If you plan to [register your node as a validator](/run-node/register-validator).
492493
Make sure to copy the staking keys to a persistent directory outside the default location.
494+
Consider also backing up these keys to a secure vault of your choice.
493495
This is important for ensuring that your staking keys are not lost if the node is restarted or updated.
494496

495497
<Tabs groupId="network" block>

docs/run-node/4-register-validator.mdx

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -108,16 +108,50 @@ Only provide values which differ from the defaults to avoid issues with future u
108108
}
109109
```
110110

111+
## Backup and restore
112+
113+
:::danger[Backup your staking keys]
114+
It's imperative that prior to staking your node, you backup all three files that identify your node.
115+
These files will be generated when the node is started for the first time.
116+
117+
- `staker.key` and `staker.crt` - Make up your NodeID
118+
- `signer.key` - Defines your node's proof of possession (NodePOP). It generates the BLS key and BLS signature required for staking.
119+
120+
If these staking keys are lost due to host migrations or disaster scenarios, you will no longer be able to run the node as it's previous identity.
121+
This poses a risk of staked funds being locked against the unrecoverable NodeID until expiry of that stake, resulting in a loss of rewards and negatively impacting the network.
122+
123+
:::
124+
125+
<Tabs groupId="network" block>
126+
127+
<TabItem value="source" label="From Source" default>
128+
129+
To backup the staking keys ensure you complete [Step 3](/run-node/from-source#run-the-node) of copying your staking keys to a persistent directory outside the default location.
130+
131+
</TabItem>
132+
133+
<TabItem value="docker-compose" label="Using Docker Compose">
134+
135+
To backup the staking keys ensure you complete [Step 5](/run-node/using-docker#using-docker-compose) of copying your staking keys to a persistent directory outside the default location.
136+
137+
</TabItem>
138+
139+
<TabItem value="docker-cli" label="Using Docker CLI">
140+
141+
To backup the staking keys ensure you complete [Step 4](/run-node/using-docker#using-docker-cli) of copying your staking keys to a persistent directory outside the default location.
142+
143+
</TabItem>
144+
145+
</Tabs>
146+
111147
## Run the node
112148

113149
Now, start your node using command-line flags or environment variables that point to your `staker.key`, `staker.crt` and `signer.key` files.
114150
This ensures your node always starts with the correct `Node-ID`.
115151

116152
### From source
117153

118-
1. Ensure you completed the optional [Step 3](/run-node/from-source#run-the-node) of copying your staking keys to a persistent directory outside the default location.
119-
120-
2. Add the following flags to your [startup command](/run-node/from-source#run-the-node).
154+
1. Add the following flags to your [startup command](/run-node/from-source#run-the-node).
121155
For example, if you copied your keys to `/opt/flare/staking/`, your command would look like:
122156

123157
```bash
@@ -136,9 +170,7 @@ This ensures your node always starts with the correct `Node-ID`.
136170

137171
### Using Docker CLI
138172

139-
1. Ensure you completed the optional [Step 4](/run-node/using-docker#using-docker-cli) of copying your staking keys to a persistent directory outside the default location.
140-
141-
2. Modify your [`docker run`](/run-node/using-docker#using-docker-cli) command to mount the directory containing your keys into the container and set the environment variables to point to the mounted files.
173+
1. Modify your [`docker run`](/run-node/using-docker#using-docker-cli) command to mount the directory containing your keys into the container and set the environment variables to point to the mounted files.
142174
For example, if you copied your keys to `/opt/flare/staking/`, your command would look like:
143175

144176
```bash
@@ -165,9 +197,7 @@ This ensures your node always starts with the correct `Node-ID`.
165197

166198
### Using Docker Compose
167199

168-
1. Ensure you completed the optional [Step 5](/run-node/using-docker#using-docker-compose) of copying your staking keys to a persistent directory outside the default location.
169-
170-
2. Modify your [`docker-compose.yaml`](/run-node/using-docker#using-docker-compose) file to include the staking key volume and environment variables.
200+
1. Modify your [`docker-compose.yaml`](/run-node/using-docker#using-docker-compose) file to include the staking key volume and environment variables.
171201
For example, if you copied your keys to `/opt/flare/staking/`, your `docker-compose.yaml` would look like:
172202

173203
```yaml title="/opt/node/docker-compose.yaml"

0 commit comments

Comments
 (0)