diff --git a/var/docs/emails.md b/var/docs/emails.md index f5604263..26768dd3 100644 --- a/var/docs/emails.md +++ b/var/docs/emails.md @@ -23,3 +23,31 @@ and its [documentation](https://symfony.com/doc/current/bundles/FOSUserBundle/em - Password reset - Account approval (only if activated, see [User docu](users.md)) + +## Troubleshooting + +You can test your email configuration with the command `bin/console -vv swiftmailer:email:send`, which will ask you for all required fields: +- `to` +- `from` +- `subject` +- `body` + +The email will be sent using the transport from your configured `MAILER_URL`. + +### SMTP does not accept emails + +If you have the following error in your logfile: +``` +app.ERROR: Exception occurred while flushing email queue: Expected response code 354 but got code "503", with message "503-All RCPT commands were rejected with this error: 503-R1: HELO should be a FQDN or address literal (See RFC 2821 4.1.1.1) 503 Valid RCPT command must precede DATA " [] [] +``` +you might suffer from a wrong configuration (read the documentation linked above) and try a full featured SMTP URL with a dedicated user account for authentication: +``` +MAILER_URL=smtp://kimai@example.compassword@mx.example.com:587?encryption=tls&auth_mode=plain +``` + +If that still doesn't help , try to set a `local_domain` in the file `config/packages/local.yaml`: +```yaml +swiftmailer: + local_domain: 'kimai.local' +``` +This `local_domain` will be used for the `HELO` command when SwiftMailer contacts your SMTP. \ No newline at end of file diff --git a/var/docs/faq.md b/var/docs/faq.md index 38d40910..3e99007e 100644 --- a/var/docs/faq.md +++ b/var/docs/faq.md @@ -1,5 +1,10 @@ # Frequently asked questions +## I have a problem + +Please open a new issue at [GitHub](https://github.com/kevinpapst/kimai2/issues/). +Add the last entries from your logfile at `var/log/prod.log`. + ## I have only FTP available ... So you want to install Kimai v2 but have no SSH access to your server? diff --git a/var/docs/timesheet.md b/var/docs/timesheet.md index ebee0f0e..75e2a284 100644 --- a/var/docs/timesheet.md +++ b/var/docs/timesheet.md @@ -4,7 +4,23 @@ User manual on the timesheet tables and actions. Kimai 2 provides also a [calendar view](calendar.md), which displays your timesheet entries in an easy readable format. -## Duration only +## Starting records + +You can start new timesheet records like so: +- Click the **redo** button in the "last activities" dropdown in the upper toolbar +- Click the **redo** button from one of the activities in your timesheet +- Start a completely new activity, by clicking the big **play** button in the toolbar + +The same goes for running time-records: top them with one-click from the timesheet or from the "running entries" dropdown. + +## Stopping records + +You can stop timesheet records like so: +- Click the **stop** button in the "active records" dropdown in the upper toolbar +- Click the **stop** button from one of the running activities in your timesheet +- Edit a running activity, add an end date and save + +## Duration only mode When the `duration_only` mode is activated, you will only see the `date` and `duration` fields (see [configurations chapter](configurations.md)). @@ -40,9 +56,9 @@ While calculating the rate of a timesheet entry, the first setting that is found - Users hourly rate If neither a fixed nor a hourly rate can be found, the users rate will be used to calculate the records rate. -In that case and the users rate is not set or equals 0, the records rate will be set to 0. +If that is the case and if the users rate is not set or equals 0, the records rate will be set to 0. -The calculation is based on the following formular: +The calculation is based on the following formula: - __Fixed rate__: `$fixedRate` - __Hourly rate__: `$hourlyRate * ($durationInSeconds / 3600) * $factor`