Skip to content

Commit

Permalink
docs(setup): add docs for "generic" Ubuntu binary (#117)
Browse files Browse the repository at this point in the history
  • Loading branch information
mlegner authored Sep 2, 2024
1 parent d968abf commit 4a29910
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/update-binaries.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
run: "mkdir -p site"
- name: Download latest binaries
run: |
for arch in ubuntu-x86_64 macos-x86_64 macos-arm64; do
for arch in ubuntu-x86_64 ubuntu-x86_64-generic macos-x86_64 macos-arm64; do
curl https://storage.googleapis.com/mysten-walrus-binaries/walrus-latest-$arch -o site/walrus-$arch
done
- name: Copy site-builder binary
Expand Down
15 changes: 10 additions & 5 deletions docs/usage/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,12 @@ when [running the CLI](./interacting.md).

We currently provide the `walrus` client binary for macOS (Intel and Apple CPUs) and Ubuntu:

| OS | CPU | Architecture |
|--------|---------------|------------------------------------------------------------------------------------------------------|
| MacOS | Apple Silicon | [`macos-arm64`](https://storage.googleapis.com/mysten-walrus-binaries/walrus-latest-macos-arm64) |
| MacOS | Intel 64bit | [`macos-x86_64`](https://storage.googleapis.com/mysten-walrus-binaries/walrus-latest-macos-x86_64) |
| Ubuntu | Intel 64bit | [`ubuntu-x86_64`](https://storage.googleapis.com/mysten-walrus-binaries/walrus-latest-ubuntu-x86_64) |
| OS | CPU | Architecture |
| ------ | --------------------- | -------------------------------------------------------------------------------------------------------------------- |
| MacOS | Apple Silicon | [`macos-arm64`](https://storage.googleapis.com/mysten-walrus-binaries/walrus-latest-macos-arm64) |
| MacOS | Intel 64bit | [`macos-x86_64`](https://storage.googleapis.com/mysten-walrus-binaries/walrus-latest-macos-x86_64) |
| Ubuntu | Intel 64bit | [`ubuntu-x86_64`](https://storage.googleapis.com/mysten-walrus-binaries/walrus-latest-ubuntu-x86_64) |
| Ubuntu | Intel 64bit (generic) | [`ubuntu-x86_64-generic`](https://storage.googleapis.com/mysten-walrus-binaries/walrus-latest-ubuntu-x86_64-generic) |

You can download the latest build from our Google Cloud Storage (GCS) bucket (correctly setting the
`$SYSTEM` variable)`:
Expand All @@ -90,6 +91,10 @@ curl https://storage.googleapis.com/mysten-walrus-binaries/walrus-latest-$SYSTEM
chmod +x walrus
```

On Ubuntu, you should generally use the `ubuntu-x86_64` version. However, this is incompatible with
old hardware and certain virtualized environments (throwing an "Illegal instruction (core dumped)"
error); in these cases you can use the `ubuntu-x86_64-generic` version.

To be able to run it simply as `walrus`, move the binary to any directory included in your `$PATH`
environment variable. Standard locations are `/usr/local/bin/`, `$HOME/bin/`, or
`$HOME/.local/bin/`.
Expand Down
7 changes: 7 additions & 0 deletions docs/usage/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ Before undertaking any other steps, make sure you have the [latest `walrus`
binary](./setup.md#installation). If you have multiple versions in different locations, find the
the binary that will actually be used with `which walrus`.

## Old hardware or incompatible VMs

Our standard Ubuntu binary is known to cause problems on certain old hardware and in certain
virtualized environments. If you experience errors like "Illegal instruction (core dumped)",
[install](./setup.md#installation) the `ubuntu-x86_64-generic` version instead, which is compiled
specifically to be compatible with almost all physical and virtual x86-64 CPUs.

## Latest Walrus configuration

The Walrus Devnet and Testnet are wiped periodically and require updating to the latest binary and
Expand Down

0 comments on commit 4a29910

Please sign in to comment.