Skip to content

Commit 53c5552

Browse files
committed
Update README
1 parent 967a35a commit 53c5552

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@
44

55
General purpose puppeting bridges using libpurple and other backends.
66

7-
This bridge is in very active development currently and intended mainly for experimentation and evaluation purposes.
8-
9-
This has been tested to work on `Node.JS v10` and `Synapse 0.34.0`.
10-
117
## Helping out
128

139
If you wish to file an issue or create a PR, **please read [CONTRIBUTING.md](./CONTRIBUTING.md) first.
@@ -29,43 +25,43 @@ The following are supported:
2925

3026
Both backends are supported in Docker. You can go straight ahead and use the provided Dockerfile
3127
to build the bridge. You can build the docker image with `docker build -t bifrost:latest` and then
32-
run the image with: `docker run -v /your/path/to/data:/data bifrost:latest -p 5000:9555`.
28+
run the image with `docker run -v /your/path/to/data:/data bifrost:latest -p 5000:9555`.
3329

3430
An image is available on [Dockerhub](https://hub.docker.com/r/matrixdotorg/matrix-bifrost).
3531

3632
### Things to note
3733

3834
- Make sure you store your `config.yaml`, `registration.yaml` inside /data.
3935
- You should configure your `config.yaml`'s `userStoreFile` and `roomStoreFile` to point to files inside `/data`
40-
- The intenal port for the bridge is `5000`, you should map this to an external port in docker.
36+
- The internal port for the bridge is `5000`, you should map this to an external port in docker.
4137
- Be careful not to leave any config options pointing to `127.0.0.1` / `localhost` as they will not resolve inside docker.
4238
- The exception to this rule is `bridge.domain`, which MUST be your homeserver's URL.
4339

4440
## Installing (non-docker)
4541

4642
### Dependencies
4743

48-
Simply run `yarn install` as normal. Dependencies for `node-purple` can in it's [README](https://github.com/matrix-org/node-purple#node-purple)
44+
Simply run `yarn install` as normal. Dependencies for `node-purple` can in its [README](https://github.com/matrix-org/node-purple#node-purple)
4945

5046
### Installing & Configuring
5147

52-
**NOTE: You must carefully read the config.sample.yaml and use the bits appropriate for you. Do NOT copy and paste it verbatim as it won't work.**
48+
**NOTE: You must carefully read the `config.sample.yaml` and use the bits appropriate for you. Do NOT copy and paste it verbatim as it won't work.**
5349

5450
```shell
5551
yarn install # Install dependencies
5652
yarn build # Build files
5753
cp config.sample.yaml config.yaml
58-
# ... Set the domain name, homeserver url, and then review the rest of the config
54+
# ... Set the domain name, homeserver URL, and then review the rest of the config
5955
sed -i "s/domain: \"localhost\"/domain: \"$YOUR_MATRIX_DOMAIN\"/g" config.yaml
6056
```
6157

6258
You must also generate a registration file:
6359

6460
```shell
65-
yarn genreg -- -u http://localhost:9555 # Set listener url here.
61+
yarn genreg -- -u http://localhost:9555 # Set listener URL here.
6662
```
6763

68-
This file should be accessible by your **homeserver**, which will use this file to get the correct url and tokens to push events to.
64+
This file should be accessible by your **homeserver**, which will use this file to get the correct URL and tokens to push events to.
6965

7066
For Synapse, this can be done by:
7167

0 commit comments

Comments
 (0)