> For the complete documentation index, see [llms.txt](https://docs.eridian.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.eridian.xyz/ethereum-dev/infrastructure/client-software/beacon-clients/lighthouse/installation.md). # Installation ## Create Aliases {% code fullWidth="true" %} ```bash echo "alias lighthouse-version-current='/usr/local/bin/lighthouse --version'" >> ~/.bashrc echo "alias lighthouse-build='~/lighthouse-build.sh'" >> ~/.bashrc echo "alias lighthouse-version-new='~/.cargo/bin/lighthouse --version'" >> ~/.bashrc echo "alias lighthouse-deploy='~/lighthouse-deploy.sh'" >> ~/.bashrc echo "alias lighthouse-beacon-log='journalctl -f -u lighthousebeacon.service -o cat | ccze -A'" >> ~/.bashrc echo "alias lighthouse-beacon-start='sudo systemctl start lighthousebeacon.service'" >> ~/.bashrc echo "alias lighthouse-beacon-stop='sudo systemctl stop lighthousebeacon.service'" >> ~/.bashrc echo "alias lighthouse-beacon-restart='sudo systemctl restart lighthousebeacon.service'" >> ~/.bashrc echo "alias lighthouse-beacon-status='sudo systemctl status lighthousebeacon.service'" >> ~/.bashrc echo "alias lighthouse-beacon-config='sudo vim /etc/systemd/system/lighthousebeacon.service'" >> ~/.bashrc echo "alias lighthouse-beacon-enable='sudo systemctl enable lighthousebeacon.service'" >> ~/.bashrc echo "alias lighthouse-beacon-disable='sudo systemctl disable lighthousebeacon.service'" >> ~/.bashrc echo "alias lighthouse-beacon-delete-data='sudo rm -rf /var/lib/lighthouse/beacon; sudo mkdir -p /var/lib/lighthouse/beacon; sudo chown -R lighthousebeacon:lighthousebeacon /var/lib/lighthouse/beacon'" >> ~/.bashrc source ~/.bashrc ``` {% endcode %} ## Dependency - Install Rust ```bash curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh <1> source $HOME/.cargo/env ``` Make sure `protoc` is installed otherwise the build will fail. ```bash sudo apt-get install -y protobuf-compiler protoc --version ``` ## Lighthouse - Install Build the latest version of `Lighthouse`. ```bash LIGHTHOUSE_VERSION_COMMIT_HASH= # e.g.441fc16 cd ~ git clone https://github.com/sigp/lighthouse.git cd ~/lighthouse git checkout ${LIGHTHOUSE_VERSION_COMMIT_HASH} make ``` Move the compiled `Lighthouse` build to a new directory. ```bash sudo cp ~/.cargo/bin/lighthouse /usr/local/bin ``` Check version. ```bash /usr/local/bin/lighthouse --version ``` Create `Lighthouse` directory. ```bash sudo mkdir -p /var/lib/lighthouse ``` ## Firewall Configuration Configure the firewall using generic Beacon client UFW settings: [Beacon Clients](/ethereum-dev/infrastructure/client-software/beacon-clients.md#ufw-config) ## Lighthouse BN - Configure Service Create `lighthousebeacon` user and set permissions. ```bash sudo useradd --no-create-home --shell /bin/false lighthousebeacon sudo mkdir -p /var/lib/lighthouse/beacon sudo chown -R lighthousebeacon:lighthousebeacon /var/lib/lighthouse/beacon ``` Configure [Beacon Clients](/ethereum-dev/infrastructure/client-software/beacon-clients.md#beacon-service-environment-variables). Configure `lighthousebeacon` service using the command line flags. ```bash sudo vim /etc/systemd/system/lighthousebeacon.service ``` {% tabs %} {% tab title="lighthousebeacon.service" %} {% code title="lighthousebeacon.service" %} ```bash [Unit] Description=Lighthouse Ethereum Client - Beacon Node After=network-online.target Wants=network-online.target [Service] Type=simple User=lighthousebeacon Group=lighthousebeacon Restart=always RestartSec=5 EnvironmentFile=/etc/default/beacon-variables.env ExecStart=/usr/local/bin/lighthouse bn \ --network ${NETWORK} \ --datadir /var/lib/lighthouse \ --jwt-secrets="/var/lib/jwtsecret" \ --execution-endpoints ${BEACON_EXECUTION_ENDPOINTS} \ --port ${BEACON_P2P_PORT} \ \ --http \ --http-address=${BEACON_HTTP_ADDRESS} \ --http-port=${BEACON_HTTP_PORT} \ --http-allow-origin "*" \ \ --metrics \ --metrics-address ${BEACON_METRICS_ADDR} \ --metrics-port ${BEACON_METRICS_PORT} \ --metrics-allow-origin "*" \ --validator-monitor-auto \ \ --suggested-fee-recipient ${BEACON_SUGGESTED_FEE_RECIPIENT} \ --checkpoint-sync-url ${BEACON_CHECKPOINT_SYNC_URL} \ --builder ${BEACON_BUILDER} [Install] WantedBy=multi-user.target ``` {% endcode %} {% endtab %} {% tab title="Lighthouse BN Flags Explained" %} | `/usr/local/bin/lighthouse bn` | Starts the `Beacon` node. | | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--network` | Name of the chain Lighthouse will sync and follow (e.g. `mainnet` or `goerli`). | | `--datadir` | Used to specify a custom root data directory for lighthouse keys and databases. | | `--port` | The TCP/UDP port to listen on for peer discovery. | | `--http` |

Enable the RESTful HTTP API server.

| | `--http-address` | Specify the listening address of the server. | | `--http-port` | Specify the listening port of the server. | | `--metrics` |

Enable the Prometheus metrics HTTP server.

| | `--validator-monitor-auto` |

When the --validator-monitor-auto flag is supplied, any validator which uses the beacon\_committee\_subscriptions API endpoint will be enrolled for additional monitoring.

| |

--monitoring-endpoint
(Not curreclty used)

|

Enables the monitoring service for sending system metrics to a remote endpoint.

| | `--execution-endpoints` |

One or more comma-delimited server endpoints for HTTP JSON-RPC connection.

| | `--jwt-secrets` |

The JWT secret is automatically generated when Geth is first run and added to /var/lib/goethereum/

| | `--suggested-fee-recipient` |

This address receives transaction fees collected from any blocks produced by this node.

| | `--checkpoint-sync-url` |

Used to fast sync the chain rather than starting at genesis.

| | `--builder` |

Used to query the provided URL during block production for a block payload with stubbed-out transactions.

| | `--reconstruct-historic-states` |

Used to reconstruct the history of the beacon chain when checkpoint sync was used.

| | `--purge-db` | Add this flag to delete the existing database. | | {% endtab %} | | | {% endtabs %} | | Start the service and check it's working as expected. ## Command Aliases ```bash daemon-reload # Reload any changes made to the lighthousebeacon.service lighthouse-beacon-enable # Enable the lighthousebeacon.service lighthouse-beacon-start # Start the lighthousebeacon.service lighthouse-beacon-status # View the status of the lighthousebeacon.service lighthouse-beacon-log # View the lighthousebeacon.service logs ``` ## Lighthouse - Update Scripts Create `Lighthouse` build script. ```bash vim ~/lighthouse-build.sh ``` {% code title="\~/lighthouse-build.sh" %} ```bash #!/bin/bash set -e cd ~/lighthouse read -p "Enter the commit hash you want to checkout: " commit_hash git fetch git checkout $commit_hash echo echo "********************" echo "Making Lighthouse..." echo "********************" make ``` {% endcode %} Create `Lighthouse` deploy script. ```bash vim ~/lighthouse-deploy.sh ``` {% code title="\~/lighthouse-deploy.sh" %} ```bash #!/bin/bash # set -e # This isn't working correctly, so comment out for now while true; do read -p "Are you sure you want to deploy Lighthouse? (Y/N) " yn case $yn in [Yy]* ) break;; [Nn]* ) exit;; * ) echo "Please answer Y or N.";; esac done # Check if the services exist before checking their status if systemctl list-units --full -all | grep -Fq lighthousebeacon.service; then beacon_status=$(sudo systemctl is-active lighthousebeacon.service) else beacon_status="not_installed" fi if systemctl list-units --full -all | grep -Fq lighthousevalidator.service; then validator_status=$(sudo systemctl is-active lighthousevalidator.service) else validator_status="not_installed" fi echo "**********************" if [ "$beacon_status" = "active" ]; then echo "Stopping Lighthouse Beacon..." sudo systemctl stop lighthousebeacon.service elif [ "$beacon_status" = "not_installed" ]; then echo "Warning: Lighthouse Beacon service is not installed." fi if [ "$validator_status" = "active" ]; then echo "Stopping Lighthouse Validator..." sudo systemctl stop lighthousevalidator.service elif [ "$validator_status" = "not_installed" ]; then echo "Warning: Lighthouse Validator service is not installed." fi echo "Replacing previous version..." # Check if the file exists before trying to remove it if [ -f /usr/local/bin/lighthouse ]; then sudo rm /usr/local/bin/lighthouse fi # Check if the source file exists before copying if [ -f ~/.cargo/bin/lighthouse ]; then sudo cp ~/.cargo/bin/lighthouse /usr/local/bin else echo "Error: Source file does not exist. Installation aborted." exit 1 fi if [ "$beacon_status" = "active" ]; then echo "Restarting Lighthouse Beacon..." sudo systemctl start lighthousebeacon.service fi if [ "$validator_status" = "active" ]; then echo "Restarting Lighthouse Validator..." sudo systemctl start lighthousevalidator.service fi ``` {% endcode %} Make all scripts executable. ```bash chmod u+x ~/lighthouse-build.sh chmod u+x ~/lighthouse-deploy.sh ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.eridian.xyz/ethereum-dev/infrastructure/client-software/beacon-clients/lighthouse/installation.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.