[!!!][TASK] Append hash to default log file name
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Documentation / Changelog / master / Breaking-52705-DefaultLogConfigurationIsChanged.rst
1 =======================================================
2 Breaking: #52705 - Default log configuration is changed
3 =======================================================
4
5 Description
6 ===========
7
8 FileWriter behavior has changed
9 -------------------------------
10
11 The FileWriter of the logging Framework now appends a hash to its default log file which is used when no log file
12 is provided in the configuration.
13
14 The new default log file might now look like this (the hash depends on the current encryption key):
15
16 ::
17
18         typo3temp/logs/typo3_7ac500bce5.log
19
20
21 Default configuration has changed
22 ---------------------------------
23
24 For security reasons we want the default log file of TYPO3 to contain a random hash to make guessing the file name harder.
25
26 Therefore the :code:`logFile` configuration is removed for the default :php:`FileWriter` configuration.
27
28 Additionally the "deprecated" :php:`FileWriter` configuration is removed because it is not used by the core.
29
30
31
32 Impact
33 ======
34
35 If the log file configuration is **not** overwritten the TYPO3 default log file will change from
36 :php:`typo3temp/logs/typo3.log` to :php:`typo3temp/logs/typo3_<hash>.log`.
37
38 Installations with Extensions making use of the changed / removed log configurations might break.
39
40
41 Affected Installations
42 ======================
43
44 All instances that expect the default log file to be :code:`typo3temp/logs/typo3.log` for some reason.
45
46 All instances that expect the :code:`logFile` configuration to be present in the :code:`writerConfiguration` for some reason.
47
48 All instances that use the "deprecated" log configuration in their Extensions.
49
50 All instances that use Extensions which extend the FileWriter and access the :php:`$defaultLogFile` class property
51 which is replaced by :php:`$defaultLogFileTemplate` and the :php:`getDefaultLogFileName()` method.
52
53
54 Migration
55 =========
56
57 Adjust the log configuration according to your needs in your :code:`AdditionalConfiguration.php`.
58
59 Adjust any Extension code affected by the changes if needed.