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

docs/install: Add recommended installation step using the install.sh script #184

Merged
merged 2 commits into from
May 11, 2022
Merged

docs/install: Add recommended installation step using the install.sh script #184

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eec851b
docs/install: Add recommended installation step using the install.sh …
hjpotter92 Mar 11, 2022
75f5bf6
docs/install: Add coreutils to ubuntu required package and gnupg to m…
hjpotter92 Mar 14, 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
60 changes: 49 additions & 11 deletions docs/installation/install-livepeer/binary-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,37 @@ sidebar_position: 2

# Install using a Binary Release

Run the appropriate commands for your operating system; then, using the same directory, follow the steps to [configure Livepeer](/installation/configuring-livepeer).
Run the appropriate commands for your operating system; then, using
the same directory, follow the steps to [configure
Livepeer](/installation/configuring-livepeer).

### Darwin (macOS)
## Recommended

Use the `install.sh` script from the repository to get a completely
automated latest release installed onto your system. The script
requires presence of `curl`, `sha256sum` (for checksum verification)
and `gpg` (for signature validation). To install required dependencies
please use the following commands (for popular ubuntu/mac systems):

### Dependencies

```bash
# For ubuntu
# apt install curl coreutils gnupg2

# For macOS
# brew install curl coreutils gnupg
```

### Installation

```bash
sh -c "$(curl -fsSL https://raw.github.com/livepeer/go-livepeer/master/install.sh)"
```

Additional steps to install custom release for individual OS are declared below.

## Darwin (macOS)

```bash
# <RELEASE_VERSION> is the release version, e.g. v0.5.29
Expand All @@ -22,7 +50,7 @@ tar -zxvf livepeer-darwin-amd64.tar.gz
mv livepeer-darwin-amd64/* /usr/local/bin/
```

### Linux
## Linux

```bash
# <RELEASE_VERSION> is the release version, e.g. v0.5.29
Expand All @@ -31,33 +59,44 @@ mv livepeer-darwin-amd64/* /usr/local/bin/
wget https://github.com/livepeer/go-livepeer/releases/download/<RELEASE_VERSION>/livepeer-linux-amd64.tar.gz

# Next, extract it
tar -zxvf livepeer-linux-amd64.tar.gz
tar -zxvf livepeer-linux-amd64.tar.gz

# Finally, move it to the appropriate directory
mv livepeer-linux-amd64/* /usr/local/bin/
```

### Windows
## Windows

```shell
# <RELEASE_VERSION> is the release version, e.g. v0.5.29

# Fetch the latest release .zip
# Fetch the latest release .zip
wget https://github.com/livepeer/go-livepeer/releases/download/<RELEASE_VERSION>/livepeer-windows-amd64.zip

# Next, extract it
# Next, extract it
unzip livepeer-windows-amd64.zip

# Finally, move it to the appropriate directory, e.g. C:\Users\UserName\livepeer-folder
move livepeer-windows-amd64 e.g. C:\Users\UserName\livepeer-folder
```

> **Note** At this time Livepeer does not provide automatic updates. You can perform a manual update or use a script. **A community-created** [Bash script to update Livepeer is available on the livepeer Forum](https://forum.livepeer.org/t/bash-script-to-update-livepeer/1513).
> **Note** At this time Livepeer does not provide automatic
> updates. You can perform a manual update or use a script. **A
> community-created** [Bash script to update Livepeer is available on
> the livepeer
> Forum](https://forum.livepeer.org/t/bash-script-to-update-livepeer/1513).
## Third-party packages
Packages for different Linux distributions are maintained by Livepeer community members. Before using these packages, please verify that they have been updated to use the [latest builds of go-livepeer](https://github.com/livepeer/go-livepeer/releases). This list will be updated as a best-effort, but we cannot guarantee if individual packages are up to date or verify their integrity.

In the future, Livepeer core contributors may publish official packages for the distributions below.
Packages for different Linux distributions are maintained by Livepeer
community members. Before using these packages, please verify that
they have been updated to use the [latest builds of
go-livepeer](https://github.com/livepeer/go-livepeer/releases). This
list will be updated as a best-effort, but we cannot guarantee if
individual packages are up to date or verify their integrity.

In the future, Livepeer core contributors may publish official
packages for the distributions below.

### Arch Linux
**Source**
Expand All @@ -68,4 +107,3 @@ https://aur.archlinux.org/packages/go-livepeer-bin/
```
paru go-livepeer-bin
```