Changeset - a5ad2900985b
Parent rev.
Child rev.
[Not reviewed]
default
0 5 0
Mads Kiilerich - 10 years ago 2016-05-04 01:18:25
madski@unity3d.com
docs: tweak email documentation - add gmail example

smtp_auth is too obscure to have in the .ini template.
5 files changed with 31 insertions and 26 deletions:
development.ini
5
6
docs/usage/email.rst
11
2
kallithea/bin/template.ini.mako
5
6
kallithea/config/deployment.ini_tmpl
5
6
kallithea/tests/test.ini
5
6
0 comments (0 inline, 0 general)
development.ini
➞
Show inline comments
 
@@ -34,59 +34,58 @@ pdebug = false
 
## Subject prefix for application emails.
 
## A space between this prefix and the real subject is automatically added.
 
## Default:
 
#email_prefix =
 
## Example:
 
#email_prefix = [Kallithea]
 

			




	
	
	
		
 
## Recipients for error emails and fallback recipients of application mails.

			




	
	
	
		
 
## Multiple addresses can be specified, space-separated.

			




	
	
	
		
 
## Only addresses are allowed, do not add any name part.

			




	
	
	
		
 
## Default:

			




	
	
	
		
 
#email_to =

			




	
	
	
		
 
## Examples:

			




	
	
	
		
 
#email_to = admin@example.com

			




	
	
	
		
 
#email_to = admin@example.com another_admin@example.com

			




	
	
	
		
 

			




	
	
	
		
 
## 'From' header for error emails. You can optionally add a name.

			




	
	
	
		
 
## Default:

			




	
	
	
		
 
#error_email_from = pylons@yourapp.com

			




	
	
	
		
 
## Examples:

			




	
	
	
		
 
#error_email_from = Kallithea Errors <kallithea-noreply@example.com>

			




	
	
	
		
 
#error_email_from = paste_error@example.com

			




	
	
	
		
 

			




	
	
	
		
 
## SMTP server settings

			




	
	
	
		
 
## Only smtp_server is mandatory. All other settings take the specified default

			




	
	
	
		
 
## values.

			




	
	
	
		
 
## If specifying credentials, make sure to use secure connections.

			




	
	
	
		
 
## Default: Send unencrypted unauthenticated mails to the specified smtp_server.

			




	
	
	
		
 
## For "SSL", use smtp_use_ssl = true and smtp_port = 465.

			




	
	
	
		
 
## For "STARTTLS", use smtp_use_tls = true and smtp_port = 587.

			




	
	
	
		
 
#smtp_server = smtp.example.com

			




	
	
	
		
 
#smtp_username =

			




	
	
	
		
 
#smtp_password =

			




	
	
	
		
 
#smtp_port = 25

			




	
	
	
		
 
#smtp_use_ssl = false

			




	
	
	
		
 
#smtp_use_tls = false

			




	
	
	
		
 
#smtp_use_ssl = false

			




	
	
	
		
 
## SMTP authentication parameters to use (e.g. LOGIN PLAIN CRAM-MD5, etc.).

			




	
	
	
		
 
## If empty, use any of the authentication parameters supported by the server.

			




	
	
	
		
 
#smtp_auth =

			




	
	
	
		
 

			




	
	
	
		
 
[server:main]

			




	
	
	
		
 
## PASTE ##

			




	
	
	
		
 
#use = egg:Paste#http

			




	
	
	
		
 
## nr of worker threads to spawn

			




	
	
	
		
 
#threadpool_workers = 5

			




	
	
	
		
 
## max request before thread respawn

			




	
	
	
		
 
#threadpool_max_requests = 10

			




	
	
	
		
 
## option to use threads of process

			




	
	
	
		
 
#use_threadpool = true

			




	
	
	
		
 

			




	
	
	
		
 
## WAITRESS ##

			




	
	
	
		
 
use = egg:waitress#main

			




	
	
	
		
 
## number of worker threads

			




	
	
	
		
 
threads = 5

			




	
	
	
		
 
## MAX BODY SIZE 100GB

			




	
	
	
		
 
max_request_body_size = 107374182400

			




	
	
	
		
 
## use poll instead of select, fixes fd limits, may not work on old

			




	
	
	
		
 
## windows systems.

			




	
	
	
		
 
#asyncore_use_poll = True

			




	
	
	
		
 

			




	
	
	
		
 
## GUNICORN ##

			




	
	
	
		
 
#use = egg:gunicorn#main

			




	
	
	
		
 
## number of process workers. You must set `instance_id = *` when this option

			




        

    


    
    

    

        

                

                    docs/usage/email.rst
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
	
		
 
.. _email:

			




	
	
	
		
 

			




	
	
	
		
 
==============

			




	
	
	
		
 
Email settings

			




	
	
	
		
 
==============

			




	
	
	
		
 

			




	
	
	
		
 
The Kallithea configuration file has several email related settings. When

			




	
	
	
		
 
these contain correct values, Kallithea will send email in the situations

			




	
	
	
		
 
described below. If the email configuration is not correct so that emails

			




	
	
	
		
 
cannot be sent, all mails will show up in the log output.

			




	
	
	
		
 

			




	
	
	
		
 
Before any email can be sent, an SMTP server has to be configured using the

			




	
	
	
		
 
configuration file setting ``smtp_server``. If required for that server, specify

			




	
	
	
		
 
a username (``smtp_username``) and password (``smtp_password``), a non-standard

			




	
	
	
		
 
port (``smtp_port``), encryption settings (``smtp_use_tls`` or ``smtp_use_ssl``)

			




	
	
	
		
 
and/or specific authentication parameters (``smtp_auth``).

			




	
	
	
		
 
port (``smtp_port``), whether to use "SSL" when connecting (``smtp_use_ssl``)

			




	
	
	
		
 
or use STARTTLS (``smtp_use_tls``), and/or specify special ESMTP "auth" features

			




	
	
	
		
 
(``smtp_auth``).

			




	
	
	
		
 

			




	
	
	
		
 
For example, for sending through gmail, use::

			




	
	
	
		
 

			




	
	
	
		
 
    smtp_server = smtp.gmail.com

			




	
	
	
		
 
    smtp_username = username

			




	
	
	
		
 
    smtp_password = password

			




	
	
	
		
 
    smtp_port = 465

			




	
	
	
		
 
    smtp_use_ssl = true

			




	
	
	
		
 

			




	
	
	
		
 

			




	
	
	
		
 
Application emails

			




	
	
	
		
 
------------------

			




	
	
	
		
 

			




	
	
	
		
 
Kallithea sends an email to `users` on several occasions:

			




	
	
	
		
 

			




	
	
	
		
 
- when comments are given on one of their changesets

			




	
	
	
		
 
- when comments are given on changesets they are reviewer on or on which they

			




	
	
	
		
 
  commented regardless

			




	
	
	
		
 
- when they are invited as reviewer in pull requests

			




	
	
	
		
 
- when they request a password reset

			




	
	
	
		
 

			




	
	
	
		
 
Kallithea sends an email to all `administrators` upon new account registration.

			




	
	
	
		
 
Administrators are users with the ``Admin`` flag set on the *Admin > Users*

			




	
	
	
		
 
page.

			




	
	
	
		
 

			




	
	
	
		
 
When Kallithea wants to send an email but due to an error cannot correctly

			




	
	
	
		
 
determine the intended recipients, the administrators and the addresses

			




	
	
	
		
 
specified in ``email_to`` in the configuration file are used as fallback.

			




	
	
	
		
 

			




	
	
	
		
 
Recipients will see these emails originating from the sender specified in the

			




	
	
	
		
 
``app_email_from`` setting in the configuration file. This setting can either

			




	
	
	
		
 
contain only an email address, like `kallithea-noreply@example.com`, or both

			




        

    


    
    

    

        

                

                    kallithea/bin/template.ini.mako
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -28,59 +28,58 @@ pdebug = false

			




	
	
	
		
 
<%text>## Subject prefix for application emails.</%text>

			




	
	
	
		
 
<%text>## A space between this prefix and the real subject is automatically added.</%text>

			




	
	
	
		
 
<%text>## Default:</%text>

			




	
	
	
		
 
#email_prefix =

			




	
	
	
		
 
<%text>## Example:</%text>

			




	
	
	
		
 
#email_prefix = [Kallithea]

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## Recipients for error emails and fallback recipients of application mails.</%text>

			




	
	
	
		
 
<%text>## Multiple addresses can be specified, space-separated.</%text>

			




	
	
	
		
 
<%text>## Only addresses are allowed, do not add any name part.</%text>

			




	
	
	
		
 
<%text>## Default:</%text>

			




	
	
	
		
 
#email_to =

			




	
	
	
		
 
<%text>## Examples:</%text>

			




	
	
	
		
 
#email_to = admin@example.com

			




	
	
	
		
 
#email_to = admin@example.com another_admin@example.com

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## 'From' header for error emails. You can optionally add a name.</%text>

			




	
	
	
		
 
<%text>## Default:</%text>

			




	
	
	
		
 
#error_email_from = pylons@yourapp.com

			




	
	
	
		
 
<%text>## Examples:</%text>

			




	
	
	
		
 
#error_email_from = Kallithea Errors <kallithea-noreply@example.com>

			




	
	
	
		
 
#error_email_from = paste_error@example.com

			




	
	
	
		
 

			




	
	
	
		
 
<%text>## SMTP server settings</%text>

			




	
	
	
		
 
<%text>## Only smtp_server is mandatory. All other settings take the specified default</%text>

			




	
	
	
		
 
<%text>## values.</%text>

			




	
	
	
		
 
<%text>## If specifying credentials, make sure to use secure connections.</%text>

			




	
	
	
		
 
<%text>## Default: Send unencrypted unauthenticated mails to the specified smtp_server.</%text>

			




	
	
	
		
 
<%text>## For "SSL", use smtp_use_ssl = true and smtp_port = 465.</%text>

			




	
	
	
		
 
<%text>## For "STARTTLS", use smtp_use_tls = true and smtp_port = 587.</%text>

			




	
	
	
		
 
#smtp_server = smtp.example.com

			




	
	
	
		
 
#smtp_username =

			




	
	
	
		
 
#smtp_password =

			




	
	
	
		
 
#smtp_port = 25

			




	
	
	
		
 
#smtp_use_ssl = false

			




	
	
	
		
 
#smtp_use_tls = false

			




	
	
	
		
 
#smtp_use_ssl = false

			




	
	
	
		
 
<%text>## SMTP authentication parameters to use (e.g. LOGIN PLAIN CRAM-MD5, etc.).</%text>

			




	
	
	
		
 
<%text>## If empty, use any of the authentication parameters supported by the server.</%text>

			




	
	
	
		
 
#smtp_auth =

			




	
	
	
		
 

			




	
	
	
		
 
[server:main]

			




	
	
	
		
 
%if http_server == 'paste':

			




	
	
	
		
 
<%text>## PASTE ##</%text>

			




	
	
	
		
 
use = egg:Paste#http

			




	
	
	
		
 
<%text>## nr of worker threads to spawn</%text>

			




	
	
	
		
 
threadpool_workers = 5

			




	
	
	
		
 
<%text>## max request before thread respawn</%text>

			




	
	
	
		
 
threadpool_max_requests = 10

			




	
	
	
		
 
<%text>## option to use threads of process</%text>

			




	
	
	
		
 
use_threadpool = true

			




	
	
	
		
 

			




	
	
	
		
 
%elif http_server == 'waitress':

			




	
	
	
		
 
<%text>## WAITRESS ##</%text>

			




	
	
	
		
 
use = egg:waitress#main

			




	
	
	
		
 
<%text>## number of worker threads</%text>

			




	
	
	
		
 
threads = 5

			




	
	
	
		
 
<%text>## MAX BODY SIZE 100GB</%text>

			




	
	
	
		
 
max_request_body_size = 107374182400

			




	
	
	
		
 
<%text>## use poll instead of select, fixes fd limits, may not work on old</%text>

			




	
	
	
		
 
<%text>## windows systems.</%text>

			




	
	
	
		
 
#asyncore_use_poll = True

			




	
	
	
		
 

			




	
	
	
		
 
%elif http_server == 'gunicorn':

			




        

    


    
    

    

        

                

                    kallithea/config/deployment.ini_tmpl
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -29,59 +29,58 @@ pdebug = false

			




	
	
	
		
 
## Subject prefix for application emails.

			




	
	
	
		
 
## A space between this prefix and the real subject is automatically added.

			




	
	
	
		
 
## Default:

			




	
	
	
		
 
#email_prefix =

			




	
	
	
		
 
## Example:

			




	
	
	
		
 
#email_prefix = [Kallithea]

			




	
	
	
		
 

			




	
	
	
		
 
## Recipients for error emails and fallback recipients of application mails.

			




	
	
	
		
 
## Multiple addresses can be specified, space-separated.

			




	
	
	
		
 
## Only addresses are allowed, do not add any name part.

			




	
	
	
		
 
## Default:

			




	
	
	
		
 
#email_to =

			




	
	
	
		
 
## Examples:

			




	
	
	
		
 
#email_to = admin@example.com

			




	
	
	
		
 
#email_to = admin@example.com another_admin@example.com

			




	
	
	
		
 

			




	
	
	
		
 
## 'From' header for error emails. You can optionally add a name.

			




	
	
	
		
 
## Default:

			




	
	
	
		
 
#error_email_from = pylons@yourapp.com

			




	
	
	
		
 
## Examples:

			




	
	
	
		
 
#error_email_from = Kallithea Errors <kallithea-noreply@example.com>

			




	
	
	
		
 
#error_email_from = paste_error@example.com

			




	
	
	
		
 

			




	
	
	
		
 
## SMTP server settings

			




	
	
	
		
 
## Only smtp_server is mandatory. All other settings take the specified default

			




	
	
	
		
 
## values.

			




	
	
	
		
 
## If specifying credentials, make sure to use secure connections.

			




	
	
	
		
 
## Default: Send unencrypted unauthenticated mails to the specified smtp_server.

			




	
	
	
		
 
## For "SSL", use smtp_use_ssl = true and smtp_port = 465.

			




	
	
	
		
 
## For "STARTTLS", use smtp_use_tls = true and smtp_port = 587.

			




	
	
	
		
 
#smtp_server = smtp.example.com

			




	
	
	
		
 
#smtp_username =

			




	
	
	
		
 
#smtp_password =

			




	
	
	
		
 
#smtp_port = 25

			




	
	
	
		
 
#smtp_use_ssl = false

			




	
	
	
		
 
#smtp_use_tls = false

			




	
	
	
		
 
#smtp_use_ssl = false

			




	
	
	
		
 
## SMTP authentication parameters to use (e.g. LOGIN PLAIN CRAM-MD5, etc.).

			




	
	
	
		
 
## If empty, use any of the authentication parameters supported by the server.

			




	
	
	
		
 
#smtp_auth =

			




	
	
	
		
 

			




	
	
	
		
 
[server:main]

			




	
	
	
		
 
## PASTE ##

			




	
	
	
		
 
#use = egg:Paste#http

			




	
	
	
		
 
## nr of worker threads to spawn

			




	
	
	
		
 
#threadpool_workers = 5

			




	
	
	
		
 
## max request before thread respawn

			




	
	
	
		
 
#threadpool_max_requests = 10

			




	
	
	
		
 
## option to use threads of process

			




	
	
	
		
 
#use_threadpool = true

			




	
	
	
		
 

			




	
	
	
		
 
## WAITRESS ##

			




	
	
	
		
 
use = egg:waitress#main

			




	
	
	
		
 
## number of worker threads

			




	
	
	
		
 
threads = 5

			




	
	
	
		
 
## MAX BODY SIZE 100GB

			




	
	
	
		
 
max_request_body_size = 107374182400

			




	
	
	
		
 
## use poll instead of select, fixes fd limits, may not work on old

			




	
	
	
		
 
## windows systems.

			




	
	
	
		
 
#asyncore_use_poll = True

			




	
	
	
		
 

			




	
	
	
		
 
## GUNICORN ##

			




	
	
	
		
 
#use = egg:gunicorn#main

			




	
	
	
		
 
## number of process workers. You must set `instance_id = *` when this option

			




        

    


    
    

    

        

                

                    kallithea/tests/test.ini
                

                

                  
                      
                        

                      ➞

                      
                        
                  

                  
                      
                  
                      
                  
                      
                  
                      
                  
                  
                

                

                    Show inline comments
                    
                

        

        

            



	
	
		
 
@@ -32,59 +32,58 @@ pdebug = false

			




	
	
	
		
 
## Subject prefix for application emails.

			




	
	
	
		
 
## A space between this prefix and the real subject is automatically added.

			




	
	
	
		
 
## Default:

			




	
	
	
		
 
#email_prefix =

			




	
	
	
		
 
## Example:

			




	
	
	
		
 
#email_prefix = [Kallithea]

			




	
	
	
		
 

			




	
	
	
		
 
## Recipients for error emails and fallback recipients of application mails.

			




	
	
	
		
 
## Multiple addresses can be specified, space-separated.

			




	
	
	
		
 
## Only addresses are allowed, do not add any name part.

			




	
	
	
		
 
## Default:

			




	
	
	
		
 
#email_to =

			




	
	
	
		
 
## Examples:

			




	
	
	
		
 
#email_to = admin@example.com

			




	
	
	
		
 
#email_to = admin@example.com another_admin@example.com

			




	
	
	
		
 

			




	
	
	
		
 
## 'From' header for error emails. You can optionally add a name.

			




	
	
	
		
 
## Default:

			




	
	
	
		
 
#error_email_from = pylons@yourapp.com

			




	
	
	
		
 
## Examples:

			




	
	
	
		
 
#error_email_from = Kallithea Errors <kallithea-noreply@example.com>

			




	
	
	
		
 
#error_email_from = paste_error@example.com

			




	
	
	
		
 

			




	
	
	
		
 
## SMTP server settings

			




	
	
	
		
 
## Only smtp_server is mandatory. All other settings take the specified default

			




	
	
	
		
 
## values.

			




	
	
	
		
 
## If specifying credentials, make sure to use secure connections.

			




	
	
	
		
 
## Default: Send unencrypted unauthenticated mails to the specified smtp_server.

			




	
	
	
		
 
## For "SSL", use smtp_use_ssl = true and smtp_port = 465.

			




	
	
	
		
 
## For "STARTTLS", use smtp_use_tls = true and smtp_port = 587.

			




	
	
	
		
 
#smtp_server = smtp.example.com

			




	
	
	
		
 
#smtp_username =

			




	
	
	
		
 
#smtp_password =

			




	
	
	
		
 
#smtp_port = 25

			




	
	
	
		
 
#smtp_use_ssl = false

			




	
	
	
		
 
#smtp_use_tls = false

			




	
	
	
		
 
#smtp_use_ssl = false

			




	
	
	
		
 
## SMTP authentication parameters to use (e.g. LOGIN PLAIN CRAM-MD5, etc.).

			




	
	
	
		
 
## If empty, use any of the authentication parameters supported by the server.

			




	
	
	
		
 
#smtp_auth =

			




	
	
	
		
 

			




	
	
	
		
 
[server:main]

			




	
	
	
		
 
## PASTE ##

			




	
	
	
		
 
#use = egg:Paste#http

			




	
	
	
		
 
## nr of worker threads to spawn

			




	
	
	
		
 
#threadpool_workers = 5

			




	
	
	
		
 
## max request before thread respawn

			




	
	
	
		
 
#threadpool_max_requests = 10

			




	
	
	
		
 
## option to use threads of process

			




	
	
	
		
 
#use_threadpool = true

			




	
	
	
		
 

			




	
	
	
		
 
## WAITRESS ##

			




	
	
	
		
 
use = egg:waitress#main

			




	
	
	
		
 
## number of worker threads

			




	
	
	
		
 
threads = 5

			




	
	
	
		
 
## MAX BODY SIZE 100GB

			




	
	
	
		
 
max_request_body_size = 107374182400

			




	
	
	
		
 
## use poll instead of select, fixes fd limits, may not work on old

			




	
	
	
		
 
## windows systems.

			




	
	
	
		
 
#asyncore_use_poll = True

			




	
	
	
		
 

			




	
	
	
		
 
## GUNICORN ##

			




	
	
	
		
 
#use = egg:gunicorn#main

			




	
	
	
		
 
## number of process workers. You must set `instance_id = *` when this option

			




        

    



    


    



    



      

      





    
    0 comments (0 inline, 0 general)
    





    


  

  







  


    




    








    
        
    
    
        This site is powered by
            Kallithea 0.7.0,
        which is
        © 2010–2025 by various authors & licensed under GPLv3.