Skip to content

docs: Ensured Ubuntu (Unix) Compatibility #429

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

Closed
0x-ximon wants to merge 3 commits into from
Closed

docs: Ensured Ubuntu (Unix) Compatibility #429

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f34a059
docs: Update README with installation notes for Debian/Ubuntu
0x-ximon Aug 21, 2025
ca1e693
Merge branch 'OpenZeppelin:main' into main
0x-ximon Aug 21, 2025
8d8b53f
chore: fixed coderabbits nitpicks
0x-ximon Sep 21, 2025
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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,10 @@ Run the following commands to install pre-commit hooks:
- Install stable libsodium version from [here](https://download.libsodium.org/libsodium/releases/).
- Follow steps to install libsodium from the [libsodium installation guide](https://doc.libsodium.org/installation).

> Note (Debian/Ubuntu): If you're compiling libsodium from source, install build-essential first.
```bash
sudo apt-get update && sudo apt-get install -y build-essential
```
### Install Node.js

- Install Node.js from [here](https://nodejs.org/).
Expand Down Expand Up @@ -324,6 +328,11 @@ cargo run --example create_key -- \
--force
```

> :warning: Debian/Ubuntu: If you encounter OpenSSL build errors, install the required packages:

```bash
sudo apt-get update && sudo apt-get install -y pkg-config libssl-dev
```
### Configure Webhook URL

`/config/config.json` file is partially pre-configured. You need to specify the webhook URL that will receive updates from the relayer service.
Expand Down