search

matrix-org / matrix-appservice-discord

A bridge between Matrix and Discord.
Apache License 2.0
813 stars 152 forks source link

FR/Q: improve onboarding instructions #800

Open laur89 opened 2 years ago

laur89 commented 2 years ago

Clearer instructions on getting this bridge up and running would be appreciated. Some questions I've had thus far:

  1. what's auth.clientID in config.yaml? Is it APPLICATION ID from your discord application page (https://discord.com/developers/applications/112233445566778899/information)? Clarifying this in config.sample.yaml would suffice. Perhaps also change the example value to 112233445566778899 so it's clear it's a digit with a length of 18?
  2. bridge.homeserverUrl - is this the domain that matrix network connects to? eg if my user is @username:example.com, but example.com delegates to matrix.example.com:7711, does this mean bridge.domain would be example.com & .homeserverUrl matrix.example.com:7711? If that's the case, wouldn't it make sense for the bridge to resolve homeserverUrl the same way as all the matrix clients do, ie resolve the configured delegation?
  3. in readme, I'd explicitly add that Run node build/src/discordas.js -r -u "http://localhost:9005" -c config.yaml step generates the "registration file"
  4. docker paragraph in readme shouldn't duplicate Create the configuration file. Use the sample configuration file as a template. again, as it's covered already in the previous paragraph. Instead, it'd make more sense to explicitly state that config.yaml is not only needed for the registration file creation, but also by the runtime: 
    
# Copy the registration file to the volume
cp discord-registration.yaml /matrix-appservice-discord/discord-registration.yaml

Copy the registration & configuration files to the volume:

cp discord-registration.yaml config.yaml /matrix-appservice-discord/



(btw what's the deal with config.yaml needed for both registration file creation & runtime?)
Miepee commented 2 years ago
  1. in readme, I'd explicitly add that Run node build/src/discordas.js -r -u "http://localhost:9005" -c config.yaml step generates the "registration file"

If I might add, a quick notice that the port mentioned there needs to be the same one as in the config.yaml would also be appreciated, as I've got bitten by that before :P

antonok-edm commented 2 years ago

For anyone else who comes across this when setting up their own bridge, or might want to try updating the documentation themselves:

  1. Yes, it is APPLICATION ID
  2. In the above example, you'd use bridge.domain: example.com and bridge.homeserverUrl: https://matrix.example.com:7711