summary refs log tree commit diff
diff options
context:
space:
mode:
authorPatrick Cloke <clokep@users.noreply.github.com>2021-01-18 11:12:20 -0500
committerGitHub <noreply@github.com>2021-01-18 11:12:20 -0500
commitde45bf5b5b72ea4cc6d16f2c41d7f2a6e1c350bf (patch)
tree794ef3b27de6f9ce576f077aaa2d77af4b1ecbe9
parentAllow moving account data and receipts streams off master (#9104) (diff)
downloadsynapse-de45bf5b5b72ea4cc6d16f2c41d7f2a6e1c350bf.tar.xz
Quote pip install with brackets to avoid shell interpretation. (#9151)
-rw-r--r--changelog.d/9151.doc1
-rw-r--r--docs/postgres.md2
-rw-r--r--docs/workers.md2
3 files changed, 3 insertions, 2 deletions
diff --git a/changelog.d/9151.doc b/changelog.d/9151.doc
new file mode 100644
index 0000000000..7535748060
--- /dev/null
+++ b/changelog.d/9151.doc
@@ -0,0 +1 @@
+Quote `pip install` packages when extras are used to avoid shells interpreting bracket characters.
diff --git a/docs/postgres.md b/docs/postgres.md
index c30cc1fd8c..680685d04e 100644
--- a/docs/postgres.md
+++ b/docs/postgres.md
@@ -18,7 +18,7 @@ connect to a postgres database.
     virtualenv](../INSTALL.md#installing-from-source), you can install
     the library with:
 
-        ~/synapse/env/bin/pip install matrix-synapse[postgres]
+        ~/synapse/env/bin/pip install "matrix-synapse[postgres]"
 
     (substituting the path to your virtualenv for `~/synapse/env`, if
     you used a different path). You will require the postgres
diff --git a/docs/workers.md b/docs/workers.md
index cc5090f224..d01683681f 100644
--- a/docs/workers.md
+++ b/docs/workers.md
@@ -59,7 +59,7 @@ The appropriate dependencies must also be installed for Synapse. If using a
 virtualenv, these can be installed with:
 
 ```sh
-pip install matrix-synapse[redis]
+pip install "matrix-synapse[redis]"
 ```
 
 Note that these dependencies are included when synapse is installed with `pip