gnosis/lighthouse
1
0
Fork 0
mirror of https://github.com/sigp/lighthouse.git synced 2026-04-18 05:18:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Siren Docs Upgrade (#5979)

Browse Source 
* 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>
This commit is contained in:
Ricki Moore
2024-07-24 06:55:00 +02:00
committed by GitHub
parent 10445f31c6
commit 9a53f4dca5
13 changed files with 111 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
book/src/ui-configuration.md
View File

@@ -1,15 +1,12 @@
# Configuration
Siren requires a connection to both a Lighthouse Validator Client
and a Lighthouse Beacon Node. Upon running you will first be greeted by the
following configuration screen.
![ui-configuration](./imgs/ui-configuration.png)
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 the computer running Siren. This allows you to enter the address and ports of the associated Lighthouse
Beacon node and Lighthouse Validator client.
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.
@@ -21,10 +18,7 @@ If you require accessibility from another machine within the network, configure
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 Siren in the browser (by entering `localhost` in the browser), you will need to allow CORS in the HTTP API. This can be done by adding the flag `--http-allow-origin "*"` for both beacon node and validator client.
A green tick will appear once Siren is able to connect to both clients. You
can specify different ports for each client by clicking on the advanced tab.
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
@@ -41,13 +35,3 @@ client. The default path is
The contents of this file for the desired validator client needs to be
entered.
## Name
This is your name, it can be modified and is solely used for aesthetics.
## Device
This is a name that can be associated with the validator client/beacon
node pair. Multiple such pairs can be remembered for quick swapping between
them.