From 00abc56c631509c5853d105b160c1f7808e09a6e Mon Sep 17 00:00:00 2001 From: Eric Eastwood Date: Tue, 29 Dec 2020 16:21:16 -0600 Subject: [PATCH 1/5] Add some extra notes for getting Synapse running on macOS Just some extra steps and notes I needed to get Synapse running on a new macOS machine. - https://stackoverflow.com/a/56228387/796832 --- .gitignore | 1 + INSTALL.md | 3 +++ README.rst | 10 ++++++++++ changelog.d/8997.doc | 1 + 4 files changed, 15 insertions(+) create mode 100644 changelog.d/8997.doc diff --git a/.gitignore b/.gitignore index 9bb5bdd647b9..362062d53c94 100644 --- a/.gitignore +++ b/.gitignore @@ -12,6 +12,7 @@ _trial_temp/ _trial_temp*/ /out +.DS_Store # stuff that is likely to exist when you run a server locally /*.db diff --git a/INSTALL.md b/INSTALL.md index eb5f506de9a0..ed2b7e4a6ca2 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -189,6 +189,9 @@ brew install openssl@1.1 export LDFLAGS=-L/usr/local/Cellar/openssl\@1.1/1.1.1d/lib/ ``` +Alternatively, you can try https://stackoverflow.com/a/56228387/796832 + + #### OpenSUSE Installing prerequisites on openSUSE: diff --git a/README.rst b/README.rst index d724cf97da18..effc62f48d6e 100644 --- a/README.rst +++ b/README.rst @@ -278,6 +278,16 @@ differ):: PASSED (skips=15, successes=1322) + +For the homeserver config, you can copy the sample config: + + cp docs/sample_config.yaml homeserver.yaml + +Then finally start the app: + + synctl start homeserver.yaml + + Running the Integration Tests ============================= diff --git a/changelog.d/8997.doc b/changelog.d/8997.doc new file mode 100644 index 000000000000..dd1a88230160 --- /dev/null +++ b/changelog.d/8997.doc @@ -0,0 +1 @@ +Add some extra docs for getting Synapse running on macOS. From cb221089c83c6ba49afd5b80ec3fcd1ca5aa7d1f Mon Sep 17 00:00:00 2001 From: Eric Eastwood Date: Tue, 29 Dec 2020 17:23:10 -0600 Subject: [PATCH 2/5] Suggest running the demo script Context: https://github.com/matrix-org/synapse/pull/8997#discussion_r549877141 --- README.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index effc62f48d6e..976475a427ab 100644 --- a/README.rst +++ b/README.rst @@ -278,16 +278,21 @@ differ):: PASSED (skips=15, successes=1322) +We recommend using the demo which starts 3 federated instances running on ports `8080` - `8082` -For the homeserver config, you can copy the sample config: + ./demo/start.sh - cp docs/sample_config.yaml homeserver.yaml +(to stop, you can use `./demo/stop.sh`) -Then finally start the app: +If you just want to start a single instance of the app and run it directly, +you can copy the sample homeserver config then start: + cp docs/sample_config.yaml homeserver.yaml synctl start homeserver.yaml + + Running the Integration Tests ============================= From 7fd2bdc46110bd1f3b1df8569e66ed23a9278a9f Mon Sep 17 00:00:00 2001 From: Eric Eastwood Date: Tue, 29 Dec 2020 18:42:18 -0600 Subject: [PATCH 3/5] Use generate-config option to get the key generation --- README.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 976475a427ab..e6a4cf5602ae 100644 --- a/README.rst +++ b/README.rst @@ -284,10 +284,14 @@ We recommend using the demo which starts 3 federated instances running on ports (to stop, you can use `./demo/stop.sh`) -If you just want to start a single instance of the app and run it directly, -you can copy the sample homeserver config then start: +If you just want to start a single instance of the app and run it directly: + + python -m synapse.app.homeserver \ + --server-name my.domain.name \ + --config-path homeserver.yaml \ + --generate-config \ + --report-stats=[yes|no] - cp docs/sample_config.yaml homeserver.yaml synctl start homeserver.yaml From 48b2cefbce5cab99b10e3bdf8f55c88db75ae478 Mon Sep 17 00:00:00 2001 From: Eric Eastwood Date: Mon, 4 Jan 2021 15:15:14 -0600 Subject: [PATCH 4/5] Start the app by python --- README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index e6a4cf5602ae..75744ac2cd5c 100644 --- a/README.rst +++ b/README.rst @@ -286,13 +286,15 @@ We recommend using the demo which starts 3 federated instances running on ports If you just want to start a single instance of the app and run it directly: + # Create the homeserver.yaml config once python -m synapse.app.homeserver \ --server-name my.domain.name \ --config-path homeserver.yaml \ --generate-config \ --report-stats=[yes|no] - synctl start homeserver.yaml + # Start the app + python -m synapse.app.homeserver --config-path homeserver.yaml From 51fdf1c176c0c37d0d203d686f0ee113ae28cfe0 Mon Sep 17 00:00:00 2001 From: Eric Eastwood Date: Thu, 14 Jan 2021 13:46:58 -0600 Subject: [PATCH 5/5] Update openssl install docs --- INSTALL.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 5ae86ba0fd41..d405d9fe555c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -190,12 +190,10 @@ via brew and inform `pip` about it so that `psycopg2` builds: ```sh brew install openssl@1.1 -export LDFLAGS=-L/usr/local/Cellar/openssl\@1.1/1.1.1d/lib/ +export LDFLAGS="-L/usr/local/opt/openssl/lib" +export CPPFLAGS="-I/usr/local/opt/openssl/include" ``` -Alternatively, you can try https://stackoverflow.com/a/56228387/796832 - - ##### OpenSUSE Installing prerequisites on openSUSE: