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
Show file tree
Hide file tree
Changes from all commits
Commits
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
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: 2 additions & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,8 @@ 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"
```

##### OpenSUSE
Expand Down
21 changes: 21 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,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
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add some extra docs for getting Synapse running on macOS.