https://github.com/madlittlemods/matrix-appservice-bridge-tutorial1
A simple barebones Matrix <-> Gitter bridge just to try making an App Service (AS)
https://github.com/madlittlemods/matrix-appservice-bridge-tutorial1
Last synced: 3 days ago
JSON representation
A simple barebones Matrix <-> Gitter bridge just to try making an App Service (AS)
- Host: GitHub
- URL: https://github.com/madlittlemods/matrix-appservice-bridge-tutorial1
- Owner: MadLittleMods
- Created: 2020-10-02T06:12:24.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-10-29T07:41:15.000Z (over 4 years ago)
- Last Synced: 2025-04-06T16:18:47.374Z (2 months ago)
- Language: JavaScript
- Size: 60.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Matrix appservice bridge tutorial
See https://github.com/matrix-org/matrix-appservice-bridge/blob/develop/HOWTO.md
---
Basing homeserver and Element setup off of https://zerowidthjoiner.net/2020/03/20/setting-up-matrix-and-riot-with-docker
```
docker-compose up -d --no-recreate
```
Setup homeserver, see https://hub.docker.com/r/matrixdotorg/synapse/
If on macOS/Linux, replace `%cd%` with `$(pwd)`,
```
docker run -it --rm
--mount type=bind,src=%cd%\data,dst=/data
-e SYNAPSE_SERVER_NAME=my.matrix.host
-e SYNAPSE_REPORT_STATS=yes
matrixdotorg/synapse:latest generate
```
Create the registration file:
```
node index.js -r -u "http://localhost:9000"
```
Copy the latest `gitter-registration.yaml` to `data/`
Edit `data/homeserver.yaml` to add the registration
```
# A list of application service config files to use
#
app_service_config_files:
- /data/gitter-registration.yaml
```
Now you can visit http://localhost:18008 to see your homeserver
Create the first test user on your homeserver
```
$ docker exec -it synapse /bin/bash
> register_new_matrix_user -c /data/homeserver.yaml http://localhost:8008
```
Visit http://localhost:18010/ and sign in with your new user
Create a new public room:
- Settings -> Security & Privacy -> Who can access this room? -> **Anyone who knows the room's link, including guests**
- Settings -> Roles & Permissions -> Invite users -> **Default**
- Settings -> Advanced -> Copy the **Internal room ID** into the `env.json` here in the AS project
Run our Application Service (AS)
```
node index.js -p 9000
```