From 7585ef366fdbd9d67856f38931f85cb21d4013d9 Mon Sep 17 00:00:00 2001 From: Luke Walsh Date: Wed, 12 May 2021 02:19:39 -0700 Subject: [PATCH 1/9] Updating Platform Prerequisites for macOS Big Sur I just installed synapse on a new Mac & didn't need brew for libffi, but, I did need brew for libjpeg. I'm wondering if libffi is now included in the Xcode developer tools? I'm also not sure why jpeg wasn't mentioned previously, but, perhaps this was simply missed. --- INSTALL.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 7b4068923451..7a8658add3ee 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -164,13 +164,26 @@ sudo dnf groupinstall "Development Tools" ##### macOS -Installing prerequisites on macOS: +Installing prerequisites on macOS (Big Sur): +You'll need the updated Xcode developer tools: ```sh xcode-select --install -sudo easy_install pip -sudo pip install virtualenv -brew install pkg-config libffi +``` + +Install virtualenv with Pip: +```sh +sudo pip3 install virtualenv +``` + +Install Homebrew: +```sh +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" +``` + +Install libjpeg: +```sh +brew install jpeg ``` On macOS Catalina (10.15) you may need to explicitly install OpenSSL From 036268052e4a4a25b61ce00105b2c65b6e8a7f43 Mon Sep 17 00:00:00 2001 From: Luke Walsh Date: Wed, 12 May 2021 03:25:26 -0700 Subject: [PATCH 2/9] Create 9971.doc --- changelog.d/9971.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/9971.doc diff --git a/changelog.d/9971.doc b/changelog.d/9971.doc new file mode 100644 index 000000000000..651b98f23e1e --- /dev/null +++ b/changelog.d/9971.doc @@ -0,0 +1 @@ +Updated installation dependencies for MacOS Big Sur From 1caead6230b8bae9b6eb39e167a7309782a92f2a Mon Sep 17 00:00:00 2001 From: Luke Walsh Date: Wed, 12 May 2021 18:54:54 +0800 Subject: [PATCH 3/9] Update 9971.doc Fixing my punctuation :) --- changelog.d/9971.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/9971.doc b/changelog.d/9971.doc index 651b98f23e1e..4d240a0b59c7 100644 --- a/changelog.d/9971.doc +++ b/changelog.d/9971.doc @@ -1 +1 @@ -Updated installation dependencies for MacOS Big Sur +Updated installation dependencies for MacOS Big Sur! From c54649fad97fe1a9e6a8422e12602813aaef9966 Mon Sep 17 00:00:00 2001 From: Luke Walsh Date: Thu, 13 May 2021 16:32:28 +0800 Subject: [PATCH 4/9] Linking to Homebrew docs rather than in-lining --- INSTALL.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 7a8658add3ee..3f19135de354 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -176,12 +176,7 @@ Install virtualenv with Pip: sudo pip3 install virtualenv ``` -Install Homebrew: -```sh -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Install libjpeg: +Install libjpeg. You can use Homebrew (https://brew.sh): ```sh brew install jpeg ``` From c11c5522e304df77db7f95507de93eac077cf28f Mon Sep 17 00:00:00 2001 From: Luke Walsh Date: Thu, 15 Jul 2021 16:53:52 +0800 Subject: [PATCH 5/9] Clarified ARM specific advice Using the same language as the Catalina footnote below, but, thinking this belongs above the Catalina clarification until Apple adds native support for a libjpeg interface by default or to the developer tools installation. --- INSTALL.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 3f19135de354..999a542e62bc 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -164,7 +164,7 @@ sudo dnf groupinstall "Development Tools" ##### macOS -Installing prerequisites on macOS (Big Sur): +Installing prerequisites on macOS: You'll need the updated Xcode developer tools: ```sh @@ -176,7 +176,7 @@ Install virtualenv with Pip: sudo pip3 install virtualenv ``` -Install libjpeg. You can use Homebrew (https://brew.sh): +On ARM-based Macs you may need to explicitly install libjpeg which is a pillow dependency. You can use Homebrew (https://brew.sh): ```sh brew install jpeg ``` From 6673de2f9d5a969c4a4fc942cd047f5f4c528e32 Mon Sep 17 00:00:00 2001 From: Luke Walsh Date: Thu, 15 Jul 2021 17:23:28 +0800 Subject: [PATCH 6/9] Update INSTALL.md --- INSTALL.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/INSTALL.md b/INSTALL.md index 6d8c791bd56e..f199b233b96a 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -3,3 +3,5 @@ This document has moved to the [Synapse documentation website](https://matrix-org.github.io/synapse/latest/setup/installation.html). Please update your links. + +The markdown source is available in [docs/setup/installation.md](docs/setup/installation.md). From 195156de54af7283c2f3ff780b273a66f77f13a3 Mon Sep 17 00:00:00 2001 From: Luke Walsh Date: Thu, 15 Jul 2021 17:28:12 +0800 Subject: [PATCH 7/9] Add new ARM Mac-specific installation instructions --- docs/setup/installation.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/setup/installation.md b/docs/setup/installation.md index afa57a825dc7..af13f537e783 100644 --- a/docs/setup/installation.md +++ b/docs/setup/installation.md @@ -166,13 +166,16 @@ sudo dnf groupinstall "Development Tools" Installing prerequisites on macOS: +You may need to install the latest Xcode developer tools: ```sh xcode-select --install -sudo easy_install pip -sudo pip install virtualenv -brew install pkg-config libffi ``` +On ARM-based Macs you may need to explicitly install libjpeg which is a pillow dependency. You can use Homebrew (https://brew.sh): +```sh + brew install jpeg + ``` + On macOS Catalina (10.15) you may need to explicitly install OpenSSL via brew and inform `pip` about it so that `psycopg2` builds: From efc61806e0099e5fd5556fd4d4391837e0df204a Mon Sep 17 00:00:00 2001 From: Luke Walsh Date: Thu, 15 Jul 2021 17:35:38 +0800 Subject: [PATCH 8/9] Update 9971.doc --- changelog.d/9971.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/9971.doc b/changelog.d/9971.doc index 4d240a0b59c7..138b5ac6679a 100644 --- a/changelog.d/9971.doc +++ b/changelog.d/9971.doc @@ -1 +1 @@ -Updated installation dependencies for MacOS Big Sur! +Updated installation dependencies for ARM Macs & simplified overall Mac section by removing references to 1/ installing pip with easy_install (since pip3 comes with developer tools) & 2/ installing libffi with brew (since this only affects Mojave & older OS versions)! From 74e7bf06da916f8560ea93dba2392750e9d900d9 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Thu, 15 Jul 2021 07:50:57 -0400 Subject: [PATCH 9/9] Update changelog. --- changelog.d/9971.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/9971.doc b/changelog.d/9971.doc index 138b5ac6679a..ada68f70cacd 100644 --- a/changelog.d/9971.doc +++ b/changelog.d/9971.doc @@ -1 +1 @@ -Updated installation dependencies for ARM Macs & simplified overall Mac section by removing references to 1/ installing pip with easy_install (since pip3 comes with developer tools) & 2/ installing libffi with brew (since this only affects Mojave & older OS versions)! +Updated installation dependencies for newer macOS versions and ARM Macs. Contributed by Luke Walsh.