gnosis/lighthouse
1
0
Fork 0
mirror of https://github.com/sigp/lighthouse.git synced 2026-05-08 01:05:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make portable the default in Lighthouse book and Makefile, update workflows (#6247)

Browse Source 
* Remove portable in book

* Add back modern in docker.md

* Update Makefile

* Update release.yml

* Update docker.yml

* Update book

* Minor revision

* delete portable tarballs

* delete portable in Make command

* Fix link in book

* mdlint

* Remove modernity in docker

* Merge branch 'unstable' into update-book-portable

* Merge branch 'unstable' into update-book-portable

* Remove `-dev` docker images

* Merge remote-tracking branch 'origin/unstable' into update-book-portable
This commit is contained in:
chonghe
2024-08-19 15:56:33 +08:00
committed by GitHub
parent 9bc5643319
commit b6d15bc299
7 changed files with 9 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
book/src/installation-binaries.md
View File

@@ -13,13 +13,6 @@ Binaries are supplied for four platforms:
- `x86_64-apple-darwin`: macOS with Intel chips
- `x86_64-windows`: Windows with 64-bit processors
Additionally there is also a `-portable` suffix which indicates if the `portable` feature is used:
- Without `portable`: uses modern CPU instructions to provide the fastest signature verification times (may cause `Illegal instruction` error on older CPUs)
- With `portable`: approx. 20% slower, but should work on all modern 64-bit processors.
For details, see [Portability](#portability).
## Usage
Each binary is contained in a `.tar.gz` archive. For this example, lets assume the user needs
@@ -41,30 +34,3 @@ a `x86_64` binary.
1. (Optional) Move the `lighthouse` binary to a location in your `PATH`, so the `lighthouse` command can be called from anywhere. For example, to copy `lighthouse` from the current directory to `usr/bin`, run `sudo cp lighthouse /usr/bin`.
> Windows users will need to execute the commands in Step 2 from PowerShell.
## Portability
Portable builds of Lighthouse are designed to run on the widest range of hardware possible, but
sacrifice the ability to make use of modern CPU instructions.
If you have a modern CPU then you should try running a non-portable build to get a 20-30% speed up.
- For **x86_64**, any CPU supporting the [ADX](https://en.wikipedia.org/wiki/Intel_ADX) instruction set
extension is compatible with the optimized build. This includes Intel Broadwell (2014)
and newer, and AMD Ryzen (2017) and newer.
- For **ARMv8**, most CPUs are compatible with the optimized build, including the Cortex-A72 used by
the Raspberry Pi 4.
## Troubleshooting
If you get a SIGILL (exit code 132), then your CPU is incompatible with the optimized build
of Lighthouse and you should switch to the `-portable` build. In this case, you will see a
warning like this on start-up:
```
WARN CPU seems incompatible with optimized Lighthouse build, advice: If you get a SIGILL, please try Lighthouse portable build
```
On some VPS providers, the virtualization can make it appear as if CPU features are not available,
even when they are. In this case you might see the warning above, but so long as the client
continues to function, it's nothing to worry about.