Skip to content

Update matrix-appservice-irc version #3512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

thomwiggers
Copy link
Contributor

The update to 3.0 brings with it that it now uses MediaProxy.

@thomwiggers thomwiggers marked this pull request as draft September 9, 2024 11:57
Comment on lines +117 to +132
# Config for the media proxy, required to serve publically accessible URLs to authenticated Matrix media
mediaProxy:
# To generate a .jwk file:
# $ node src/generate-signing-key.js > signingkey.jwk
signingKeyPath: "signingkey.jwk"
# How long should the generated URLs be valid for
ttlSeconds: 3600
# The port for the media proxy to listen on
bindPort: 11111
# The publically accessible URL to the media proxy
publicUrl: "https://irc.bridge/media"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These lines require some more setup

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, we can generate a signing key using the image with:

docker run --entrypoint node matrixdotorg/matrix-appservice-irc ./lib/generate-signing-key.js

We'll need to execute this command before starting the service, and allow the user to configure the parameters above.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My questions are more about how bindPort and publicUrl should work: I'm not sure where to get these values from.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What I'm assuming right now is that:

  • bindPort represents the internal port where the service will listen for connections. It won't be accessible from the internet.
  • publicUrl is the actual URL where external clients will go to fetch media. There must be some kind of reverse proxy redirecting requests from/to publicUrl to bindPort.

I may be wrong, though. I haven't been able to find good documentation on what these settings do.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was under the impression that the media proxy was external to the bridge, but I might also be wrong there...

@thomwiggers
Copy link
Contributor Author

Setting up media proxy is a bit above my level

@luixxiul luixxiul added the help-wanted Extra attention from the community is needed label Nov 11, 2024
@thomwiggers
Copy link
Contributor Author

I have rebased this, but would appreciate some help getting the authenticated media set up correctly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help-wanted Extra attention from the community is needed needs-rebase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants