ewilliams28/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-08-12 21:53:00 -06:00
Code Issues Packages Projects Releases Wiki Activity

[AI-assisted] docs: recommend Node 26 in quickstart, landing, and platform install docs (#115064)

Browse Source 
* docs: recommend Node 26 in quickstart, landing, and platform install docs

- Problem: the user-facing quickstart (docs/start/getting-started.md), landing
  page (docs/index.md), and Linux/macOS platform install docs still mark
  Node 24 as the recommended default, contradicting maintainer PR #114399
  ('recommend Node 26 as the OpenClaw runtime') and the installer default
  (scripts/install.sh NODE_DEFAULT_MAJOR=26, openclaw.mjs
  RECOMMENDED_NODE_MAJOR=26). Users following the quickstart pick a slower,
  heavier runtime against the project's stated recommendation.
- Fix: align the 4 missed user-facing install surfaces to 'Node 26
  recommended', matching the phrasing already in docs/install/node.md,
  docs/install/index.md, docs/install/ansible.md, docs/install/bun.md, and
  docs/help/faq-first-run.md. Leave docs/start/setup.md (the source/dev
  workflow where CI pins Node 24) unchanged on purpose.
- Verification: docs-only diff reviewed; supported-version floors
  (22.22.3+/24.15+/25.9+) unchanged; consistent across all install surfaces.

* docs: complete Node 26 installation guidance

Co-authored-by: Santhi Prakash <b.santhiprakash@gmail.com>

---------

Co-authored-by: Peter Steinberger <steipete@gmail.com>
This commit is contained in:
Santhi Prakash
2026-07-28 22:07:06 +05:30
committed by GitHub
parent a88c4283ad
commit f84ee793da
7 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/index.md
+1 -1
View File
@@ -99,7 +99,7 @@ OpenClaw is a **self-hosted gateway** that connects your favorite chat apps —
- **Agent-native**: built for coding agents with tool use, sessions, memory, and multi-agent routing
- **Open source**: MIT licensed, community-driven
**What do you need?** Node 24.15+ (recommended), Node 22 LTS (`22.22.3+`) for compatibility, or Node 25.9+, an API key from your chosen provider, and 5 minutes. For best quality and security, use the strongest latest-generation model available.
**What do you need?** Node 26 (recommended), or another supported release: Node 22.22.3+, Node 24.15+, or Node 25.9+. You also need an API key from your chosen provider and 5 minutes. For best quality and security, use the strongest latest-generation model available.
## How it works
docs/install/digitalocean.md
+2 -2
View File
@@ -44,8 +44,8 @@ DigitalOcean is a straightforward paid VPS path. For cheaper or free options:
apt update && apt upgrade -y
# Install Node.js 24
curl -fsSL https://deb.nodesource.com/setup_24.x | bash -
# Install Node.js 26
curl -fsSL https://deb.nodesource.com/setup_26.x | bash -
apt install -y nodejs
# Install OpenClaw
docs/install/installer.md
+3 -3
View File
@@ -72,9 +72,9 @@ Recommended for most interactive installs on macOS/Linux/WSL.
<Step title="Detect OS">
Supports macOS and Linux (including WSL).
</Step>
<Step title="Ensure Node.js 24 by default">
<Step title="Ensure Node.js 26 by default">
Checks Node version and installs Node 26 if needed (Homebrew `node` on macOS, NodeSource setup scripts on Linux apt/dnf/yum). On macOS, Homebrew is installed only when the installer needs it for Node or Git. Node 22.22.3+, Node 24.15+, and Node 25.9+ are supported; Node 23 is unsupported.
On Alpine/musl Linux, the installer uses apk packages instead of NodeSource and verifies the actual linked SQLite version. Current stable Alpine package streams can provide a new-enough Node with vulnerable system SQLite; when that happens, use an official `node:24-alpine` container or a glibc-based host instead.
On Alpine/musl Linux, the installer uses apk packages instead of NodeSource and verifies the actual linked SQLite version. Current stable Alpine package streams can provide a new-enough Node with vulnerable system SQLite; when that happens, use an official `node:26-alpine` container or a glibc-based host instead.
</Step>
<Step title="Ensure Git">
Installs Git if missing using the detected package manager, including Homebrew on macOS and apk on Alpine.
@@ -299,7 +299,7 @@ by default, plus git-checkout installs under the same prefix flow.
<Step title="Ensure PowerShell + Windows environment">
Requires PowerShell 5+.
</Step>
<Step title="Ensure Node.js 24 by default">
<Step title="Ensure a supported Node.js runtime">
If missing, attempts install via winget, then Chocolatey, then Scoop. If no package manager is available, the script downloads the official Node.js 26 Windows zip into `%LOCALAPPDATA%\OpenClaw\deps\portable-node` and adds it to the current process and user PATH. Node 22.22.3+, Node 24.15+, and Node 25.9+ are supported; Node 23 is unsupported.
</Step>
<Step title="Install OpenClaw">
docs/install/raspberry-pi.md
+2 -2
View File
@@ -66,9 +66,9 @@ Run a persistent, always-on OpenClaw Gateway on a Raspberry Pi. Since the Pi is
</Step>
<Step title="Install Node.js 24">
<Step title="Install Node.js 26">
```bash
curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash -
curl -fsSL https://deb.nodesource.com/setup_26.x | sudo -E bash -
sudo apt install -y nodejs
node --version
```
docs/platforms/linux.md
+1 -1
View File
@@ -99,7 +99,7 @@ Linux v1 uses one Canvas window. HTTP and HTTPS pages are renderable, but A2UI a
The CLI remains the simplest option for a headless server, a VPS, or a remote Gateway:
1. Install Node 24.15+ (recommended), Node 22.22.3+ (LTS), or Node 25.9+.
1. Install Node 26 (recommended), or another supported release: Node 22.22.3+, Node 24.15+, or Node 25.9+.
2. `npm i -g openclaw@latest`
3. `openclaw onboard --install-daemon`
4. From your laptop: `ssh -N -L 18789:127.0.0.1:18789 <user>@<host>`
docs/platforms/mac/bundled-gateway.md
+2 -2
View File
@@ -26,8 +26,8 @@ OpenClaw package.
## Manual recovery
Node 24.15+ is recommended for a manual install; Node 22.22.3+ also works. Install
`openclaw` globally:
For a manual install, use Node 26 (recommended) or another supported release:
Node 22.22.3+, Node 24.15+, or Node 25.9+. Install `openclaw` globally:
```bash
npm install -g openclaw@<version>
docs/start/getting-started.md
+1 -1
View File
@@ -12,7 +12,7 @@ working chat session.
## What you need
- **Node.js 22.22.3+, 24.15+, or 25.9+** (24 is the recommended default)
- **Node.js 22.22.3+, 24.15+, or 25.9+** (Node 26 is the recommended runtime)
- **An API key** from a model provider (Anthropic, OpenAI, Google, etc.) — onboarding will prompt you
<Tip>