Skip to content

docs: clarify specific-version upgrade guidance#562

Open
sojan-official wants to merge 3 commits into
mainfrom
chore/add-upgrade-instructions-to-cwctl-documentation
Open

docs: clarify specific-version upgrade guidance#562
sojan-official wants to merge 3 commits into
mainfrom
chore/add-upgrade-instructions-to-cwctl-documentation

Conversation

@sojan-official
Copy link
Copy Markdown
Member

@sojan-official sojan-official commented Feb 26, 2026

Summary

Clarifies specific-version upgrade guidance for Linux VM and Docker deployments.

Why

Older Chatwoot installations may need to upgrade through intermediate versions instead of jumping directly to the latest release. This helps migrations and configuration changes run in the expected order.

What this change does

  • Documents sudo cwctl --upgrade as the standard Linux VM upgrade command
  • Adds guidance for upgrading a Linux VM installation to a specific Chatwoot version with sudo cwctl -U v4.3.0
  • Mentions that -U also supports branch upgrades, such as sudo cwctl -U develop
  • Notes that release tags can print a Git pull warning because tags use detached HEAD
  • Recommends backups, a clean Chatwoot repository, release-note review, and staging validation before Linux VM upgrades
  • Adds Docker guidance to upgrade iteratively through intermediate image tags for very old installations
  • Fixes the Chatwoot CTL install link and Linux/AWS Marketplace wording on the upgrade page

Validation

  • Cross-checked against deployment/setup_20.04.sh in the Chatwoot codebase
  • Verified heredoc shell behavior for failed intermediate commands
  • Ran git diff --check

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 959093bb73

ℹ️ 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread self-hosted/deployment/chatwoot-ctl.mdx Outdated
@sojan-official
Copy link
Copy Markdown
Member Author

@codex can you improve this and address the comments

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex couldn't complete this request. Try again later.

@sojan-official sojan-official changed the title docs: add cwctl specific-version upgrade instructions and iterative upgrade note docs: clarify cwctl branch upgrade guidance May 27, 2026
@sojan-official sojan-official force-pushed the chore/add-upgrade-instructions-to-cwctl-documentation branch from af042e1 to 815e766 Compare May 27, 2026 11:13
@sojan-official sojan-official changed the title docs: clarify cwctl branch upgrade guidance docs: clarify cwctl Git-ref upgrade guidance May 27, 2026
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 815e766ce5

ℹ️ 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread self-hosted/deployment/chatwoot-ctl.mdx
@sojan-official sojan-official force-pushed the chore/add-upgrade-instructions-to-cwctl-documentation branch from 815e766 to 46009cb Compare May 27, 2026 11:20
@sojan-official sojan-official changed the title docs: clarify cwctl Git-ref upgrade guidance docs: clarify specific-version upgrade guidance May 27, 2026
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 46009cbe5d

ℹ️ 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread self-hosted/deployment/upgrade.mdx Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant