Skip to content

chore(docs): correct defaults and mislabelled externalRedis keys in README - #902

Merged
wrenix merged 5 commits into
nextcloud:mainfrom
sarankumar1325:docs/readme-defaults
Nov 12, 2026
Merged

wrenix merged 5 commits into
nextcloud:mainfrom
sarankumar1325:docs/readme-defaults

Conversation

@sarankumar1325

Copy link
Copy Markdown
Contributor

Description of the change

The parameters table in charts/nextcloud/README.md no longer matches values.yaml in a few places. This PR changes only the README table, plus the required chart version bump.

Wrong or mislabelled keys:

  • The two rows under externalRedis.existingSecret.enabled were named externalDatabase.existingSecret.secretName / externalDatabase.existingSecret.passwordKey, but they describe the Redis secret. _helpers.tpl reads .Values.externalRedis.existingSecret.secretName / .passwordKey, so I renamed them to externalRedis.existingSecret.*.
  • nginx.containerPort showed IfNotPresent as its default. The real default is 80. The nginx.image.pullPolicy row above it was duplicated, so I removed the copy.

Stale defaults (the README now shows what values.yaml sets):

  • image.repository: library/nextcloud. nginx.image.repository: library/nginx.
  • nextcloud.existingSecret.{usernameKey,passwordKey,smtpUsernameKey,smtpPasswordKey,smtpHostKey}: nextcloud-username, nextcloud-password, smtp-username, smtp-password, smtp-host (the README said nil).
  • externalDatabase.existingSecret.{usernameKey,passwordKey}: db-username, db-password (the README said nil).
  • nextcloud.mail.*: fromAddress user, domain domain.com, smtp.host domain.com, smtp.secure ssl, smtp.port 465, smtp.name user, smtp.password pass.
  • redis.auth.password: changeme.
  • mariadb.image.repository / postgresql.image.repository: bitnamilegacy/mariadb / bitnamilegacy/postgresql.
  • imaginary.securityContext: {runAsUser: 1000, runAsNonRoot: true}.
  • collabora.collabora.extra_params: "--o:ssl.enable=false". The README had ssl.enabled, which is not a Collabora option.

Benefits

Users who copy keys from the README now set the values the chart actually reads. This matters most for the external Redis secret, whose documented keys were silently ignored.

Possible drawbacks

None. This is a docs-only change.

Applicable issues

None filed.

Additional information

I found these by comparing every row of the README table against values.yaml and checking the template references. helm lint charts/nextcloud passes. I used an AI coding assistant to prepare this PR and checked every changed row against values.yaml and the templates.

Checklist

The parameters table had drifted from values.yaml:

- externalRedis.existingSecret.secretName/passwordKey were listed as
  externalDatabase.existingSecret.*, so the Redis secret keys were
  undocumented and the database ones appeared twice
- nginx.containerPort showed IfNotPresent instead of 80, and the
  nginx.image.pullPolicy row was duplicated
- existingSecret key names, mail/smtp settings, image repositories
  (library/*, bitnamilegacy/*), redis.auth.password,
  imaginary.securityContext and the collabora extra_params
  (--o:ssl.enable) defaults now match values.yaml

Bump chart version to 9.4.2.

Signed-off-by: sarankumar1325 <120080287+sarankumar1325@users.noreply.github.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 31, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ⚠️ Failed 2026-10-31T00:25:13.747547Z
We couldn’t complete this review. Comment @codex review to try again.
a723955 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@wrenix
wrenix enabled auto-merge (squash) November 7, 2026 07:03
@wrenix wrenix changed the title docs(nextcloud): fix README defaults and mislabelled externalRedis keys chore(docs): correct defaults and mislabelled externalRedis keys in README Nov 12, 2026
@wrenix

wrenix commented Nov 12, 2026

Copy link
Copy Markdown
Collaborator

please rebase and bump version

Signed-off-by: WrenIX <133280015+wrenix@users.noreply.github.com>
Signed-off-by: WrenIX <133280015+wrenix@users.noreply.github.com>
@wrenix
wrenix disabled auto-merge November 12, 2026 21:45
@wrenix
wrenix enabled auto-merge (squash) November 12, 2026 21:46
@wrenix
wrenix merged commit c3d32d3 into nextcloud:main Nov 12, 2026
12 checks passed
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.

2 participants