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 room allowlist to configuration #234

Open
jonaharagon opened this issue May 28, 2023 · 3 comments · May be fixed by #283
Open

Add room allowlist to configuration #234

jonaharagon opened this issue May 28, 2023 · 3 comments · May be fixed by #283
Labels
T-Enhancement New feature or request

Comments

@jonaharagon
Copy link

jonaharagon commented May 28, 2023

I think it would be nice if self-hosting admins could specify a list of rooms which can be joined by this client.

The use-case I'm envisioning is organizations running this archive for their own rooms, but not wanting to index every room accessible by the archive bot account. Trying to open a non-allowlisted room could either redirect to another archive, like archive.matrix.org, or simply return an error.

@MadLittleMods MadLittleMods changed the title Add room whitelist to configuration Add room allowlist to configuration May 30, 2023
@MadLittleMods MadLittleMods added the T-Enhancement New feature or request label May 30, 2023
@MadLittleMods
Copy link
Contributor

MadLittleMods commented May 30, 2023

The use-case I'm envisioning is organizations running this archive for their own rooms, but not wanting to index every room accessible by the archive bot account.

If the goal is to keep the room out of a Matrix Public Archive instance, then it is probably better served by whatever solution we come up with in #47


Only allowing a small portion of rooms to be viewable from your Matrix Public Archive instance does sound like something viable for people who want to make their community accessible without making it a general archive client for everything else.

Depending on the exact use cases, this might be better served by a homeserver allowlist in combination with #47 to remove whatever rooms you don't want showing.

@jonaharagon
Copy link
Author

people who want to make their community accessible without making it a general archive client for everything else.

Right, that's exactly the use-case I'm thinking of. I don't think #47 is quite the same because that covers room owners opting-out of the archive, as opposed to public-archive admins opting-out of archiving a room. Maybe a homeserver allowlist makes more sense, but I don't know if people would want to limit every user on their homeserver, just the @archive bot account, and I don't know if per-user join limits are possible to do in synapse?

@jonaharagon
Copy link
Author

I think that my reading comprehension skills were not on point last week, if you meant an allowlist that only allows certain room directories from being enumerated by the public archive, that does make sense to me. (For some reason I thought you meant restricting which rooms the bot could join on the server side)

The only problem with a room directory allowlist would be having to check whether a room is listed in an allowed directory, because if Matrix HQ isn't listed in my homeserver's room directory, I don't want people to be able to manually visit the /r/matrix:matrix.org URL and make my bot join that room either. So a room allowlist may still make more sense from this perspective.

@Zocker1999NET Zocker1999NET linked a pull request Jul 27, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-Enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants