Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs now that libolm is removed #740

Merged
merged 1 commit into from
Sep 25, 2024
Merged

Update docs now that libolm is removed #740

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 1 addition & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ See also [Complement Crypto](https://github.com/matrix-org/complement-crypto) fo

## Running

You need to have Go and Docker >= 20.10 installed, as well as `libolm3` and `libolm-dev`. Then:
You need to have Go and Docker >= 20.10 installed. Then:

```
$ COMPLEMENT_BASE_IMAGE=some-matrix/homeserver-impl go test -v ./tests/...
Expand All @@ -24,23 +24,6 @@ If you need to pass environment variables to the image under test, you can:
1. define a pass-through prefix with e.g. `COMPLEMENT_SHARE_ENV_PREFIX=PASS_`; then
2. prefix the desired environment variables with that prefix; e.g. `PASS_SYNAPSE_COMPLEMENT_USE_WORKERS=true`.

### Dependencies

Complement supports encryption via `libolm`. You can install `libolm3` on Debian using something like:
```
echo "deb http://deb.debian.org/debian buster-backports main" > /etc/apt/sources.list.d/complement.list && apt-get update && apt-get install -y libolm3 libolm-dev/buster-backports
```
or on Mac:
```
brew install libolm
```
If you are on an Apple Silicon Mac then you'll need to set these environment variables too so Go can find `libolm`:
```
export LIBRARY_PATH=/opt/homebrew/lib
export CPATH=/opt/homebrew/include
export PATH=/opt/homebrew/bin:$PATH
```

### Potential conflict with firewall software

The homeserver in the test image needs to be able to make requests to the mock
Expand Down
Loading