Skip to content
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

Add documentation about serving Sydent APIs over HTTPS #518

Merged
merged 2 commits into from
Jun 29, 2022

Conversation

babolivier
Copy link
Contributor

While answering a question in #sydent:matrix.org I realised we don't have documentation about this, so I figured I'd quickly write one.

@babolivier babolivier requested a review from a team as a code owner June 28, 2022 18:19
Comment on lines +70 to +71
When using a reverse proxy, it is recommended to limit the requests proxied to Sydent to
ones which paths start with ``/_matrix/identity`` for security reasons.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note that internal APIs and replication APIs are listening on a separate host:port so in theory it should be fine to not do that, but I figured we might as well be safe in case we add APIs that should be public to this listener in the future.

Copy link
Contributor

@squahtx squahtx left a comment

Choose a reason for hiding this comment

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

This is some much needed documentation, lgtm!

@babolivier babolivier merged commit 611a2a8 into main Jun 29, 2022
@babolivier babolivier deleted the babolivier/readme_tls branch June 29, 2022 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants