Skip to content

Commit ea0cdd4

Browse files
committed
Updating troubleshoot page
1 parent fb2f477 commit ea0cdd4

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

docs/desktop/troubleshooting.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,35 @@ This page contains solutions for common issues you might encounter when using Cr
1010

1111
## Log File Locations {#log-file-locations}
1212

13-
Cryptomator creates log files to help with troubleshooting when issues occur. The default locations for these log files vary by operating system:
13+
Cryptomator creates log files to help with troubleshooting when issues occur.
14+
The default locations for these log files vary by operating system:
1415

1516
| Operating System | Default Log File Location |
1617
| :--------------- | :------------------------------------------- |
17-
| Windows | `%appdata%\Cryptomator\cryptomator.log` |
18-
| macOS | `~/Library/Logs/Cryptomator/cryptomator.log` |
19-
| Linux | `~/.Cryptomator/cryptomator.log` |
18+
| Windows | `%localappdata%\Cryptomator\` |
19+
| macOS | `~/Library/Logs/Cryptomator/` |
20+
| Linux | `~/.local/share/Cryptomator/logs/` |
21+
22+
The log files are named with the pattern `cryptomatorX.log`, where `X` is a number from 0 to 9.
23+
The most recent log file is always `cryptomator0.log`.
2024

21-
You can change the log file directory by setting the `cryptomator.logDir` property in the [advanced configuration](advanced-settings.md). This allows you to store log files in a custom location if needed.
2225

2326
## Debug Mode {#debug-mode}
2427

2528
Debug mode enables additional diagnostic logging to help troubleshoot issues with Cryptomator. When debug mode is active, the application records more detailed information about its operations in the log files.
2629

2730
:::warning Privacy Consideration
28-
With debug mode enabled, the paths of all files you encrypt are stored in the log file. This creates a record of your file and folder names, which may compromise privacy. Only enable debug mode when actively troubleshooting an issue, and remember to disable it afterward.
31+
With debug mode enabled, _every accessed file and listed directory inside the vault is written in clear text to the log file_. This creates a record of your file and folder names, which may compromise privacy. Only enable debug mode when actively troubleshooting an issue, and remember to disable it afterward.
2932
:::
3033

3134
To enable debug mode:
3235

33-
1. Open Cryptomator and navigate to the settings
34-
2. Look for the `Enable debug logging` checkbox and enable it
36+
1. Open Cryptomator and open the preferences.
37+
2. In the general tab, look for the `Enable debug logging` checkbox at the bottom and enable it.
3538

36-
The additional debug information will now be written to your log files. Once you have reproduced the issue you're investigating, disable debug mode by unchecking the option to return to normal logging levels.
39+
Cryptomator will now run in debug mode. The app indicates this by showing a red bar at the bottom of the main window.
40+
The additional debug information is written to your log files.
41+
Once you have reproduced the issue you're investigating, disable debug mode by unchecking the option to return to normal logging levels.
3742

3843
## Known Issues {#known-issues}
3944

0 commit comments

Comments
 (0)