9a53f4dca5
* fix: removed unused sections * Update book/src/ui-authentication.md Co-authored-by: chonghe <44791194+chong-he@users.noreply.github.com> * feat: added more information about features and screenshots * Update book/src/ui-usage.md Co-authored-by: chonghe <44791194+chong-he@users.noreply.github.com> * Update book/src/ui-usage.md Co-authored-by: chonghe <44791194+chong-he@users.noreply.github.com> * Update book/src/ui-usage.md Co-authored-by: chonghe <44791194+chong-he@users.noreply.github.com> * Update book/src/ui-usage.md Co-authored-by: chonghe <44791194+chong-he@users.noreply.github.com> * Update book/src/ui-usage.md Co-authored-by: chonghe <44791194+chong-he@users.noreply.github.com> * Update book/src/ui-installation.md Co-authored-by: chonghe <44791194+chong-he@users.noreply.github.com> * Update book/src/ui-usage.md Co-authored-by: chonghe <44791194+chong-he@users.noreply.github.com> * Update ui-usage.md * Update ui-faqs.md * fix: lint fixes * Update ui-usage.md * Update book/src/ui-usage.md Co-authored-by: chonghe <44791194+chong-he@users.noreply.github.com> * Update book/src/ui-usage.md Co-authored-by: chonghe <44791194+chong-he@users.noreply.github.com> * Update book/src/ui-usage.md Co-authored-by: chonghe <44791194+chong-he@users.noreply.github.com> * add siren's ssl certificate usage to `book` * update `ui` docs * lint fixes * Update book/src/ui-installation.md Co-authored-by: chonghe <44791194+chong-he@users.noreply.github.com>
2.1 KiB
Configuration
Siren requires a connection to both a Lighthouse Validator Client and a Lighthouse Beacon Node.
To enable connection, you must generate .env file based on the provided .env.example
Connecting to the Clients
Both the Beacon node and the Validator client need to have their HTTP APIs enabled.
These ports should be accessible from Siren.
To enable the HTTP API for the beacon node, utilize the --gui CLI flag. This action ensures that the HTTP API can be accessed by other software on the same machine.
The Beacon Node must be run with the
--guiflag set.
If you require accessibility from another machine within the network, configure the --http-address to match the local LAN IP of the system running the Beacon Node and Validator Client.
To access from another machine on the same network (192.168.0.200) set the Beacon Node and Validator Client
--http-addressas192.168.0.200. When this is set, the validator client requires the flag--beacon-nodes http://192.168.0.200:5052to connect to the beacon node.
In a similar manner, the validator client requires activation of the --http flag, along with the optional consideration of configuring the --http-address flag. If --http-address flag is set on the Validator Client, then the --unencrypted-http-transport flag is required as well. These settings will ensure compatibility with Siren's connectivity requirements.
If you run the Docker container, it will fail to startup if your BN/VC are not accessible, or if you provided a wrong API token.
API Token
The API Token is a secret key that allows you to connect to the validator
client. The validator client's HTTP API is guarded by this key because it
contains sensitive validator information and the ability to modify
validators. Please see Validator Authorization
for further details.
Siren requires this token in order to connect to the Validator client.
The token is located in the default data directory of the validator
client. The default path is
~/.lighthouse/<network>/validators/api-token.txt.
The contents of this file for the desired validator client needs to be entered.