diff --git a/book/src/ui-configuration.md b/book/src/ui-configuration.md index b2a011065c2..eeb2c9a51cd 100644 --- a/book/src/ui-configuration.md +++ b/book/src/ui-configuration.md @@ -18,7 +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 the Docker container, it will fail to startup if your BN/VC are not accessible, or if you provided a wrong API token. +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 diff --git a/book/src/ui-faqs.md b/book/src/ui-faqs.md index 52d4a9680c8..efa6d3d4ab2 100644 --- a/book/src/ui-faqs.md +++ b/book/src/ui-faqs.md @@ -14,19 +14,17 @@ If you receive a red notification with a BEACON or VALIDATOR NODE NETWORK ERROR ## 4. How do I connect Siren to Lighthouse from a different computer on the same network? -Siren is a webapp, you can access it like any other website. We don't recommend exposing it to the internet; if you require remote access a VPN or (authenticated) reverse proxy is highly recommended. +Siren is a webapp, you can access it like any other website. We don't recommend exposing it to the internet; if you require remote access a VPN or (authenticated) reverse proxy is highly recommended. ## 5. How can I use Siren to monitor my validators remotely when I am not at home? Most contemporary home routers provide options for VPN access in various ways. A VPN permits a remote computer to establish a connection with internal computers within a home network. With a VPN configuration in place, connecting to the VPN enables you to treat your computer as if it is part of your local home network. The connection process involves following the setup steps for connecting via another machine on the same network on the Siren configuration page and [`connecting to clients section`](./ui-configuration.md#connecting-to-the-clients). - ## 6. Does Siren support reverse proxy or DNS named addresses? Yes, if you need to access your beacon or validator from an address such as `https://merp-server:9909/eth2-vc` you should configure Siren as follows: `VALIDATOR_URL=https://merp-server:9909/eth2-vc` - ## 7. Why doesn't my validator balance graph show any data? If your graph is not showing data, it usually means your validator node is still caching data. The application must wait at least 3 epochs before it can render any graphical visualizations. This could take up to 20min. diff --git a/book/src/ui-installation.md b/book/src/ui-installation.md index fc3f151fcb0..521454880db 100644 --- a/book/src/ui-installation.md +++ b/book/src/ui-installation.md @@ -6,11 +6,10 @@ Siren supports any operating system that supports container runtimes and/or Node To ensure proper functionality, the Siren app requires Lighthouse v4.3.0 or higher. You can find these versions on the [releases](https://github.com/sigp/lighthouse/releases) page of the Lighthouse repository. - ## Running the Docker container (Recommended) -The most convenient way to run Siren is to use the Docker images built and published by Sigma Prime. - +The most convenient way to run Siren is to use the Docker images built and published by Sigma Prime. + They can be found on [Docker hub](https://hub.docker.com/r/sigp/siren/tags), or pulled directly with `docker pull sigp/siren` Configuration is done through environment variables, the easiest way to get started is by copying `.env.example` to `.env` and editing the relevant sections (typically, this would at least include adding `BEACON_URL`, `VALIDATOR_URL` and `API_TOKEN`) @@ -23,9 +22,9 @@ or This command will open port 4443, allowing your browser to connect. -To start Siren, visit `https://localhost:4443` in your web browser. +To start Siren, visit `https://localhost:4443` in your web browser. -Advanced users can mount their own certificates, see the `SSL Certificates` section below +Advanced users can mount their own certificates, see the `SSL Certificates` section below ## Building From Source @@ -36,7 +35,7 @@ The docker image can be built with the following command: ### Building locally -To build from source, ensure that your system has `Node v18.18` and `yarn` installed. +To build from source, ensure that your system has `Node v18.18` and `yarn` installed. #### Build and run the backend @@ -52,24 +51,23 @@ This will allow you to access siren at `http://localhost:3000` by default. ### About self-signed SSL certificates -By default, Siren will generate and use a self-signed certificate on startup. -This will generate a security warning when you try to access the interface. -We recommend to only disable SSL if you would access Siren over a local LAN or otherwise highly trusted or encrypted network (i.e. VPN). +By default, Siren will generate and use a self-signed certificate on startup. +This will generate a security warning when you try to access the interface. +We recommend to only disable SSL if you would access Siren over a local LAN or otherwise highly trusted or encrypted network (i.e. VPN). -#### Generating persistent SSL certificates and installing them to your system +#### Generating persistent SSL certificates and installing them to your system -[mkcert](https://github.com/FiloSottile/mkcert) is a tool that makes it super easy to generate a self-signed certificate that is trusted by your browser. +[mkcert](https://github.com/FiloSottile/mkcert) is a tool that makes it super easy to generate a self-signed certificate that is trusted by your browser. To use it for `siren`, install it following the instructions. Then, run `mkdir certs; mkcert -cert-file certs/cert.pem -key-file certs/key.pem 127.0.0.1 localhost` (add or replace any IP or hostname that you would use to access it at the end of this command) The nginx SSL config inside Siren's container expects 3 files: `/certs/cert.pem` `/certs/key.pem` `/certs/key.pass`. If `/certs/cert.pem` does not exist, it will generate a self-signed certificate as mentioned above. If `/certs/cert.pem` does exist, it will attempt to use your provided or persisted certificates. - ### Configuration through environment variables -For those who prefer to use environment variables to configure Siren instead of using an `.env` file, this is fully supported. In some cases this may even be preferred. +For those who prefer to use environment variables to configure Siren instead of using an `.env` file, this is fully supported. In some cases this may even be preferred. -#### Docker installed through `snap` +#### Docker installed through `snap` -If you installed Docker through a snap (i.e. on Ubuntu), Docker will have trouble accessing the `.env` file. In this case it is highly recommended to pass the config to the container with environment variables. -Note that the defaults in `.env.example` will be used as fallback, if no other value is provided. \ No newline at end of file +If you installed Docker through a snap (i.e. on Ubuntu), Docker will have trouble accessing the `.env` file. In this case it is highly recommended to pass the config to the container with environment variables. +Note that the defaults in `.env.example` will be used as fallback, if no other value is provided.