Skip to content

docs: update platform requirements and MUSL support - #286

Open
Aryex wants to merge 2 commits into
mainfrom
alexl/agent/node-napi-architecture
Open

Aryex wants to merge 2 commits into
mainfrom
alexl/agent/node-napi-architecture

Conversation

@Aryex

@Aryex Aryex commented Jul 26, 2026

Copy link
Copy Markdown
Collaborator

Summary

Update installation documentation to reflect MUSL/Alpine Linux support for Node.js, Java, and PHP.

⚠️ Attention: This PR was generated automatically. Verify that all relevant pages have been updated.

Source Commits

Changes

  • Updated minimum Node.js version from 16+ to 20+ (installation and quickstart pages)
  • Removed obsolete protobufjs dependency note (no longer used with NAPI-RS)
  • Updated glibc requirement from 2.17+ to 2.28+ for Node.js native binaries
  • Updated Alpine Linux/MUSL support status: now supported for Node.js, Java, and PHP
  • Added Alpine/MUSL build note to PHP tab (required packages: cmake, g++, perl, linux-headers)
  • Added NAPI-RS to the FFI layer description in the architecture docs
  • Fixed typo: Py03 → PyO3

Context

The Node.js client was rearchitected to replace Unix socket IPC + protobuf serialization with a direct NAPI-RS binding into the Rust core (valkey-glide #5325). This changes the minimum supported Node.js version to 20, removes the protobuf dependency, and adds MUSL/Alpine Linux support via prebuilt native binaries.

The PHP extension now supports Alpine Linux (musl libc 1.2.3+, Alpine 3.19+) on x86_64 and aarch64 via build system changes (Php #291).

cc @avifenesh @prateek-kumar-improving


This PR was generated by the automated documentation pipeline.

@Aryex Aryex added AI Generated documentation Improvements or additions to documentation nodejs labels Jul 26, 2026
@Aryex
Aryex force-pushed the alexl/agent/node-napi-architecture branch from f8fb3e2 to 21b40eb Compare July 26, 2026 21:27
@Aryex Aryex self-assigned this Jul 27, 2026
@Aryex
Aryex requested review from jeremyprime and xShinnRyuu July 27, 2026 14:42
@Aryex
Aryex marked this pull request as ready for review July 27, 2026 14:42
@Aryex
Aryex force-pushed the alexl/agent/node-napi-architecture branch from 21b40eb to b8f60a3 Compare July 27, 2026 14:42
@jeremyprime
jeremyprime requested review from affonsov and removed request for xShinnRyuu July 27, 2026 15:36
@Aryex Aryex assigned affonsov and unassigned Aryex Jul 27, 2026
<details>
<summary>`glibc` requirements</summary>
Node.js requires `glibc` 2.17+. This should be the standard for GNU Linux based systems.
The Node.js native binaries require glibc 2.28+. This is standard for most modern GNU/Linux distributions (Ubuntu 20.04+, Amazon Linux 2023, RHEL 8+).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think glibc was changed, still 2.17.


<TabItem label="Node">
**Requirements:** Node.js 16+
**Requirements:** Node.js 20+

@jeremyprime jeremyprime Jul 28, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also need to ensure other pages are updated with new minimum Node version, like doc-gen/typedoc/node-home.md (which also needs to remove protobuf dependency note).

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could also just simplify those docgen pages as well.

Signed-off-by: kiro-agent <kiro-agent@users.noreply.github.com>
Signed-off-by: kiro-agent <kiro-agent@users.noreply.github.com>
@Aryex
Aryex force-pushed the alexl/agent/node-napi-architecture branch from b8f60a3 to 917f984 Compare August 11, 2026 08:09
@Aryex Aryex changed the title docs: update Node.js requirements for NAPI-RS architecture docs: update platform requirements and MUSL support Aug 11, 2026
@Aryex Aryex added the php label Aug 11, 2026
@Aryex

Aryex commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator Author

📝 Updated PR description with 9fcb478 — Add MUSL support (Php #291)

Changes in this update:

  • Updated MUSL support caution note to include PHP alongside Node.js and Java
  • Added Alpine Linux build note to the PHP installation tab (required packages: cmake, g++, perl, linux-headers)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI Generated documentation Improvements or additions to documentation nodejs php

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants