Quote pip install with brackets to avoid shell interpretation. (#9151)

matrix-org · Jan 18, 2021 · de45bf5 · de45bf5
1 parent 6633a40
commit de45bf5
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/changelog.d/9151.doc 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
@@ -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
@@ -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