added email configuration docs (#228)

var/docs/README.md

@@ -2,20 +2,23 @@
 
 Welcome to the official Kimai v2 documentation. 
 
-The first chapters are meant for developers and administrators:
-
-- [Kimai configurations](configurations.md) - the Kimai core configurations, which can only be set in configuration files 
-- [Developer docu](developers.md) - information for developer who would like to extend Kimai  
-- [User and Security](users.md) - everything related to user and security, like authentication and roles  
-- [FAQ](faq.md) - some frequently asked questions and their with answers 
-- [Installation](installation.md) - instructions about several installation methods
-- [Importing data](migration_v1.md) - how to import your timesheets from Kimai v1
-
-The following chapters are meant for users:
-
-- [Timesheets](timesheet.md) - information about timesheets  
-
 We know there is a lot missing right now and would appreciate [any help](https://github.com/kevinpapst/kimai2/pulls) in writing. 
 If you need information which is not available right now, [ask us](https://github.com/kevinpapst/kimai2/issues) and we 
 try to add it as soon as possible. 
 
+## User manual
+
+For the most part Kimai usage should be self-explanatory, so we will only cover topics here which were 
+[requested](https://github.com/kevinpapst/kimai2/issues) by the community.
+
+- [Timesheets](timesheet.md) - information about timesheets  
+
+## Developers and Administrators
+
+- [Kimai configurations](configurations.md) - application configs, which can only be changed in config files 
+- [Developer docu](developers.md) - how to extend Kimai's feature set  
+- [User and Security](users.md) - docu for user and security topics, like authentication, registration and roles  
+- [FAQ](faq.md) - some answers to frequently asked questions 
+- [Installation](installation.md) - instructions about several installation methods
+- [Importing data](migration_v1.md) - how to import your timesheets from Kimai v1
+- [Emails](emails.md) - transport configuration and handling of emails 

var/docs/emails.md

@@ -0,0 +1,25 @@
+# Emails
+
+Kimai uses the [Swift MailerBundle](https://symfony.com/doc/current/email.html) for sending emails. 
+Please read their documentation, there are a lot of possible configuration settings that you might want to adapt to your needs.
+
+If not otherwise noted, all emails will be sent instantly (unless spooling is activated in `config/packages/swiftmailer.yaml`).
+
+## Activating email
+
+You have to adapt two settings in your `.env` [configuration file](configurations.md):
+
+- `MAILER_URL` - your smtp connection details for sending emails
+- `MAILER_FROM` - an application wide "from" address for all emails
+
+## All existing emails
+
+The following emails will be sent by Kimai:
+
+### Security related emails
+
+If you want to change the content of the emails, please have a look at the [FOSUserBundle config](../../config/packages/fos_user.yaml) 
+and its [documentation](https://symfony.com/doc/current/bundles/FOSUserBundle/emails.html).
+
+- Password reset 
+- Account approval (only if activated, see [User docu](users.md))

var/docs/users.md

@@ -35,7 +35,7 @@ Read the [configurations chapter](configurations.md) if you want to change the v
 ## User registration
 
 User registration with instant approval is activated by default, so users can register and will be able to login and start time-tracking instantly.
-If you want your new users to use email based activation, then change the following configuration:
+If you want your new users to use [email](emails.md) based activation, you need to change the following configuration:
 
 - in `config/packages/fos_user.yaml` change the setting `fos_user.registration.confirmation.enabled` to true (default: false)
 
@@ -46,7 +46,7 @@ If you want to deactivate the user registration completely, you have to change t
 
 ## Password reset
 
-The reset password function is enabled by default.
+The reset password function is enabled by default, read how to activate [email](emails.md) support.
 If you want to deactivate this feature you have to change the following configs:
 
 - in `config/packages/admin_lte.yaml` remove the route alias `admin_lte.routes.adminlte_password_reset` (this will remove the link from the login form)