From 959093bb734db777d790dfb2ecf89d5b3a4a2c05 Mon Sep 17 00:00:00 2001 From: Sojan Jose Date: Thu, 26 Feb 2026 00:57:28 -0800 Subject: [PATCH] docs: add cwctl specific-version upgrade guidance --- self-hosted/deployment/chatwoot-ctl.mdx | 14 +++++++++++++- self-hosted/deployment/upgrade.mdx | 4 ++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/self-hosted/deployment/chatwoot-ctl.mdx b/self-hosted/deployment/chatwoot-ctl.mdx index 09ad343a..82b0f91a 100644 --- a/self-hosted/deployment/chatwoot-ctl.mdx +++ b/self-hosted/deployment/chatwoot-ctl.mdx @@ -53,6 +53,18 @@ sudo cwctl --upgrade This will upgrade your Chatwoot instance to the latest stable release. If you are running a custom branch in production do not use this to upgrade. +To upgrade to a specific Chatwoot version, use `-U`/`--Upgrade` with a git ref. + +```bash +sudo cwctl -U +# example +sudo cwctl -U v4.3.0 +``` + + +`-u`/`--upgrade` upgrades to latest stable (`master`), while `-U`/`--Upgrade` upgrades to a specific git ref and is currently experimental. Upgrades can fail when your Chatwoot repo has local code changes, so keep production changes clean and take backups before upgrading. Under the hood, `-U` performs a `git checkout ` followed by `git pull`. + + ### Setup Nginx with SSL after installation To set up Nginx with SSL after initial setup(if you answered `no` to webserver/SSL setup during the first install) @@ -97,4 +109,4 @@ To check the version of Chatwoot CTL, ```bash sudo cwctl --version -``` \ No newline at end of file +``` diff --git a/self-hosted/deployment/upgrade.mdx b/self-hosted/deployment/upgrade.mdx index 35c9c6e2..130079a4 100644 --- a/self-hosted/deployment/upgrade.mdx +++ b/self-hosted/deployment/upgrade.mdx @@ -20,6 +20,10 @@ If you are on an older version of Chatwoot(< 2.7), follow the [manual upgrade st cwctl --upgrade ``` + +To reduce risk of breakages, upgrade iteratively across versions instead of skipping many releases in one jump (for example, avoid upgrading directly from `v4.1` to `v4.10`). + + This upgrade method is applicable for all manual linux installations including installation using aws marketplace. ## Docker