Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Thank you for your interest in contributing! We welcome contributions from the c

### Prerequisites
- **Docker**: Must be running for integration tests
- **Node.js**: v20.12.0+ and npm
- **Node.js**: v20.19.0+ and npm
- **Root/Sudo Access**: Required for testing iptables functionality
- **Git**: For version control

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ A network firewall for agentic workflows that restricts outbound HTTP/HTTPS to a
## Requirements

- **Docker**: 20.10+ with Docker Compose v2
- **Node.js**: 20.12.0+ (for building from source)
- **Node.js**: 20.19.0+ (for building from source)
- **OS**: Ubuntu 22.04+ or compatible Linux distribution

See [Compatibility](docs/compatibility.md) for full details on supported versions and tested configurations.
Expand Down
8 changes: 4 additions & 4 deletions docs/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ This document outlines the supported Node.js versions, operating systems, and ot
| Version | Status | Notes |
|---------|--------|-------|
| Node.js 22.x | ✅ Fully Supported | Active LTS (recommended) |
| Node.js 20.x | ✅ Fully Supported | Maintenance LTS (minimum: 20.12.0) |
| Node.js < 20.12 | ❌ Not Supported | Below minimum engine requirement |
| Node.js 20.x | ✅ Fully Supported | Maintenance LTS (minimum: 20.19.0) |
| Node.js < 20.19 | ❌ Not Supported | Below minimum engine requirement |

The minimum Node.js version is specified in `package.json` under `engines.node: ">=20.12.0"`.
The minimum Node.js version is specified in `package.json` under `engines.node: ">=20.19.0"`.

### Ubuntu / Linux

Expand Down Expand Up @@ -79,7 +79,7 @@ To check if your environment meets the requirements:

```bash
# Check Node.js version
node --version # Should be v20.12.0 or higher
node --version # Should be v20.19.0 or higher

# Check Docker version
docker --version # Should be 20.10 or higher
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Get started with the firewall in 5 minutes!
## Prerequisites

- **Docker**: 20.10+ with Docker Compose v2 installed and running
- **Node.js**: 20.12.0+ and npm (for building from source)
- **Node.js**: 20.19.0+ and npm (for building from source)
- **OS**: Ubuntu 22.04+ or compatible Linux distribution
- **GitHub Copilot CLI**: (optional, if testing with copilot)

Expand Down
8 changes: 4 additions & 4 deletions install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ check_platform() {
info "Detected platform: $os $arch (binary: $BINARY_NAME)"
}

# Check for Node.js >= 20.12.0 to decide between bundle and pkg binary
# Check for Node.js >= 20.19.0 to decide between bundle and pkg binary
# (matches engines.node requirement in package.json)
check_node() {
if [ "${AWF_FORCE_BINARY:-}" = "1" ]; then
Expand All @@ -155,12 +155,12 @@ check_node() {
NODE_VERSION=$(node -v | sed 's/^v//')
NODE_MAJOR=$(echo "$NODE_VERSION" | cut -d. -f1)
NODE_MINOR=$(echo "$NODE_VERSION" | cut -d. -f2)
if [ "$NODE_MAJOR" -gt 20 ] || { [ "$NODE_MAJOR" -eq 20 ] && [ "$NODE_MINOR" -ge 12 ]; }; then
info "Node.js v${NODE_VERSION} detected (>= 20.12.0), using lightweight bundle"
if [ "$NODE_MAJOR" -gt 20 ] || { [ "$NODE_MAJOR" -eq 20 ] && [ "$NODE_MINOR" -ge 19 ]; }; then
info "Node.js v${NODE_VERSION} detected (>= 20.19.0), using lightweight bundle"
USE_BUNDLE=true
return
fi
warn "Node.js v${NODE_VERSION} detected but < 20.12.0, using standalone binary"
warn "Node.js v${NODE_VERSION} detected but < 20.19.0, using standalone binary"
fi
USE_BUNDLE=false
}
Expand Down
Loading
Loading