Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Add some extra notes for getting Synapse running on macOS #8997

Merged
merged 7 commits into from
Jan 15, 2021
Merged

Add some extra notes for getting Synapse running on macOS #8997

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
00abc56
Add some extra notes for getting Synapse running on macOS
MadLittleMods Dec 29, 2020
cb22108
Suggest running the demo script
MadLittleMods Dec 29, 2020
7fd2bdc
Use generate-config option to get the key generation
MadLittleMods Dec 30, 2020
48b2cef
Start the app by python
MadLittleMods Jan 4, 2021
f25aa90
Merge branch 'develop' into extra-macos-developer-notes
MadLittleMods Jan 14, 2021
51fdf1c
Update openssl install docs
MadLittleMods Jan 14, 2021
871840e
Merge branch 'develop' into extra-macos-developer-notes
MadLittleMods Jan 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
_trial_temp/
_trial_temp*/
/out
.DS_Store

# stuff that is likely to exist when you run a server locally
/*.db
Expand Down
3 changes: 3 additions & 0 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,9 @@ brew install [email protected]
export LDFLAGS=-L/usr/local/Cellar/openssl\@1.1/1.1.1d/lib/
```

Alternatively, you can try https://stackoverflow.com/a/56228387/796832
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was it that you needed to also configure CPPFLAGS or was the path wrong?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@clokep I'm not sure which one. After copy-pasting both of of those lines linked in the answer, it worked.

I did have the [email protected] brew package installed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like homebrew puts symlinks into /usr/local/opt that (by default) point to /usr/local/Cellar. What version of openssl do you have installed? I now have 1.1.1i so I'm guessing the issue was that the above command directly specified the 1.1.1d? I think we should check the above directions to what the SO answer suggests (no need to link to it IMO):

brew install [email protected]
export LDFLAGS="-L/usr/local/opt/openssl/lib"
export CPPFLAGS="-I/usr/local/opt/openssl/include"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I should note that this is just a symlink 😄 :

ls -l /usr/local/opt/openssl*   
lrwxr-xr-x  1 clokep  admin  28 Dec 14 09:12 /usr/local/opt/openssl -> ../Cellar/[email protected]/1.1.1i
lrwxr-xr-x  1 clokep  admin  28 Dec 14 09:12 /usr/local/opt/[email protected] -> ../Cellar/[email protected]/1.1.1i

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 that looks great to me! Thanks for digging to find the symlinks are the same anyway 😀

Looks like I have the same version:

$ brew info [email protected]
[email protected]: stable 1.1.1i (bottled) [keg-only]



#### OpenSUSE

Installing prerequisites on openSUSE:
Expand Down
21 changes: 21 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,27 @@ differ)::

PASSED (skips=15, successes=1322)

We recommend using the demo which starts 3 federated instances running on ports `8080` - `8082`

./demo/start.sh

(to stop, you can use `./demo/stop.sh`)

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]

# Start the app
python -m synapse.app.homeserver --config-path homeserver.yaml




Running the Integration Tests
=============================

Expand Down
1 change: 1 addition & 0 deletions changelog.d/8997.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add some extra docs for getting Synapse running on macOS.