Skip to content

Commit 944aeac

Browse files
critesjoshaztec-bot
authored andcommitted
docs: add macOS prerequisites and improve Node.js version guidance (#22408)
## Summary - Adds macOS-specific prerequisites (Homebrew and modern Bash) to the developer getting-started guide and operator prerequisites page, including versioned copies. - Updates the shared Node.js version snippet to clarify that the installer will attempt to upgrade Node via nvm if available, and explains what to do if nvm is not installed. ## Test plan - [ ] Verify the docs site builds without errors (`yarn build` in `docs/`) - [ ] Check the macOS prerequisites section renders correctly on the getting started page - [ ] Check the macOS admonition renders correctly on the operator prerequisites page - [ ] Confirm the updated Node.js snippet reads clearly
1 parent f7d5106 commit 944aeac

5 files changed

Lines changed: 35 additions & 3 deletions

File tree

docs/developer_versioned_docs/version-v4.2.0-aztecnr-rc.2/getting_started_on_local_network.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ import { General, Fees } from '@site/src/components/Snippets/general_snippets';
2727

2828
- <General.node_ver />
2929

30+
### macOS-specific requirements
31+
32+
- **Homebrew**: [Homebrew](https://brew.sh/) is required for installing dependencies on macOS.
33+
- **Bash**: macOS ships with an outdated version of Bash (v3.2) that is known to cause issues with the Aztec installer. Install a modern version with `brew install bash`. Even if you use zsh as your default shell, the installer explicitly invokes `bash`. If the installer still picks up the old version, add the Homebrew `bash` to your `$PATH` or [set it as your default shell](https://support.apple.com/en-gb/guide/terminal/trml113/mac).
34+
3035
## Install and run the local network
3136

3237
### Install the Aztec toolchain

docs/docs-developers/getting_started_on_local_network.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,11 @@ import { General, Fees } from '@site/src/components/Snippets/general_snippets';
2727

2828
- <General.node_ver />
2929

30+
### macOS-specific requirements
31+
32+
- **Homebrew**: [Homebrew](https://brew.sh/) is required for installing dependencies on macOS.
33+
- **Bash**: macOS ships with an outdated version of Bash (v3.2) that is known to cause issues with the Aztec installer. Install a modern version with `brew install bash`. Even if you use zsh as your default shell, the installer explicitly invokes `bash`. If the installer still picks up the old version, add the Homebrew `bash` to your `$PATH` or [set it as your default shell](https://support.apple.com/en-gb/guide/terminal/trml113/mac).
34+
3035
## Install and run the local network
3136

3237
### Install the Aztec toolchain

docs/docs-operate/operators/prerequisites.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,16 @@ Install the Aztec toolchain using the official installer:
5959
VERSION=#release_version bash -i <(curl -sL https://install.aztec.network/#release_version)
6060
```
6161

62+
:::note macOS users
63+
macOS ships with an outdated version of Bash (v3.2) that is known to cause issues with the installer. Install a modern version with [Homebrew](https://brew.sh/):
64+
65+
```bash
66+
brew install bash
67+
```
68+
69+
Even if you use zsh as your default shell, the installer explicitly invokes `bash`. If the installer still picks up the old version, add the Homebrew `bash` to your `$PATH` or [set it as your default shell](https://support.apple.com/en-gb/guide/terminal/trml113/mac).
70+
:::
71+
6272
### L1 Ethereum Node Access
6373

6474
All Aztec nodes require access to Ethereum L1 node endpoints:

docs/network_versioned_docs/version-v2.1.11-ignition/operators/prerequisites.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,16 @@ Install the correct version for the current network:
6565
aztec-up 2.1.11
6666
```
6767

68+
:::note macOS users
69+
macOS ships with an outdated version of Bash (v3.2) that is known to cause issues with the installer. Install a modern version with [Homebrew](https://brew.sh/):
70+
71+
```bash
72+
brew install bash
73+
```
74+
75+
Even if you use zsh as your default shell, the installer explicitly invokes `bash`. If the installer still picks up the old version, add the Homebrew `bash` to your `$PATH` or [set it as your default shell](https://support.apple.com/en-gb/guide/terminal/trml113/mac).
76+
:::
77+
6878
### L1 Ethereum Node Access
6979

7080
All Aztec nodes require access to Ethereum L1 node endpoints:

docs/src/components/Snippets/general_snippets.js

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,11 @@ export const General = {
1919

2020
node_ver: () => (
2121
<p>
22-
Aztec libraries require Node.js version 24. You can use{" "}
23-
<a href="https://github.com/nvm-sh/nvm">nvm</a> to help manage node
24-
versions.
22+
Aztec libraries require Node.js version 24. If you have an older version
23+
installed, the installer will try to upgrade via{" "}
24+
<a href="https://github.com/nvm-sh/nvm">nvm</a> if available. If nvm is
25+
not installed, you will need to upgrade Node.js manually (e.g.{" "}
26+
<code>nvm install 24</code> after installing nvm).
2527
</p>
2628
),
2729

0 commit comments

Comments
 (0)