mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2024-11-27 00:31:55 -06:00
Code Issues Packages Projects Releases Wiki Activity
dendrite/cmd/dendrite-demo-yggdrasil
History
Neil Alexander dd061a172e
Tidy up AddPublicRoutes (#2412) 
* Simplify federation API `AddPublicRoutes`

* Simplify client API `AddPublicRoutes`

* Simplify media API `AddPublicRoutes`

* Simplify sync API `AddPublicRoutes`

* Simplify `AddAllPublicRoutes`
2022-05-03 17:17:02 +01:00
..
embed Run gofmt on dendrite - apply go 1.17 preferred build tags (#2021) 2021-11-02 16:48:48 +00:00
signing Improvements to Yggdrasil demo (#1114) 2020-06-10 16:29:02 +01:00
yggconn Update Yggdrasil P2P demo (also remove QUIC dependency) 2022-03-16 16:49:10 +00:00
yggrooms Merge federationapi, federationsender, signingkeyserver components (#2055) 2021-11-24 10:45:23 +00:00
main.go Tidy up AddPublicRoutes (#2412) 2022-05-03 17:17:02 +01:00
README.md Require Go 1.16 (#2122) 2022-01-28 16:24:01 +00:00

README.md

Yggdrasil Demo

This is the Dendrite Yggdrasil demo! It's easy to get started - all you need is Go 1.16 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.