Skip to content

feat(etherpad): bump to 2.6.1 and switch to official image#47234

Closed
JohnMcLear wants to merge 1 commit intotrueforge-org:masterfrom
JohnMcLear:feat/etherpad-bump-2.6.1
Closed

feat(etherpad): bump to 2.6.1 and switch to official image#47234
JohnMcLear wants to merge 1 commit intotrueforge-org:masterfrom
JohnMcLear:feat/etherpad-bump-2.6.1

Conversation

@JohnMcLear
Copy link
Copy Markdown

@JohnMcLear JohnMcLear commented Apr 19, 2026

Description

Bumps stable/etherpad from 1.8.14 to 2.6.1 and migrates the image source from the stale community fork ghcr.io/nicholaswilde/etherpad (last published 2023, pinned at version-1.8.14) to the official Etherpad Foundation image.

Chart version: 20.1.021.0.0 (major — upstream 1.x → 2.x, plus one breaking persistence change).

⚒️ Fixes #

⚙️ Type of change

  • ⚙️ Feature/App addition
  • 🪛 Bugfix
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 🔃 Refactor of current code
  • 📜 Documentation Changes

🧪 How Has This Been Tested?

  • helm lint charts/stable/etherpad — passes
  • helm template charts/stable/etherpad — renders cleanly
  • Pre-commit on changed files — passes
  • Verified env-var names (DB_TYPE, DB_NAME, DB_USER, DB_PORT, DB_PASS, DB_HOST, TITLE, FAVICON, DEFAULT_PAD_TEXT, ADMIN_PASSWORD, USER_PASSWORD) against upstream settings.json.docker on ether/etherpad — unchanged between 1.8.x and 2.6.x.
  • Verified persistence.data mount path /opt/etherpad-lite/var exists in the 2.x image (EP_DIR=/opt/etherpad-lite, Dockerfile stages var/, src/, bin/, settings.json).

📃 Notes:

Re: registry preference raised in review — upstream has just landed ether/etherpad#7569, which publishes identical SemVer-tagged images to ghcr.io/ether/etherpad alongside Docker Hub. 2.6.1 is being mirrored to GHCR now; this PR will be updated in a follow-up commit to point image.repository at ghcr.io/ether/etherpad and update Chart.yaml sources accordingly, so downstream users avoid Docker Hub anonymous pull rate limits. The SemVer tag pattern is unchanged, so Renovate will track minor/patch bumps automatically from either registry.

Breaking changes for operators upgrading 1.x → 2.x:

  • persistence.app removed — path /opt/etherpad-lite/app does not exist in 2.x. persistence.data at /opt/etherpad-lite/var is retained and covers state that must survive a pod restart.
  • Users with custom runtime-installed plugins (previously written into the app PVC) should re-declare them via the ETHERPAD_PLUGINS env.
  • settings.json gained keys between 1.8.x and 2.6.x (OIDC, new rate-limit knobs, trustProxy changes) — re-diff if mounting a custom settings file.
  • Back up the Postgres DB before upgrading; Etherpad migrates schema on first boot.

✔️ Checklist:

  • ⚖️ My code follows the style guidelines of this project
  • 👀 I have performed a self-review of my own code
  • #️⃣ I have commented my code, particularly in hard-to-understand areas
  • 📄 I have made changes to the documentation — README/CHANGELOG intentionally skipped per .github/copilot-instructions.md (auto-generated by repo tooling)
  • 🧪 I have added tests to this description that prove my fix is effective or that my feature works
  • ⬆️ I increased versions for any altered app according to semantic versioning
  • I made sure the title starts with feat(chart-name):, fix(chart-name):, chore(chart-name):, docs(chart-name): or fix(docs):

➕ App addition

Not applicable — this PR updates an existing chart.

Bumps the stable/etherpad chart from the long-stale 1.8.14 to upstream
2.6.1, and migrates the image source from the unmaintained community fork
ghcr.io/nicholaswilde/etherpad (last tag 2023) to the official
docker.io/etherpad/etherpad image published by the Etherpad Foundation.

Chart version 20.1.0 -> 21.0.0 (major: upstream 1.x -> 2.x and one
breaking persistence change).

Chart.yaml
- appVersion: 1.8.14 -> "2.6.1"
- version:    20.1.0 -> 21.0.0
- sources:    drop ghcr.io/nicholaswilde/etherpad; add hub.docker.com/r/etherpad/etherpad

values.yaml
- image.repository: ghcr.io/nicholaswilde/etherpad -> docker.io/etherpad/etherpad
- image.tag: 2.6.1@sha256:69a697fe6bf75aecf8748d734bcca5f0e596a6eeec8342ab030d0da8a6f224d5
  (multi-arch index digest verified via registry-1.docker.io v2 API)
- Removed persistence.app (path /opt/etherpad-lite/app does not exist in
  the 2.x image). persistence.data at /opt/etherpad-lite/var is retained.

Env-var names unchanged between 1.8.x and 2.6.x. README.md and
CHANGELOG.md left for your auto-generator per .github/copilot-instructions.md.

Refs ether/etherpad#7529

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Apr 19, 2026

CLA assistant check
All committers have signed the CLA.

@alfi0812
Copy link
Copy Markdown
Member

alfi0812 commented Apr 19, 2026

@JohnMcLear please stick to our PR template and fill it out accordingly and need to sign ci. Otherwise our changelog will have issues

@alfi0812
Copy link
Copy Markdown
Member

Also when possible we prefer ghcr.io as docker causes many issues with rate limiting

@alfi0812
Copy link
Copy Markdown
Member

Also per your link: ether/etherpad#7529

We make helm-charts. We are not affiliated by trunas or their OS and our charts can be run on any system running kubernetes.

@alfi0812
Copy link
Copy Markdown
Member

As long as your tags follow SemVer renovate should pick it up so need to ki pr spam

Copy link
Copy Markdown
Member

@alfi0812 alfi0812 left a comment

Choose a reason for hiding this comment

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

Read comments

@Crow-Control Crow-Control marked this pull request as draft April 19, 2026 18:50
@Crow-Control
Copy link
Copy Markdown
Member

He has 24 hours to apologise, then we will take action for mass AI spamming.

@JohnMcLear
Copy link
Copy Markdown
Author

JohnMcLear commented Apr 20, 2026

Apologies for the noise, the feedback is useful :) I'll look into this briefly now to see what went so wrong and document it :)

  1. TrueCharts ≠ TrueNAS SCALE. The original survey miscategorised TrueCharts as a TrueNAS-only catalog; it's a general Helm chart repo. Apologies to the TrueCharts maintainers for that framing.
  2. Contribution guidelines. At least two of the downstream(from Etherpad) PRs I opened did not start by reading the target project's PR template / CONTRIBUTING. Rectified :)

@JohnMcLear
Copy link
Copy Markdown
Author

JohnMcLear commented Apr 20, 2026

CLA signed. Making required changes to paths now :) Edit: Looks like you guys want ghcr.io deployment so I'm looking at sorting that first :) Bare with...

@alfi0812
Copy link
Copy Markdown
Member

Closed as ki spam

@alfi0812 alfi0812 closed this Apr 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants