status-im/nimbus-eth2
2
0
Fork 0
mirror of https://github.com/status-im/nimbus-eth2.git synced 2025-01-11 06:46:10 +00:00
Code Issues Projects Releases Wiki Activity

Document the Keymanager API in the book

Browse Source
This commit is contained in:
Zahary Karadjov 2022-01-13 20:19:07 +02:00
parent d878948ed2
commit e67773a495
No known key found for this signature in database
GPG Key ID: C8936F8A3073D609
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/the_nimbus_book/src/SUMMARY.md
View File

@ -55,6 +55,7 @@
# Reference
- [JSON-RPC API](./api.md)
- [REST API](./rest-api.md)
- [Keymanager API](./keymanager-api.md)
- [Help / Command line options](./options.md)
- [Advanced migration options](./migration-options.md)
- [Troubleshooting](./troubleshooting.md)

17
docs/the_nimbus_book/src/keymanager-api.md Normal file
View File

@ -0,0 +1,17 @@
# Keymanager API
The standardized [Keymanager API](https://ethereum.github.io/keymanager-APIs/) can be used to add, remove or migrate validators on the fly on a running beacon node.
## Configuration
By default, the Keymanager API is disabled. To enable it, start the beacon node with the `--keymanager` option, then access the API from http://localhost:5052/. All requests must be authorized through the `Authorization: Bearer` scheme with a token matching the contents of a file provided at the start of the node through the `--keymanager-token-file` parameter.
By default, only connections from the same machine are entertained. The port and listening address can be further configured through the options `--keymanager-port` and `--keymanager-address`.
> **Warning:** The Keymanager API port SHOULD be exposed through a secure channel, such as with HTTPs, an SSH tunnel, a VPN, etc.
## Specification
The specification is documented [here](https://ethereum.github.io/keymanager-APIs/).
See the Readme [here](https://github.com/ethereum/keymanager-APIs/).