Document pip connection timeout error (#215)

Signed-off-by: Omar Mohamed <[email protected]>
matrix-org · Apr 13, 2021 · 7a3d6f8 · 7a3d6f8
1 parent 62bdfeb
commit 7a3d6f8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -19,6 +19,10 @@ This creates an isolated virtual Python environment ("virtualenv") just for
 use with Sygnal, then installs Sygnal along with its dependencies, and lastly
 installs a handful of useful tools
 
+If you get `ConnectTimeoutError`, this is caused by slow internet whereby 
+`pip` has a default time out of _15 sec_. You can specify a larger timeout 
+by passing `--timeout 120` to the `pip install` command above.
+
 Finally, activate the virtualenv by running:
 
 ```bash

diff --git a/changelog.d/215.doc b/changelog.d/215.doc
@@ -0,0 +1 @@
+Document how to work around pip installation timeout errors. Contributed by Omar Mohamed.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Document how to work around pip installation timeout errors. Contributed by Omar Mohamed.