diff --git a/docs/postgres.md b/docs/postgres.md
index 0562021da5..de4e2ba4b7 100644
--- a/docs/postgres.md
+++ b/docs/postgres.md
@@ -153,9 +153,9 @@ database file (typically `homeserver.db`) to another location. Once the
copy is complete, restart synapse. For instance:
```sh
-./synctl stop
+synctl stop
cp homeserver.db homeserver.db.snapshot
-./synctl start
+synctl start
```
Copy the old config file into a new config file:
@@ -192,10 +192,10 @@ Once that has completed, change the synapse config to point at the
PostgreSQL database configuration file `homeserver-postgres.yaml`:
```sh
-./synctl stop
+synctl stop
mv homeserver.yaml homeserver-old-sqlite.yaml
mv homeserver-postgres.yaml homeserver.yaml
-./synctl start
+synctl start
```
Synapse should now be running against PostgreSQL.
diff --git a/docs/turn-howto.md b/docs/turn-howto.md
index eba7ca6124..3a2cd04e36 100644
--- a/docs/turn-howto.md
+++ b/docs/turn-howto.md
@@ -238,8 +238,9 @@ After updating the homeserver configuration, you must restart synapse:
* If you use synctl:
```sh
- cd /where/you/run/synapse
- ./synctl restart
+ # Depending on how Synapse is installed, synctl may already be on
+ # your PATH. If not, you may need to activate a virtual environment.
+ synctl restart
```
* If you use systemd:
```sh
diff --git a/docs/upgrade.md b/docs/upgrade.md
index f9be3ac6bc..0d0bb066ee 100644
--- a/docs/upgrade.md
+++ b/docs/upgrade.md
@@ -47,7 +47,7 @@ this document.
3. Restart Synapse:
```bash
- ./synctl restart
+ synctl restart
```
To check whether your update was successful, you can check the running
@@ -85,6 +85,27 @@ process, for example:
dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
```
+# Upgrading to v1.55.0
+
+## `synctl` script has been moved
+
+The `synctl` script
+[has been made](https://github.com/matrix-org/synapse/pull/12140) an
+[entry point](https://packaging.python.org/en/latest/specifications/entry-points/)
+and no longer exists at the root of Synapse's source tree. If you wish to use
+`synctl` to manage your homeserver, you should invoke `synctl` directly, e.g.
+`synctl start` instead of `./synctl start` or `/path/to/synctl start`.
+
+You will need to ensure `synctl` is on your `PATH`.
+ - This is automatically the case when using
+ [Debian packages](https://packages.matrix.org/debian/) or
+ [docker images](https://hub.docker.com/r/matrixdotorg/synapse)
+ provided by Matrix.org.
+ - When installing from a wheel, sdist, or PyPI, a `synctl` executable is added
+ to your Python installation's `bin`. This should be on your `PATH`
+ automatically, though you might need to activate a virtual environment
+ depending on how you installed Synapse.
+
# Upgrading to v1.54.0
## Legacy structured logging configuration removal
|
