dendrite/cmd/dendrite-demo-yggdrasil
S7evinK da2023ba04
Rename Riot to Element (#1874)
* s/riot/element/g

Signed-off-by: Till Faelligen <tfaelligen@gmail.com>

* fix formatting

Co-authored-by: kegsay <kegan@matrix.org>
Co-authored-by: Neil Alexander <neilalexander@users.noreply.github.com>
2021-07-20 09:45:40 +01:00
..
embed Rename Riot to Element (#1874) 2021-07-20 09:45:40 +01:00
signing Improvements to Yggdrasil demo (#1114) 2020-06-10 16:29:02 +01:00
yggconn Update dendrite-demo-yggdrasil to Yggdrasil 0.4 (#1921) 2021-07-15 12:16:44 +01:00
yggrooms Yggdrasil demo initial public room directory (#1181) 2020-07-03 14:28:43 +01:00
README.md Pinecone P2P demo (#1856) 2021-05-06 12:00:42 +01:00
main.go Update dendrite-demo-yggdrasil to Yggdrasil 0.4 (#1921) 2021-07-15 12:16:44 +01:00

README.md

Yggdrasil Demo

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