Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove NPM instructions and add disclaimer #4115

Merged
merged 2 commits into from
Jun 6, 2022
Merged

Remove NPM instructions and add disclaimer #4115

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8802df9
Remove NPM instructions and add disclaimer
philknows Jun 4, 2022
0215595
Update docs/installation.md
wemeetagain Jun 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 6 additions & 19 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,33 +43,20 @@ Lodestar should now be ready for use:
./lodestar --help
```

## Install from NPM
## Install from NPM [not recommended]

Install globally

```
npm install -g @chainsafe/lodestar-cli
```

or

```
yarn global add @chainsafe/lodestar-cli
```

Lodestar should now be ready to use:

```
lodestar --help
```
<!-- prettier-ignore-start -->
!!! danger
For mainnet (production) usage, we only recommend installing with docker due to NPM supply chain attacks, [example here](https://hackaday.com/2021/10/22/supply-chain-attack-npm-library-used-by-facebook-and-others-was-compromised/). [Until a safer installation method has been found](https://github.com/ChainSafe/lodestar/issues/3596), do not use this install method except for experimental purposes.
<!-- prettier-ignore-end -->

## Install with docker

The [`chainsafe/lodestar`](https://hub.docker.com/r/chainsafe/lodestar) Docker Hub repository is mantained actively. It contains the `lodestar` CLI preinstalled.

<!-- prettier-ignore-start -->
!!! info
The Docker Hub image in run on CI every dev release on `unstable`
The Docker Hub image is run on CI every dev release on `unstable`
<!-- prettier-ignore-end -->

Ensure you have Docker installed by issuing the command:
Expand Down