Docs and config improvements #124
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Half-Shot
changed the title
This reverts commit b422b3d.
HarHarLinks
reviewed
Jan 4, 2022
|
|
||
| You will also need to make this port accessible to the internet so services like GitHub can reach the bridge. It | ||
| is recommended to factor hookshot into your load balancer configuration, but currrently this process is left as an | ||
| excercise to the user. | ||
|
|
||
| In terms of API endpoints: | ||
|
|
||
| - The `webhooks` resource handles resources under `/`, so it should be on it's own listener. |
There was a problem hiding this comment.
should be on its on listener
but you can reasonably assume that webhooks will not get assigned an endpoint /metrics or /v1....... right?!
|
|
||
| You will also need to make this port accessible to the internet so services like GitHub can reach the bridge. It | ||
| is recommended to factor hookshot into your load balancer configuration, but currrently this process is left as an | ||
| excercise to the user. | ||
|
|
||
| In terms of API endpoints: | ||
|
|
||
| - The `webhooks` resource handles resources under `/`, so it should be on it's own listener. |
| bindAddress: 127.0.0.1 | ||
| ``` | ||
|
|
||
| The `port` and `bindAddress` must not conflict with the other listeners in the bridge config. This listeners should **not** be reachable |
| # | ||
| domain: example.com | ||
| url: http://localhost:8008 | ||
| mediaUrl: http://example.com |
There was a problem hiding this comment.
perhaps it would be reasonable to explain:
- domain: "name" of your homeserver, as it appears in your MXIDs
- url: where hs is reachable, preferably internally i.e. localhost => docker needs adjustment
- mediaUrl: homeserver, but via potential load balancer etc to reach the media worker(?)
- port & bindAddress need adjustment/forwarding when using docker
|
@Half-Shot not sure if this shows up in your notifs, hence ping: please look over these comments |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #120
Fixes #123