dendrite/cmd/dendrite-demo-yggdrasil
Neil Alexander e7d450adb8
Add SkipClean and UseEncodedPaths to intermediate routers (#1275)
2020-08-17 12:28:20 +01:00
..
convert
embed
signing
yggconn
yggrooms
README.md
main.go Add SkipClean and UseEncodedPaths to intermediate routers (#1275) 2020-08-17 12:28:20 +01:00

README.md

Yggdrasil Demo

This is the Dendrite Yggdrasil demo! It's easy to get started - all you need is Go 1.13 or later.

To run the homeserver, start at the root of the Dendrite repository and run:

go run ./cmd/dendrite-demo-yggdrasil

The following command line arguments are accepted:

  • -peer tcp://a.b.c.d:e to specify a static Yggdrasil peer to connect to - you will need to supply this if you do not have another Yggdrasil node on your network
  • -port 12345 to specify a port to listen on for client connections

If you need to find an internet peer, take a look at this list.

Then point your favourite Matrix client to the homeserver URLhttp://localhost:8008 (or whichever -port you specified), create an account and log in.

If your peering connection is operational then you should see a Connected TCP: line in the log output. If not then try a different peer.

Once logged in, you should be able to open the room directory or join a room by its ID.