mirror of https://github.com/sigp/lighthouse.git synced 2026-03-10 04:01:51 +00:00

Files

Geoffry Song 63fe5542e7 Remove mention of OpenSSL from documentation (#1844 )

If I'm not mistaken, openssl is no longer a dependency of lighthouse, so it can no longer cause build issues.

2020-11-09 02:31:31 +00:00

2.5 KiB

Raw Blame History

Installation: Build from Source

Lighthouse builds on Linux, macOS, and Windows (via WSL only).

Compilation should be easy. In fact, if you already have Rust installed all you need is:

git clone https://github.com/sigp/lighthouse.git
cd lighthouse
make

If this doesn't work or is not clear enough, see the Detailed Instructions below. If you have further issues, see Troubleshooting. If you'd prefer to use Docker, see the Docker Guide.

Detailed Instructions

Install Rust and Cargo with rustup.
- Use the stable toolchain (it's the default).
- Check the Troubleshooting section for additional dependencies (e.g., cmake).
Clone the Lighthouse repository.
- Run $ git clone https://github.com/sigp/lighthouse.git
- Change into the newly created directory with $ cd lighthouse
Build Lighthouse with $ make.
Installation was successful if $ lighthouse --help displays the command-line documentation.

First time compilation may take several minutes. If you experience any failures, please reach out on discord or create an issue.

Windows Support

Compiling or running Lighthouse natively on Windows is not currently supported. However, Lighthouse can run successfully under the Windows Subsystem for Linux (WSL). If using Ubuntu under WSL, you can should install the Ubuntu dependencies listed in the Dependencies (Ubuntu) section.

Troubleshooting

Dependencies

Ubuntu

Several dependencies may be required to compile Lighthouse. The following packages may be required in addition a base Ubuntu Server installation:

sudo apt install -y git gcc g++ make cmake pkg-config

macOS

You will need cmake. You can install via homebrew:

brew install cmake

Command is not found

Lighthouse will be installed to CARGO_HOME or $HOME/.cargo. This directory needs to be on your PATH before you can run $ lighthouse.

See "Configuring the PATH environment variable" (rust-lang.org) for more information.

Compilation error

Make sure you are running the latest version of Rust. If you have installed Rust using rustup, simply type $ rustup update.

2.5 KiB Raw Blame History