Commit c2cc7ffe authored by Carsten  Rose's avatar Carsten Rose
Browse files

Merge branch 'marcDocumentationNewLogPath' into 'develop'

Documentation: Correct mentions of default log path.

See merge request !347
parents 8d89fc77 7fab8aed
Pipeline #5244 passed with stages
in 3 minutes and 9 seconds
......@@ -221,10 +221,11 @@ Display QFQ log files in realtime. Put the following code in a QFQ page content
# Show selected log file.
100 {
sql = SELECT 'file:fileadmin/protected/log/{{logfile:R}}' AS _monitor
sql = SELECT 'file:{{qfqProjectPath:Y}}/log/{{logfile:R}}' AS _monitor
head = <pre id="monitor-1">Please wait</pre>
}
**NOTE**: The `log` directory has been moved into `qfqProject` with a recent upgrade of QFQ. For backwards compatibility logs are still stored in `fileadmin/protected/log/` if that directory already exists.
.. _`form-submit-log-page`:
......
......@@ -67,7 +67,9 @@ Procedure to Find an Irreproducible Error
* qfq.log
* location: fileadmin/protected/log/qfq.log
* location: fileadmin/protected/qfqProject/log/qfq.log
* **NOTE**: The `log` directory has been moved into `qfqProject` with a recent upgrade of QFQ. For backwards compatibility logs are still stored in `fileadmin/protected/log/` if that directory already exists.
* Look for error messages which were sent to the user at that time. (search for user-name in file)
* Look at actions performed during the time of Error
......
......@@ -173,9 +173,11 @@ Send Email
QFQ sends mail via `sendEmail` http://caspian.dotconf.net/menu/Software/SendEmail/ - a small perl script without a central
configuration.
By default, `sendEmail` uses the local installed MTA, writes a logfile to `fileadmin/protected/log/mail.log` and handles attachments
By default, `sendEmail` uses the local installed MTA, writes a logfile to `fileadmin/protected/qfqProject/log/mail.log` and handles attachments
via commandline options. A basic HTML email support is implemented.
**NOTE**: The `log` directory has been moved into `qfqProject` with a recent upgrade of QFQ. For backwards compatibility logs are still stored in `fileadmin/protected/log/` if that directory already exists.
The latest version is v1.56, which has at least one bug. That one is patched in the QFQ internal version v1.56p1 (see
QFQ GIT sources in directory 'patches/sendEmail.patch').
......@@ -284,7 +286,7 @@ Installation: Check List
* Protect the directory `<T3 installation>/fileadmin/protected` in Apache against direct file access.
* `<T3 installation>/fileadmin/protected/` should be used for confidential (uploaded / generated) data.
* `<T3 installation>/fileadmin/protected/log/...` is the default place for QFQ log files.
* `<T3 installation>/fileadmin/protected/qfqProject/log/...` is the default place for QFQ log files.
* Protect the directory `<T3 installation>/fileadmin` in Apache to not execute PHP Scripts - malicious uploads won't be executed.
* Setup a log rotation rule for `sqlLog`.
......@@ -455,13 +457,13 @@ Extension Manager: QFQ Configuration
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sqlLogModeAutoCron | error | Applies only to AutoCron Jobs. For production 'error' should be fine. |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sqlLog | fileadmin/protected/log/sql.log | Filename to log SQL commands: relative to <site path> or absolute. If the |
| sqlLog | fileadmin/protected/qfqProject/log/sql.log | Filename to log SQL commands: relative to <site path> or absolute. If the |
| | | directory does not exist, create it. |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| qfqLog | fileadmin/protected/log/qfq.log | Filename to log general QFQ events:relative to <site path> or absolute. |
| qfqLog | fileadmin/protected/qfqProject/log/qfq.log | Filename to log general QFQ events:relative to <site path> or absolute. |
| | | If the directory does not exist, create it. |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| mailLog | fileadmin/protected/log/mail.log | Filename to log `sendEmail` commands: relative to <site path> or absolute. |
| mailLog | fileadmin/protected/qfqProject/log/mail.log | Filename to log `sendEmail` commands: relative to <site path> or absolute. |
| | | If the directory does not exist, create it. |
+-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| showDebugInfo | auto | FE - Possible values: yes|no|auto|download. For 'auto': If a BE User is |
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment