Skip to content

Commit 67d8fd6

Browse files
authored
Merge pull request #439 from iterate-ch/issue/432
Layout improvement: Cyberduck support page
2 parents 21139b8 + ffbcde0 commit 67d8fd6

File tree

2 files changed

+16
-61
lines changed

2 files changed

+16
-61
lines changed

cyberduck/support.md

Lines changed: 12 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For issues with your remote storage user account credentials, please instead wri
1616
[Open a new ticket](https://github.com/iterate-ch/cyberduck/issues/new/choose) with a description of what you have done and what went wrong. Make sure to look or search for existing issues first. If you have trouble connecting to a server or your login credentials are not valid, try to resolve the issue with the assistance of your hosting service provider.
1717

1818
```{note}
19-
Discuss features and issues you are having in the [Cyberduck Google Group](https://github.com/iterate-ch/cyberduck/discussions). For issues with the registration key, please send an mail to [support@cyberduck.io](mailto:support@cyberduck.io).
19+
Discuss features and issues you are having in [GitHub Discussions](https://github.com/iterate-ch/cyberduck/discussions). For issues with the registration key, please send an email to [support@cyberduck.io](mailto:support@cyberduck.io).
2020
```
2121

2222
```{warning}
@@ -25,82 +25,37 @@ Please be aware that you are possibly using our software at no charge if you hav
2525

2626
## Logging Output
2727

28-
29-
```````{tabs}
30-
``````{group-tab} macOS
31-
3228
`````{tabs}
33-
````{tab} Log
34-
35-
Reveal the log output named `cyberduck.log` by choosing _Preferences → Connection → Log → Show_.
36-
37-
Alternatively, the `cyberduck.log` file can be found in `~/Library/Logs/Cyberduck`.
38-
39-
````
40-
````{tab} Console.app
29+
````{group-tab} macOS
4130
42-
You can easily `cyberduck.log` in *Console.app* (Open from `/Applications/Utilities`) under `Reports → Log Reports → cyberduck.log`.
31+
Log output can be found in the `cyberduck.log` file in`~/Library/Logs/Cyberduck`. Select _Show_ in _Cyberduck → Preferences → Connection_ to reveal the log file. Alternatively, you can find `cyberduck.log` in *Console.app* (Open from `/Applications/Utilities`) under `Reports → Log Reports → cyberduck.log`.
4332
4433
```{image} _images/Console.app.png
4534
:alt: Console.app
4635
:width: 600px
4736
```
4837
49-
````
50-
`````
51-
52-
**Transcript**
38+
### Transcript
5339
54-
You can only access the transcript which will log protocol request and responses. It's particular useful for protocols using HTTP. Open a *Terminal.app* window and enter
40+
You can access the transcript which will log protocol request and responses from the command line particularly useful for protocols using HTTP. Open a *Terminal.app* window and enter
5541
5642
`log stream --predicate '(process == "Cyberduck") && (category == "transcript")' --level info`
5743
5844
```{note}
5945
The transcript will be written in the *Terminal.app* window. Make sure to keep the window open after executing the command.
6046
```
6147
48+
````
49+
````{group-tab} Windows
6250
63-
**Heap Dump**
64-
65-
To create a heap dump of the Cyberduck process on macOS (in case of excessive memory usage for example) you can use `jmap` from the {download}`OpenJDK 13<https://github.com/AdoptOpenJDK/openjdk13-binaries/releases/download/jdk-13.0.2%2B8/OpenJDK13U-jdk_x64_mac_hotspot_13.0.2_8.pkg>`.
66-
67-
`jmap -dump:file=cyberduck-dump.hprof [PID of Cyberduck process]`
68-
69-
``````
70-
``````{group-tab} Windows
71-
72-
Reveal the log output named `cyberduck.log` by choosing _Preferences → Connection → Log → Show_.
73-
74-
Alternatively, the `cyberduck.log` file can be found in `%AppData%\cyberduck`.
75-
76-
``````
77-
```````
78-
79-
### Debug Logging Level
80-
Enable debug logging by choosing _Preferences → Connection → Log → Enable debug log_. Alternatively this can be configured using the following command line options.
81-
82-
````{tabs}
83-
```{group-tab} macOS
84-
85-
To enable debug logging open a *Terminal.app* window and enter
86-
87-
defaults write ~/Library/Preferences/ch.sudo.cyberduck.plist logging debug
88-
89-
Reset the logging configuration with
90-
91-
`defaults delete ~/Library/Preferences/ch.sudo.cyberduck.plist logging`
92-
93-
Restart Cyberduck for any logging configuration change to take effect.
94-
95-
```
96-
```{group-tab} Windows
51+
Log output can be found in the `cyberduck.log` file in `%AppData%\cyberduck`. Select _Show_ in _Cyberduck → Preferences → Connection_ to reveal the log file named *cyberduck.log*.
9752
98-
Debug logging can be enabled with a [hidden setting](preferences.md#hidden-configuration-options). As there is no user interface for this yet you need to add the setting manually. If not existing yet you have to create the file [`%AppData%\Cyberduck\default.properties`](faq.md#preferences-and-application-support-files-location) and then add the property as follows:
53+
````
54+
`````
9955

100-
`logging=debug`
56+
### Debug Log
10157

102-
```
103-
````
58+
To enable verbose log output select _Enable debug log_ in _Cyberduck → Preferences → Connection_.
10459

10560
## Application Support Folder
10661

mountainduck/support.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,25 +29,25 @@ You can reach the application support folder by navigating to `%AppData%\Cyberdu
2929
`````{tabs}
3030
````{group-tab} macOS
3131
32-
Log output can be found in the `mountainduck.log` file in`~/Library/Logs/Mountain Duck`. You can easily reach this file in _Console.app_ (Open from `/Applications/Utilities`) under `Reports → Log Reports → mountainduck.log`. You can also reveal the file by clicking on the _Show_ button within the Mountain Duck preferences _Connection_ tab.
32+
Log output can be found in the `mountainduck.log` file in`~/Library/Logs/Mountain Duck`. You can easily reach this file in _Console.app_ (Open from `/Applications/Utilities`) under `Reports → Log Reports → mountainduck.log`. Select _Show_ in _Mountain Duck → Preferences → Connection_ to reveal the log file.
3333
3434
````
3535
````{group-tab} Windows
3636
37-
Log output can be found in the `mountainduck.log` file in `%AppData%\cyberduck`. You can also reveal the file by clicking on the *Show* button within the Mountain Duck *Preferences Connection* tab. The file is named *mountainduck.log*.
37+
Log output can be found in the `mountainduck.log` file in `%AppData%\cyberduck`. Select _Show_ in _Mountain Duck → Preferences → Connection_ to reveal the log file named *mountainduck.log*.
3838
3939
````
4040
`````
4141

4242
#### Debug Log
4343

44-
To enable debug logging tick the corresponding checkmark in the Mountain Duck *Preferences Connection* tab. You can reach the logging output by clicking on the *Show* button within the same Mountain Duck *Preferences* section. The file is called *mountainduck.log*.
44+
To enable verbose log output select _Enable debug log_ in _Mountain Duck Preferences → Connection_.
4545

4646
#### Error Log
4747

4848
An error log is a record of critical errors that occur during the operation of the application or server. It can be a useful tool for troubleshooting.
4949

50-
It can be reached by clicking on the Show button within the Mountain Duck *Preferences Connection* tab. The file is named *mountainduck.error*.
50+
It can be reached by clicking on the Show button within _Mountain Duck Preferences → Connection_. The file is named *mountainduck.error*.
5151

5252
### Feature Request
5353

0 commit comments

Comments
 (0)