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

Poorly Named Email Enabled Property #2053

Open
Crisfole opened this issue Mar 17, 2024 · 0 comments
Open

Poorly Named Email Enabled Property #2053

Crisfole opened this issue Mar 17, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@Crisfole
Copy link

Link

The Docs:
https://supabase.com/docs/guides/cli/config#auth.email.enable_signup

The Code:
https://github.com/supabase/cli/blob/develop/internal/start/start.go#L403

Describe the problem

Is the documentation missing? Or is it confusing? Why is it confusing?

The documentation is very confusing. It says, "Allow/disallow new user signups via email to your project.", but it is used to determine the value of utils.Config.Auth.Email.EnableSignup, which is actually used to set the GoTrue env variable GOTRUE_EXTERNAL_EMAIL_ENABLED. This is very different from signup enabled.

Describe the improvement

A clear and concise description of the improvement.

Honestly, I think the real solution is a breaking change, unfortunately: updating the variable name (and toml setup) to accurately reflect what the variable does. In the meantime thoroughly documenting the weird difference between the name and behavior would be a great start.

Additional context

Add any other context or screenshots that help clarify your question.

None, really.

@sweatybridge sweatybridge added the bug Something isn't working label Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants