vocascan / vocascan-server

Server for Vocascan
https://vocascan.com
Apache License 2.0
26 stars 5 forks source link

Email verification #78

Closed luwol03 closed 2 years ago

luwol03 commented 2 years ago
Status Type Env Vars Change
:white_check_mark: 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

Checklist

Resolves