mirror of
https://github.com/ether/etherpad-lite.git
synced 2026-07-17 16:47:05 +00:00
* Roll Node.js floor back to >= 24 (Active LTS) Closes #7779. #7779 originally proposed bumping past the Node 25 stop-gap to Node 26. After re-checking the release schedule, the cleaner LTS target is actually Node 24: - Node 24 (Krypton) is currently in Active LTS, supported until ~May 2028. - Node 25 hit end-of-life on April 10 2026 — the floor merged in #7752 / #7749 / #7754 a day ago ships an already-EOL major. - Node 26 was released May 5 2026 and does not enter Active LTS until October 2026. So this PR reverts the Node 25 ratchet from those three PRs and lands on Node 24 — Etherpad's runtime floor stays on a supported LTS for the next ~2 years. Runtime / infra - `package.json` + `src/package.json`: `engines.node` `>=25.0.0` -> `>=24.0.0` - `bin/functions.sh`, `bin/installer.sh`, `bin/installer.ps1`: `REQUIRED_NODE_MAJOR` 25 -> 24 - `Dockerfile`: `node:25-alpine` -> `node:24-alpine` (both stages). Corepack-via-npm workaround is intentionally kept: it works on Node 24 (which still ships corepack) and on Node 25+ (which doesn't), so the same recipe survives the next LTS bump without churn. Comments reworded accordingly. - `snap/snapcraft.yaml`: pinned `NODE_VERSION` 25.9.0 -> 24.15.0; design notes + corepack comment adjusted - `packaging/nfpm.yaml`: `nodejs (>= 25)` -> `nodejs (>= 24)` in top-level depends + deb/rpm overrides - `packaging/bin/etherpad`: comment matches the new pin - `packaging/README.md`: build prereqs + apt install snippet point at `node_24.x`; the long-stale "engines.node floor is 20" line is fixed while we're here - `.github/workflows/*.yml`: setup-node `node-version` 25 -> 24 across every workflow; backend / frontend-admin / upgrade matrices `[25]` -> `[24]` - `.github/workflows/deb-package.yml`: `NODE_MAJOR=25` + `node_25.x` smoke-test installer -> 24 - `bin/plugins/lib/npmpublish.yml`: 25 -> 24 (template propagates to the ~80 ether/* plugins via update-plugins workflow) Docs - `README.md`: install one-liner + Requirements -> Node.js >= 24 - `doc/npm-trusted-publishing.md`: runner requirement -> Node 24 - `doc/plugins.md` / `doc/plugins.adoc`: plugin metadata example `engines.node` -> `">=24.0.0"` @types/node is left at ^25.8.0 — newer type definitions cover Node 24 runtime fine and avoid an unnecessary lockfile churn. Companion homepage one-liner change to follow on ether/ether.github.com. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(plugins): example engines.node = ">=22.0.0", not core's floor Plugin code is overwhelmingly ace-hook glue and rarely uses Node-version- specific APIs, so plugin engines.node should reflect the plugin's own requirements, not track core. Showing core's 24-floor in the example encouraged plugin authors to blindly copy a tighter pin than necessary and locked plugins out of being installable on older Etherpad/Node deployments. Use the most-recent Node LTS that has actually reached EOL (20 -> EOL April 2026) as the example floor, i.e. >=22. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
155 lines
6.2 KiB
PowerShell
155 lines
6.2 KiB
PowerShell
# Etherpad one-line installer for Windows (PowerShell).
|
|
#
|
|
# Usage:
|
|
# irm https://raw.githubusercontent.com/ether/etherpad-lite/master/bin/installer.ps1 | iex
|
|
#
|
|
# Optional environment variables:
|
|
# $env:ETHERPAD_DIR Directory to install into (default: .\etherpad-lite)
|
|
# $env:ETHERPAD_BRANCH Branch / tag to clone (default: master)
|
|
# $env:ETHERPAD_REPO Repo URL (default: https://github.com/ether/etherpad.git)
|
|
# $env:ETHERPAD_RUN If "1", start Etherpad after install
|
|
# $env:NO_COLOR If set, disables coloured output
|
|
|
|
#Requires -Version 5.1
|
|
|
|
$ErrorActionPreference = 'Stop'
|
|
|
|
# ---------- pretty output ----------
|
|
$useColor = -not $env:NO_COLOR
|
|
function Write-Step([string]$msg) {
|
|
if ($useColor) { Write-Host "==> $msg" -ForegroundColor Green }
|
|
else { Write-Host "==> $msg" }
|
|
}
|
|
function Write-Warn([string]$msg) {
|
|
if ($useColor) { Write-Host "==> $msg" -ForegroundColor Yellow }
|
|
else { Write-Host "==> $msg" }
|
|
}
|
|
function Write-Fatal([string]$msg) {
|
|
if ($useColor) { Write-Host "==> $msg" -ForegroundColor Red }
|
|
else { Write-Host "==> $msg" }
|
|
exit 1
|
|
}
|
|
|
|
function Test-Cmd([string]$name) {
|
|
return [bool](Get-Command $name -ErrorAction SilentlyContinue)
|
|
}
|
|
|
|
# ---------- defaults ----------
|
|
$EtherpadDir = if ($env:ETHERPAD_DIR) { $env:ETHERPAD_DIR } else { 'etherpad-lite' }
|
|
$EtherpadBranch = if ($env:ETHERPAD_BRANCH) { $env:ETHERPAD_BRANCH } else { 'master' }
|
|
$EtherpadRepo = if ($env:ETHERPAD_REPO) { $env:ETHERPAD_REPO } else { 'https://github.com/ether/etherpad.git' }
|
|
$RequiredNodeMajor = 24
|
|
|
|
Write-Step 'Etherpad installer'
|
|
|
|
# ---------- prerequisite checks ----------
|
|
if (-not (Test-Cmd git)) {
|
|
Write-Fatal 'git is required but not installed. See https://git-scm.com/download/win'
|
|
}
|
|
if (-not (Test-Cmd node)) {
|
|
Write-Fatal "Node.js is required (>= $RequiredNodeMajor). Install it from https://nodejs.org"
|
|
}
|
|
|
|
$nodeMajor = [int](node -p 'process.versions.node.split(".")[0]')
|
|
if ($nodeMajor -lt $RequiredNodeMajor) {
|
|
$nodeVer = (node --version)
|
|
Write-Fatal "Node.js >= $RequiredNodeMajor required. You have $nodeVer."
|
|
}
|
|
|
|
if (-not (Test-Cmd pnpm)) {
|
|
Write-Step 'Installing pnpm globally'
|
|
if (-not (Test-Cmd npm)) {
|
|
Write-Fatal "npm not found. Install Node.js >= $RequiredNodeMajor."
|
|
}
|
|
npm install -g pnpm
|
|
if ($LASTEXITCODE -ne 0) {
|
|
Write-Fatal 'Failed to install pnpm. Install it manually: https://pnpm.io/installation'
|
|
}
|
|
if (-not (Test-Cmd pnpm)) {
|
|
Write-Fatal 'pnpm install reported success but pnpm is still not on PATH. Open a new shell and re-run.'
|
|
}
|
|
}
|
|
|
|
# ---------- clone ----------
|
|
if (Test-Path $EtherpadDir) {
|
|
if (Test-Path (Join-Path $EtherpadDir '.git')) {
|
|
Write-Warn "$EtherpadDir already exists; updating to $EtherpadBranch."
|
|
Push-Location $EtherpadDir
|
|
try {
|
|
# Verify the existing checkout points at the expected remote.
|
|
$existingRemote = (git remote get-url origin 2>$null)
|
|
if ($existingRemote -and $existingRemote -ne $EtherpadRepo) {
|
|
Write-Fatal "$EtherpadDir is checked out from '$existingRemote', expected '$EtherpadRepo'. Refusing to overwrite."
|
|
}
|
|
|
|
# Refuse to clobber meaningful local changes. pnpm-lock.yaml is
|
|
# excluded because `pnpm i` rewrites it during installation,
|
|
# which would otherwise make every re-run of the installer fail.
|
|
$statusLines = (git status --porcelain) -split "`n" |
|
|
Where-Object { $_ -and ($_ -notmatch '\bpnpm-lock\.yaml$') }
|
|
if ($statusLines) {
|
|
$statusLines | ForEach-Object { Write-Host $_ }
|
|
Write-Fatal "$EtherpadDir has uncommitted changes. Commit/stash them or remove the directory."
|
|
}
|
|
|
|
git fetch --tags --prune origin
|
|
if ($LASTEXITCODE -ne 0) { Write-Fatal "git fetch failed in $EtherpadDir" }
|
|
|
|
# Discard any pnpm-lock.yaml changes from a prior pnpm install
|
|
# so the subsequent checkout doesn't refuse to overwrite.
|
|
git checkout -- pnpm-lock.yaml 2>$null
|
|
|
|
# Switch to the requested branch / tag and fast-forward to it.
|
|
git show-ref --verify --quiet "refs/remotes/origin/$EtherpadBranch"
|
|
$isBranch = ($LASTEXITCODE -eq 0)
|
|
git show-ref --verify --quiet "refs/tags/$EtherpadBranch"
|
|
$isTag = ($LASTEXITCODE -eq 0)
|
|
|
|
if ($isBranch) {
|
|
git checkout -B $EtherpadBranch "origin/$EtherpadBranch"
|
|
if ($LASTEXITCODE -ne 0) { Write-Fatal "git checkout $EtherpadBranch failed" }
|
|
} elseif ($isTag) {
|
|
git checkout --detach "refs/tags/$EtherpadBranch"
|
|
if ($LASTEXITCODE -ne 0) { Write-Fatal "git checkout tag $EtherpadBranch failed" }
|
|
} else {
|
|
Write-Fatal "Branch or tag '$EtherpadBranch' not found on origin."
|
|
}
|
|
|
|
$installedRev = (git rev-parse --short HEAD)
|
|
Write-Step "Updated $EtherpadDir to $EtherpadBranch @ $installedRev"
|
|
} finally {
|
|
Pop-Location
|
|
}
|
|
} else {
|
|
Write-Fatal "$EtherpadDir exists and is not a git checkout. Aborting."
|
|
}
|
|
} else {
|
|
Write-Step "Cloning Etherpad ($EtherpadBranch) into $EtherpadDir"
|
|
git clone --depth 1 --branch $EtherpadBranch $EtherpadRepo $EtherpadDir
|
|
if ($LASTEXITCODE -ne 0) { Write-Fatal 'git clone failed.' }
|
|
}
|
|
|
|
Push-Location $EtherpadDir
|
|
|
|
# ---------- install + build ----------
|
|
Write-Step 'Installing dependencies (pnpm i)'
|
|
pnpm i
|
|
if ($LASTEXITCODE -ne 0) { Pop-Location; Write-Fatal 'pnpm i failed.' }
|
|
|
|
Write-Step 'Building Etherpad (pnpm run build:etherpad)'
|
|
pnpm run build:etherpad
|
|
if ($LASTEXITCODE -ne 0) { Pop-Location; Write-Fatal 'pnpm run build:etherpad failed.' }
|
|
|
|
# ---------- done ----------
|
|
Write-Host ''
|
|
if ($useColor) { Write-Host "🎉 Etherpad is installed in $EtherpadDir" -ForegroundColor Green }
|
|
else { Write-Host "Etherpad is installed in $EtherpadDir" }
|
|
Write-Host 'To start Etherpad:'
|
|
Write-Host " cd $EtherpadDir; pnpm run prod"
|
|
Write-Host 'Then open http://localhost:9001 in your browser.'
|
|
Write-Host ''
|
|
|
|
if ($env:ETHERPAD_RUN -eq '1') {
|
|
Write-Step 'Starting Etherpad on http://localhost:9001'
|
|
pnpm run prod
|
|
}
|