Skip to content

Add rate limit conf to user directory endpoint #19291

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.

Sign up for GitHub

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

Jump to bottom
Open
MatMaul wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Add rate limit conf to user directory endpoint #19291

MatMaul wants to merge 2 commits into from
+45 −0

Conversation

@MatMaul
Copy link
Contributor

@MatMaul MatMaul commented Dec 9, 2025 •
edited
Loading

The goal is to avoid that an user could scrape the user directory too quickly.

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Code style is correct (run the linters)

@MatMaul MatMaul force-pushed the rc-search branch 2 times, most recently from 67eac2f to 151b288 Compare December 9, 2025 13:57
@MatMaul MatMaul marked this pull request as ready for review December 9, 2025 14:32
@MatMaul MatMaul requested a review from a team as a code owner December 9, 2025 14:32
MadLittleMods
MadLittleMods approved these changes Dec 17, 2025
View reviewed changes
Copy link
Contributor

@MadLittleMods MadLittleMods left a comment

Choose a reason for hiding this comment

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

Seems reasonable

changelog.d/19291.misc
@@ -0,0 +1 @@
Add a config to be able to rate limit search in the user directory.
Copy link
Contributor

@MadLittleMods MadLittleMods Dec 17, 2025

Choose a reason for hiding this comment

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

What's spawning this change?

Copy link
Contributor Author

@MatMaul MatMaul Dec 23, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

The goal is to avoid that an user could scrape the user directory too quickly.

MadLittleMods
MadLittleMods reviewed Dec 23, 2025
View reviewed changes
docs/usage/configuration/config_documentation.md
burst_count: 5.0
```
---
### `rc_user_directory`
Copy link
Contributor

@MadLittleMods MadLittleMods Dec 23, 2025

Choose a reason for hiding this comment

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

We should also add this to the Complement config,

synapse/docker/complement/conf/workers-shared-extra.yaml.j2

Lines 34 to 35 in f79acff

# Disable server rate-limiting
rc_federation:

And the demo script I guess:

synapse/demo/start.sh

Lines 103 to 105 in f79acff

# Disable any rate limiting
ratelimiting=$(cat <<-RC
rc_message:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MadLittleMods MadLittleMods MadLittleMods approved these changes

Assignees

No one assigned

Labels

A-Config A-Rate-Limit A-User-Directory

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@MatMaul @MadLittleMods