Skip to content

Commit 86f0556

Browse files
committed
UPGRADING: Re-level and reword headings.
1 parent e065ed6 commit 86f0556

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

UPGRADING.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Upgrading the Zulip container
1+
# Upgrading instructions for `docker-compose`
22

33
You can upgrade your Zulip installation to any newer version of Zulip with the
44
following instructions. At a high level, the strategy is to download a new
@@ -9,13 +9,10 @@ necessary database migrations with `manage.py migrate`.
99
If you ever find you need to downgrade your Zulip server, you'll need to use
1010
`manage.py migrate` to downgrade the database schema manually.
1111

12-
If you are using old `galexrt/docker-zulip` images (from Zulip 1.8.1 or older),
13-
you need to upgrade the postgres image from
14-
`quay.io/galexrt/postgres-zulip-tsearchextras:latest`. Refer to the
15-
[instructions for upgrading from the old
16-
galexrt/docker-zulip](#upgrading-from-the-old-galexrtdocker-zulip) section.
12+
All of the instructions below assume you are using the provided
13+
`docker-compose.yml`.
1714

18-
### Using `docker-compose`
15+
## Upgrading to a release
1916

2017
0. (Optional) Upgrading does not delete your data, but it's generally good
2118
practice to [back up your Zulip
@@ -75,7 +72,7 @@ You can confirm you're running the latest version by running:
7572
docker-compose exec -u zulip zulip cat /home/zulip/deployments/current/version.py
7673
```
7774

78-
### Upgrading from a Git repository
75+
## Upgrading from a Git repository
7976

8077
1. Edit `docker-compose.yml` to comment out the `image` line, and specify the
8178
Git commit you'd like to build the zulip container from. E.g.:
@@ -100,7 +97,7 @@ docker-compose exec -u zulip zulip cat /home/zulip/deployments/current/version.p
10097

10198
Then stop and restart the container as described in the previous section.
10299

103-
### Upgrading zulip/zulip-postgresql to 14
100+
## Upgrading zulip/zulip-postgresql to 14
104101

105102
The Docker Compose configuration for version 6.0-0 and higher default to using
106103
PostgreSQL 14, as the previously-used PostgreSQL 10 is no longer
@@ -114,7 +111,7 @@ The provided `upgrade-postgresql` tool will dump the contents of the
114111
necessary migration, update the `docker-compose.yml` file to match, and re-start
115112
Zulip.
116113

117-
### Upgrading from the old galexrt/docker-zulip
114+
## Upgrading from the old galexrt/docker-zulip
118115

119116
If you are using an earlier version of `galexrt/docker-zulip` which used the
120117
`quay.io/galexrt/postgres-zulip-tsearchextras:latest` PostgreSQL image, you need
@@ -126,7 +123,7 @@ path (`/opt/docker/zulip/postgresql/data`) in your `docker-compose.yml`. If you
126123
have changed it, please replace all occurences of
127124
`/opt/docker/zulip/postgresql/data` with your path.
128125

129-
1. Make a backup of your Zulip PostgreSQL data dir.
126+
1. Make a backup of your Zulip PostgreSQL data directory.
130127

131128
2. Stop all Zulip containers, except the postgres one (e.g. use `docker stop`
132129
and not `docker-compose stop`).
@@ -181,6 +178,3 @@ have changed it, please replace all occurences of
181178
```shell
182179
docker-compose up
183180
```
184-
185-
That should be it. Your PostgreSQL data has now been updated to use the
186-
`zulip/zulip-postgresql` image.

0 commit comments

Comments
 (0)