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

docs/registering-users.md recommends matrix-registration, poorly maintained component #3603

Open
luixxiul opened this issue Oct 15, 2024 · 4 comments
Labels
bug docs This issue is related to documentation

Comments

@luixxiul
Copy link
Collaborator

Describe the bug

docs/registering-users.md says:

If you'd rather **keep your server private** (public registration closed, as is the default), and **let certain people create accounts by themselves** (instead of creating user accounts manually like this), consider installing and making use of [matrix-registration](configuring-playbook-matrix-registration.md).

But docs/configuring-playbook-matrix-registration.md says:

**WARNING**: this is a poorly maintained and buggy project. It's better to avoid using it.

It is confusing that matrix-registration is recommended on one page and not on another.

To Reproduce
Irrelevant

Expected behavior
matrix-registration should not be recommended on registering-users.md. Another component should be recommended instead.

Matrix Server:
Irrelevant

Ansible:
Irrelevant

Client:
Irrelevant

Additional context

@luixxiul luixxiul changed the title docs/registering-users.md recommends matrix-registration, unmaintained component docs/registering-users.md recommends matrix-registration, poorly maintained component Oct 17, 2024
@luixxiul
Copy link
Collaborator Author

I think matrix-registration-bot (not matrix-registration) should able to be suggested here instead.

@aine-etke
Copy link
Collaborator

matrix-registration-bot does not fully replace matrix-registration. The missing functionality is a web page where users can register on their own (matrix-registration has it, but -bot doesn't).

-bot works using matrix native invite tokens, i.e. it's an alternative to synapse-admin's token management in that case, not to the custom tokens (and custom web page) of matrix-registration.

So, the better approach will be mention synapse admin and matrix-registration-bot in that section, with link to matrix native invite tokens in the spec

@luixxiul
Copy link
Collaborator Author

Thanks. I am not perfectly confident that I could understand that well, so I would like to defer the task to address the issue to another contributor.

@spantaleev
Copy link
Owner

I'd say matrix-registration is poorly maintained (and newer versions are not packaged in a way that can be made use of), but it's still the best we have now.

I've never personally used the registration bot.

@luixxiul luixxiul added bug docs This issue is related to documentation labels Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug docs This issue is related to documentation
Projects
None yet
Development

No branches or pull requests

3 participants