Add GMail note in CONTRIBUTING.md

Fri, 22 Sep 2017 09:27:33 +0200

author
David Demelier <markand@malikania.fr>
date
Fri, 22 Sep 2017 09:27:33 +0200
changeset 15
90a1769a651a
parent 14
55bb3689093f
child 16
780c138ab41d

Add GMail note in CONTRIBUTING.md

CONTRIBUTE.md file | annotate | diff | comparison | revisions
--- a/CONTRIBUTE.md	Fri Sep 08 11:26:27 2017 +0200
+++ b/CONTRIBUTE.md	Fri Sep 22 09:27:33 2017 +0200
@@ -42,8 +42,13 @@
 
     [smtp]
     host = yourdomain.tld
-    port = 25
+    port = 587
     tls = starttls
+    username = your_account
+    password = your_password
+
+Note: the password is optional, if not set it will be asked each time you run
+the `hg email command`.
 
 More options are available, see:
 
@@ -52,6 +57,25 @@
   - `hg help patchbomb`
   - `hg help email`
 
+### Note to GMail users
+
+By default, your GMail account may use 2-step authentication which causes
+troubles with the `hg email` command, you must create a specific application
+password.
+
+  1. Go to https://security.google.com/settings/security/apppasswords
+  2. Create an application password, it will be auto generated,
+  3. Use this password or store it directly in the `smtp.password` option.
+
+Use the following settings:
+
+    [smtp]
+    host = gmail.com
+    port = 587
+    tls = starttls
+    username = your_account@gmail.com
+    password = the_generated_application_password
+
 Create your patch
 -----------------
 

mercurial