Update for modern docker-compose.

Author: alexmv

README.md

@@ -95,7 +95,7 @@ sample configuration to run that Zulip server with each of the major
 [volumes]: https://docs.docker.com/storage/volumes/
 [persistent-data]: https://zulip.readthedocs.io/en/latest/production/export-and-import.html#backups
 
-## Running a Zulip server with docker-compose
+## Running a Zulip server with `docker compose`
 
 To use this project, we recommend starting by cloning the repository (since
 you'll want to edit the `docker-compose.yml` file in this project):
@@ -112,7 +112,7 @@ generate secrets and do some configuration.
 
 ### Configuration
 
-With `docker-compose`, it is traditional to configure a service by
+With `docker compose`, it is traditional to configure a service by
 setting environment variables declared in the `zulip -> environment`
 section of the `docker-compose.yml` file; this image follows that
 convention.
@@ -251,12 +251,12 @@ can provide a `settings.py` file and a `zulip-secrets.conf` file in
 You can boot your Zulip installation with:
 
 ```
-docker-compose pull
-docker-compose up
+docker compose pull
+docker compose up
 ```
 
 This will boot the 5 containers declared in `docker-compose.yml`. The
-`docker-compose` command will print a bunch of output, and then
+`docker compose` command will print a bunch of output, and then
 eventually hang once everything is happily booted, usually ending with
 a bunch of lines like this:
 
@@ -267,15 +267,15 @@ rabbitmq_1   | accepting AMQP connection <0.534.0> (172.18.0.3:49504
 ```
 
 You can inspect what containers are running in another shell with
-`docker-compose ps` (remember to `cd` into the `docker-zulip`
+`docker compose ps` (remember to `cd` into the `docker-zulip`
 directory first).
 
 If you hit `Ctrl-C`, that will stop your Zulip server cluster. If
 you'd prefer to have the containers run in the background, you can use
-`docker-compose up -d`.
+`docker compose up -d`.
 
 If you want to build the Zulip image yourself, you can do that by
-running `docker-compose build`; see also
+running `docker compose build`; see also
 [the documentation on building a custom Git version version](UPGRADING.md#upgrading-from-a-git-repository).
 
 ### Connecting to your Zulip server
@@ -296,8 +296,8 @@ You can now follow the normal Zulip installer instructions for how to
 new Zulip server. You'll generate the realm creation link as follows:
 
 ```bash
-docker-compose exec -u zulip zulip \
-    "/home/zulip/deployments/current/manage.py generate_realm_creation_link"
+docker compose exec -u zulip zulip \
+    /home/zulip/deployments/current/manage.py generate_realm_creation_link
 ```
 
 But don't forget to review the [getting started][next-steps] links at
@@ -313,10 +313,10 @@ The following are helpful examples:
 
 ```bash
 # Get a (root) shell in the container so you can access logs
-docker-compose exec zulip bash
+docker compose exec zulip bash
 # Run a Zulip management command
-docker-compose exec -u zulip zulip \
-    "/home/zulip/deployments/current/manage.py list_realms"
+docker compose exec -u zulip zulip \
+    /home/zulip/deployments/current/manage.py list_realms
 ```
 
 Since that process for running management commands is a pain, we recommend
@@ -353,7 +353,7 @@ instructions.
 A Kubernetes pod file is in the `kubernetes/` folder; you can run it
 with `kubectl create -f ./kubernetes/`.
 
-You should read the `docker-compose` section above to understand how
+You should read the `docker compose` section above to understand how
 this works, since it's a very similar setup. You'll want to clone
 this repository, edit the `zulip-rc.yml` to configure the image, etc.
 
@@ -405,7 +405,7 @@ in the Docker environment (`docker-compose.yml`).
 Common issues include:
 
 - Invalid configuration resulting in the `zulip` container not
-  starting; check `docker-compose ps` to see if it started, and then
+  starting; check `docker compose ps` to see if it started, and then
   read the logs for the Zulip container to see why it failed.
 - A new Zulip setting not being passed through the Docker
   [entrypoint.sh script](/entrypoint.sh) properly. If you

UPGRADING.md

@@ -1,4 +1,4 @@
-# Upgrading instructions for `docker-compose`
+# Upgrading instructions for `docker compose`
 
 You can upgrade your Zulip installation to any newer version of Zulip with the
 following instructions. At a high level, the strategy is to download a new
@@ -58,18 +58,18 @@ All of the instructions below assume you are using the provided
 
    ```shell
    # Stops the old zulip container; this begins your downtime
-   docker-compose stop
+   docker compose stop
    # Boots the new zulip container; this ends your downtime
-   docker-compose up
+   docker compose up
    # Deletes the old container images
-   docker-compose rm
+   docker compose rm
    ```
 
 That's it! Zulip is now running the updated version.
 You can confirm you're running the latest version by running:
 
 ```shell
-docker-compose exec -u zulip zulip cat /home/zulip/deployments/current/version.py
+docker compose exec -u zulip zulip cat /home/zulip/deployments/current/version.py
 ```
 
 ## Upgrading from a Git repository
@@ -92,7 +92,7 @@ docker-compose exec -u zulip zulip cat /home/zulip/deployments/current/version.p
    and `ZULIP_GIT_REF` to be any ref name in that repository (e.g. `main` or
    `1.9.0` or `445932cc8613c77ced023125248c8b966b3b7528`).
 
-2. Run `docker-compose build zulip` to build a Zulip Docker image from the
+2. Run `docker compose build zulip` to build a Zulip Docker image from the
    specified Git version.
 
 Then stop and restart the container as described in the previous section.
@@ -110,7 +110,7 @@ If you elect to switch to managed Docker volumes, you can copy the data out of
 
 ```shell
 # Stop the containers
-docker-compose stop
+docker compose stop
 
 # Copy the data into new managed volumes:
 zulip_volume_sync() { docker run -it --rm -v "/opt/docker/zulip/$1:/src" -v "$(basename "$(pwd)")_${2:$1}":/dst ubuntu:20.04 sh -c 'cd /src; cp -a . /dst' ; }
@@ -124,13 +124,13 @@ zulip_volume_sync redis
 $EDITOR docker-compose.yml
 
 # Start the containers again
-docker-compose start
+docker compose start
 ```
 
 ## Upgrading zulip/zulip-postgresql to 14 (version 6.0-0 and above)
 
 As of Docker Zulip 6.0-0, we have upgraded the version of PostgreSQL which our
-docker-compose configuration uses, from PostgreSQL 10 (which is no longer
+`docker compose.yml` configuration uses, from PostgreSQL 10 (which is no longer
 supported) to PostgreSQL 14. Because the on-disk storage is not compatible
 between PostgreSQL versions, this requires more than simply switching which
 PostgreSQL docker image is used — the data must be dumped from PostgreSQL 10,
@@ -149,9 +149,9 @@ You can perform this step either before or after updating to use Docker volumes
 (above). In either case, the updated `docker-compose.yml` will use a new Docker
 volume for the upgraded PostgreSQL 14 data.
 
-The `upgrade-postgresql` tool requires `docker-compose` 2.1.1 or higher.
+The `upgrade-postgresql` tool requires `docker compose` 2.1.1 or higher.
 
-If the tool does not work, you have too old a `docker-compose`, or you would
+If the tool does not work, you have too old a `docker compose`, or you would
 prefer to perform the steps manually, see the steps below. These instructions
 assume that you have not changed the default Postgres data path
 (`/opt/docker/zulip/postgresql/data`) in your `docker-compose.yml`. If you have
@@ -163,7 +163,7 @@ changed it, please replace all occurrences of
 2. Stop the Zulip container:
 
    ```shell
-   docker-compose stop zulip
+   docker compose stop zulip
    ```
 
 3. Create a new (upgraded) Postgres container using a different data directory:
@@ -183,7 +183,7 @@ changed it, please replace all occurrences of
    upgrade):
 
    ```shell
-   docker-compose exec database pg_dumpall -U zulip | \
+   docker compose exec database pg_dumpall -U zulip | \
        docker exec -i postgresnew psql -U zulip
 
    echo "ALTER USER zulip WITH PASSWORD 'REPLACE_WITH_SECURE_POSTGRES_PASSWORD';" |
@@ -193,7 +193,7 @@ changed it, please replace all occurrences of
 5. Stop and remove both Postgres containers:
 
    ```shell
-   docker-compose rm --stop database
+   docker compose rm --stop database
    docker stop postgresnew
    docker rm postgresnew
    ```
@@ -207,7 +207,7 @@ changed it, please replace all occurrences of
 
 8. Start Zulip up again:
    ```shell
-   docker-compose up
+   docker compose up
    ```
 
 ## Upgrading from the old galexrt/docker-zulip
@@ -225,7 +225,7 @@ have changed it, please replace all occurences of
 1. Make a backup of your Zulip PostgreSQL data directory.
 
 2. Stop all Zulip containers, except the postgres one (e.g. use `docker stop`
-   and not `docker-compose stop`).
+   and not `docker compose stop`).
 
 3. Create a new (upgraded) PostgreSQL container using a different data
    directory:
@@ -244,14 +244,14 @@ have changed it, please replace all occurences of
    the new PostgreSQL container:
 
    ```shell
-   docker-compose exec database pg_dumpall -U postgres | \
+   docker compose exec database pg_dumpall -U postgres | \
        docker exec -i postgresnew psql -U postgres
    ```
 
 5. Stop and remove both PostgreSQL containers:
 
    ```shell
-   docker-compose rm --stop database
+   docker compose rm --stop database
    docker rm --stop postgresnew
    ```
 
@@ -269,11 +269,11 @@ have changed it, please replace all occurences of
 8. Delete the old existing containers:
 
    ```shell
-   docker-compose rm
+   docker compose rm
    ```
 
 9. Start Zulip up again:
 
    ```shell
-   docker-compose up
+   docker compose up
    ```

custom_zulip_files/README.custom_zulip_files.md

@@ -7,4 +7,4 @@ As an example, if you want to test a change to
 `scripts/setup/generate-self-signed-cert`, you would grab a copy of
 the script from zulip/zulip, place it at
 `custom_zulip_files/scripts/setup/generate-self-signed-cert`, make
-your local edits, and then run `docker-compose build`.
+your local edits, and then run `docker compose build`.

upgrade-postgresql

@@ -9,10 +9,10 @@ if ! command -v yq >/dev/null; then
 	exit 1
 fi
 
-# Require docker-compose 2.1.1 or higher, for `docker-compose up --wait`
-docker_compose_version=$(docker-compose --version --short)
+# Require docker compose 2.1.1 or higher, for `docker compose up --wait`
+docker_compose_version=$(docker compose --version --short)
 if [ "${docker_compose_version}" = "$(echo -e "2.1.0\n${docker_compose_version}" | sort -V | head -n1)" ]; then
-	echo "Your docker-compose is too old (${docker_compose_version}); upgrade to at least 2.1.1."
+	echo "Your docker compose is too old (${docker_compose_version}); upgrade to at least 2.1.1."
 	exit 1
 fi
 
@@ -38,7 +38,7 @@ if [ "$new_version" -eq "$old_version" ]; then
 fi
 
 # Create a new volume for the data; scope it with the current
-# directory, like docker-compose
+# directory, like docker compose
 docker_compose_project="$(basename "$(pwd)")"
 new_volume="postgresql-$new_version"
 full_new_volume="${docker_compose_project}_${new_volume}"
@@ -71,16 +71,16 @@ while [ "$(docker inspect --format='{{json .State.Health.Status}}' "$temp_contai
 done
 
 # Ensure database is running
-docker-compose up --wait database
+docker compose up --wait database
 
 # Stop the zulip processes which talk to the database
-zulip_is_running=$(docker-compose ps --filter status=running --services | grep zulip || true)
+zulip_is_running=$(docker compose ps --filter status=running --services | grep zulip || true)
 if [ -n "$zulip_is_running" ]; then
-	docker-compose stop zulip
+	docker compose stop zulip
 fi
 
 # Transfer the data to the new container
-docker-compose exec database pg_dumpall -U zulip |
+docker compose exec database pg_dumpall -U zulip |
 	docker exec -i "$temp_container" psql -U zulip
 
 if [ "$old_version" -eq "10" ]; then
@@ -92,7 +92,7 @@ if [ "$old_version" -eq "10" ]; then
 fi
 
 # Stop the running database
-docker-compose rm --force --stop database
+docker compose rm --force --stop database
 
 # Stop the temporary PostgreSQL container
 docker stop "$temp_container"
@@ -105,6 +105,6 @@ VOLUME="$new_volume:/var/lib/postgresql/data:rw" yq -i '.services.database.volum
 VOLUME="$new_volume" yq -i 'with(.volumes.[strenv(VOLUME)]; . = "" | . tag="!!null")' docker-compose.yml
 
 # Restart zulip, and the new database container
-docker-compose up --wait
+docker compose up --wait
 
 echo "Old data from PostgreSQL $old_version is available in $old_mountpoint"