Document Siren and Caplin (#451)

eth-educators · Aug 12, 2024 · 705015c · 705015c
1 parent d0729eb
commit 705015c
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 9 deletions.
diff --git a/website/docs/About/Overview.md b/website/docs/About/Overview.md
@@ -31,7 +31,7 @@ An Ethereum staking full node has many moving parts. Here's a high level, concep
 
 - Supports all FOSS (Free and Open Source Software) Ethereum clients in any combination: Lodestar, Nimbus, Teku,
 Grandine, Lighthouse, Prysm; and Nethermind, Besu, Reth, Erigon, Geth
-- Runs on Linux or macOS, Intel/AMD x64 or ARM CPUs
+- Runs on Linux or macOS, Intel/AMD x64 or ARM or RISC-V CPUs
 - Supports running Ethereum nodes, staking or RPC, on Ethereum and Gnosis Chain; supports running ssv.network DVT
 nodes; supports integration with RocketPool in (reverse) hybrid mode
 - Supports Grafana dashboards and alerting, either locally or Grafana Cloud or even your own remote Mimir/Thanos cluster

diff --git a/website/docs/Usage/ClientSetup.md b/website/docs/Usage/ClientSetup.md
@@ -19,6 +19,7 @@ Please choose:
   * Grandine
   * Lighthouse
   * Prysm
+  * Caplin - built into Erigon
 * Your execution client you wish to run
   * Reth
   * Besu
@@ -60,18 +61,21 @@ the file names.
 Choose one consensus client:
 
 - `teku.yml` - Teku
-- `lighthouse.yml` - Lighthouse
 - `lodestar.yml` - Lodestar
 - `nimbus.yml` - Nimbus
+- `lighthouse.yml` - Lighthouse
 - `prysm.yml` - Prysm
 
 Choose one execution client:
 
-- `nethermind.yml` - nethermind execution client
-- `besu.yml` - besu execution client
-- `reth.yml` - reth execution client
-- `erigon.yml` - erigon execution client
-- `geth.yml` - geth execution client
+- `reth.yml` - Reth
+- `besu.yml` - Besu
+- `nethermind.yml` - Nethermind
+- `erigon.yml` - Erigon execution client
+- `geth.yml` - Geth execution client
+
+> If you wish to use the built-in Caplin consensus client with Erigon, use `erigon.yml` without a consensus client file,
+and it will use the built-in Caplin consensus client
 
 Optionally, enable MEV boost:
 

diff --git a/website/docs/Usage/PrysmWeb.md b/website/docs/Usage/PrysmWeb.md
@@ -1,9 +1,17 @@
 ---
 id: PrysmWeb
-title:  Prysm Web UI.
-sidebar_label: Prysm Web
+title:  Web UI
+sidebar_label: Web UI
 ---
 
+## Lighthouse
+
+The Lighthouse Siren Web UI uses https with self-signed certificates. To use it, add `siren.yml` to `COMPOSE_FILE` in
+`.env`, and if you are not going to use traefik, add `siren-shared.yml` as well. It is then reachable on port `2443`
+by default. The port can be adjusted in `.env`.
+
+## Prysm
+
 The Prysm Web UI is insecure http, which means an [SSH tunnel](https://www.howtogeek.com/168145/how-to-use-ssh-tunneling/)
 should be used to access it if your node is on a cloud VPS.