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: Update Google SMTP Setup to Use Application-Specific Passwords #1046

Merged

Conversation

Abdul-Muqadim-Arbisoft
Copy link
Contributor

Resolved #1025
This pull request updates the documentation for setting up Google Mail as an SMTP server in Tutor. It replaces the deprecated "Less Secure Apps" access method with "Application-Specific Passwords" as recommended by Google for enhanced security.

Key Changes:

  • Removed instructions related to enabling "Less Secure App Access," which Google has deprecated.
  • Added detailed steps to set up "Application-Specific Passwords," including enabling 2-Step Verification and generating a secure 16-digit password.
  • Included links to Google's official support page for creating app-specific passwords and a relevant discussion from the Open edX community forum that highlights issues related to SMTP setup.

@Abdul-Muqadim-Arbisoft Abdul-Muqadim-Arbisoft added the documentation In order to close this issue, some documentation should be improved label Apr 22, 2024
@Abdul-Muqadim-Arbisoft Abdul-Muqadim-Arbisoft changed the title Update Google SMTP Setup to Use Application-Specific Passwords docs: Update Google SMTP Setup to Use Application-Specific Passwords Apr 22, 2024
You should authorize third-party to access your Google Mail account. In your Google Mail account, select "Manage Account", "Security", and turn on "Less Secure App Access". Check the Google documentation for more information on "less secure apps": https://support.google.com/accounts/answer/6010255
Authorization for Third-Party Access :

Google has deprecated the "Less Secure App Access." Instead, it is recommended to use "Application-Specific Passwords" for more secure access:
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Instead of directly starting with this deprecation sentence "Less Secure App Access.", the doc can specify this was an old way of doing but has been deprecated. Or if this has been deprecated entirely, we can remove this altogether.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

concern addressed

Comment on lines 13 to 18
1. Ensure 2-Step Verification is enabled on your Google Account.
2. Visit Google Account Security.
3. Under "Signing in to Google," choose "App passwords."
4. You might need to sign in again. Once you do, select "Select app" and choose "Other (Custom name)" from the dropdown.
5. Enter a name that helps you remember the purpose of this password, like "Tutor SMTP".
6. Generate and note your 16-character app-specific password.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please reduce the usage of "you, your" pronouns in sentences where possible.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

concern addressed

Comment on lines 11 to 12
To enhance security, Google recommends the use of "Application-Specific Passwords" for third-party access to Google services:

Copy link
Contributor

Choose a reason for hiding this comment

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

After Google recommends the use of "Application-Specific Passwords" for third-party access to Google services., let's add a small sentence to emphasize on following the steps to enable the feature.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

concern addressed


To enhance security, Google recommends the use of "Application-Specific Passwords" for third-party access to Google services:

1. Activation of 2-Step Verification is required for the Google Account.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Activate 2-step verification for Google Account.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed

Copy link
Contributor

@DawoudSheraz DawoudSheraz left a comment

Choose a reason for hiding this comment

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

Some small nits, otherwise 👍🏽

@DawoudSheraz DawoudSheraz merged commit 14612dd into overhangio:master Apr 30, 2024
2 checks passed
@DawoudSheraz DawoudSheraz deleted the muqadim/update-google-smtp-security branch April 30, 2024 07:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation In order to close this issue, some documentation should be improved
Projects
Development

Successfully merging this pull request may close these issues.

Documentation update: Gmail SMTP settings
2 participants