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

Email verification #78

Merged
merged 24 commits into from
Apr 18, 2022
Merged

Email verification #78

merged 24 commits into from
Apr 18, 2022

Conversation

luwol03
Copy link
Member

@luwol03 luwol03 commented Jan 26, 2022

Status Type Env Vars Change
✅ Ready Feature Yes (Breaking)

Description

This option adds an mailer which can send account confirmation links via email.

Configuration

To test this feature you can create an free ethereal email account without registration.

Ethereal is a fake SMTP service, mostly aimed at Nodemailer users (but not limited to). It's a completely free anti-transactional email service where messages never get delivered.
[Source]

{
  // ...
  server: {
    base_url: "http://localhost:5000",
    // ...
  },

  mailer: {
    enabled: true,
    host: 'smtp.ethereal.email',
    port: 587,
    auth: {
      user: '',
      pass: '',
    },
    from: '"Vocascan" <vocascan@example.com>',
  },

  service: {
    // invite_code: true, // server.registration_locked is moved and can be enabled ontop of the email verification
    email_confirm: true, // enable email confirmation
    email_confirm_live_time: '2h', // how long the verification token (link) is valid
    email_confirm_time: '2m', // how long the user can use vocascan without verifying his email
  },
}

Motivation and Context

Screenshots / GIFs (if appropriate):

Todo

  • swagger docs
  • verification level
  • add more nodemailer config options
  • dedicated request verification route
  • send verified on login
  • improve templates (style)
  • also send text email
  • directly verify user if verification is turned off
  • add disabled field to user in migration
  • check if user is already verified
  • move registration logged config var
  • token lifetimes
  • add default config
  • add mailcatcher for email debugging

Checklist

  • I have read the CONTRIBUTING document.
  • I have considered the accessibility of my changes (i.e. did I add proper content descriptions to images, or run my changes with talkback enabled?)
  • I have documented my code if needed

Resolves

@luwol03 luwol03 added this to the v1.3.0 milestone Jan 26, 2022
@luwol03 luwol03 self-assigned this Jan 26, 2022
@luwol03 luwol03 requested a review from noctera January 29, 2022 10:12
@luwol03 luwol03 requested a review from noctera April 2, 2022 17:58
Copy link
Member

@noctera noctera left a comment

Choose a reason for hiding this comment

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

Everything okay so far

@luwol03 luwol03 force-pushed the email-verification branch from 58f4741 to 1571145 Compare April 17, 2022 19:13
@luwol03 luwol03 merged commit 9b42dea into experimental Apr 18, 2022
@luwol03 luwol03 deleted the email-verification branch April 18, 2022 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🚀 Ready
Development

Successfully merging this pull request may close these issues.

2 participants