Revise Siren documentation #6553
Conversation
|
|
||
| > To access from another machine on the same network (192.168.0.200) set the Beacon Node and Validator Client `--http-address` as `192.168.0.200`. When this is set, the validator client requires the flag `--beacon-nodes http://192.168.0.200:5052` to connect to the beacon node. |
There was a problem hiding this comment.
I am not sure about this part. I think this is not necessary if we can connect Siren via SSH. Proposing to remove this to make things simpler.
There was a problem hiding this comment.
The aim for Siren is to be as easily accessible as possible, asking them to expose a port over a reverse ssh tunnel is way more complicated. Just exposing the port and accessing the webapp directly that way fits better in the end-user application
|
|
||
| 1. You can now start Siren with: | ||
| ```bash | ||
| docker run --rm -ti --name siren -p 4443:443 --env-file $PWD/.env --net host sigp/siren |
There was a problem hiding this comment.
I still don't get the port 4443:443. Removing the flag -p 4443:443 still works, though with a warning:
metadata.metadataBase is not set for resolving social open graph or twitter images, using "http://localhost:3000". See https://nextjs.org/docs/app/api-reference/functions/generate-metadata#metadatabase
Should we keep this? I am not sure if we keep this, but we haven't used it anywhere else later. Please feel free to correct me.
There was a problem hiding this comment.
--net host is the culprit here: it automatically exposes all ports to the host (including port 80)
it is really bad to advise it as default as it is hugely unsafe.
for some reason it it necessary for people who installed docker though a snap though.
|
|
||
| 1. You can now start Siren with: | ||
| ```bash | ||
| docker run --rm -ti --name siren -p 4443:443 --env-file $PWD/.env --net host sigp/siren |
There was a problem hiding this comment.
--net host is the culprit here: it automatically exposes all ports to the host (including port 80)
it is really bad to advise it as default as it is hugely unsafe.
for some reason it it necessary for people who installed docker though a snap though.
|
|
||
| > To access from another machine on the same network (192.168.0.200) set the Beacon Node and Validator Client `--http-address` as `192.168.0.200`. When this is set, the validator client requires the flag `--beacon-nodes http://192.168.0.200:5052` to connect to the beacon node. |
There was a problem hiding this comment.
The aim for Siren is to be as easily accessible as possible, asking them to expose a port over a reverse ssh tunnel is way more complicated. Just exposing the port and accessing the webapp directly that way fits better in the end-user application
|
|
||
| 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 | ||
| Siren supports any operating system that supports container runtimes and/or NodeJS 18, this includes Linux, MacOS, and Windows. The recommended way of running Siren is by launching the [docker container](https://hub.docker.com/r/sigp/siren). |
There was a problem hiding this comment.
| Siren supports any operating system that supports container runtimes and/or NodeJS 18, this includes Linux, MacOS, and Windows. The recommended way of running Siren is by launching the [docker container](https://hub.docker.com/r/sigp/siren). | |
| Siren supports any operating system that supports container runtimes and/or NodeJS 18, this includes Linux, MacOS, and Windows. The recommended way of running Siren is by launching the [docker container](https://hub.docker.com/r/sigp/siren). | |
| Ubuntu users: Please note that Docker installed as a snap is not ideal; the preferred way to install Docker on Ubuntu is outlined [here.](https://docs.docker.com/engine/install/ubuntu/) |
| 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. | ||
| ## Running the Docker container (Recommended) | ||
|
|
||
| The common usage is to run Siren at a client computer connecting to a server running the node. The following guide is to setup Siren at a client computer and connect it to the server via SSH, so that Siren can be accessed and viewed from the client computer's browser. |
There was a problem hiding this comment.
this is 100% not the case anymore with the "new" dockerised setup.
the preferred way to run it nowadays is to have the docker container as close to the BN and VC as possible, running all the time, with its https port exposed to local LAN.
(this was the whole reason of the architectural overahaul)
|
|
||
| When Siren is successfully run, you should see the log `LOG [NestApplication] Nest application successfully started +118ms`, indicating that Siren has started. | ||
|
|
||
| 1. On the client computer, SSH to the server: |
There was a problem hiding this comment.
same comment as before; no ssh should be necessary.
expose the https port on the node, access over https.
Proposed Changes
Update Siren documentation in Lighthouse book. There are quite some changes compared to the original doc so I will leave some comments to sections to highlight the change. I have also combined
ConfigurationandInstallationtogether as they are quite related to start Siren.