mirrors/dendrite
1
0
Fork 0
mirror of https://github.com/matrix-org/dendrite.git synced 2024-11-23 23:01:56 -06:00
Code Issues Packages Projects Releases Wiki Activity
dendrite/cmd/dendrite-demo-yggdrasil
History
Kegsay bf7e85848b
Rename serverkeyapi to signingkeyserver (#1492) 
* Rename serverkeyapi to signingkeyserver

We use "api" for public facing stuff and "server" for internal stuff.
As the server key API is internal only, we call it 'signing key server',
which also clarifies the type of key (as opposed to TLS keys, E2E keys, etc)

* Convert docker/scripts to use signing-key-server

* Rename missed bits
2020-10-07 16:23:18 +01:00
..
convert Improvements to Yggdrasil demo (#1114) 2020-06-10 16:29:02 +01:00
embed Fix MIME types for embedded Riot in Ygg demo 2020-07-07 09:43:58 +01:00
signing Improvements to Yggdrasil demo (#1114) 2020-06-10 16:29:02 +01:00
yggconn Yggdrasil demo tweaks 2020-10-06 10:37:52 +01:00
yggrooms Yggdrasil demo initial public room directory (#1181) 2020-07-03 14:28:43 +01:00
main.go Rename serverkeyapi to signingkeyserver (#1492) 2020-10-07 16:23:18 +01:00
README.md Yggdrasil demo updates 2020-07-10 16:28:18 +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.