From 16d77bfa10e0bb652b8a919e40548460729c06da Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Thu, 8 Feb 2024 14:51:24 +0000 Subject: [PATCH] Doc: Documented Sentry integration --- readme/apps/debugging.md | 4 ++++ readme/apps/home_directory.md | 9 +++++++++ readme/privacy.md | 1 + 3 files changed, 14 insertions(+) create mode 100644 readme/apps/home_directory.md diff --git a/readme/apps/debugging.md b/readme/apps/debugging.md index 3c35093b9..bcba62ae1 100644 --- a/readme/apps/debugging.md +++ b/readme/apps/debugging.md @@ -15,6 +15,10 @@ Otherwise, follow these instructions: Make sure you disable debugging once you've finished. Leaving it enabled can cause your log.txt to grow very quickly. To disable debugging, simply delete the "flags.txt" file created. +### Crash reports + +When the application crashes, a report is created in your [home directory](https://github.com/laurent22/joplin/blob/dev/readme/apps/home_directory.md) under the name `joplin_crash_dump_.json`. If you experience a crash please share this log with the team by posting it to the [forum](https://discourse.joplinapp.org/), [GitHub](https://github.com/laurent22/joplin/issues) or [by email](https://raw.githubusercontent.com/laurent22/joplin/dev/Assets/AdresseSupport.png). You may also enable crash report auto-upload in the [Configuration screen](https://github.com/laurent22/joplin/blob/dev/readme/apps/config_screen.md) in the "Application" section. + ### Safe mode Safe mode is a special mode that disables all plugins and renders the notes as plain text. You can use this if, for example, the app is crashing or freezing on startup, or is very slow to run. By starting in safe mode you can verify if it's an issue with the app itself or with one of the plugins. In some rare cases, certain notes can also freeze the app, and safe mode would allow you to either change the note or delete it if it causing problems. diff --git a/readme/apps/home_directory.md b/readme/apps/home_directory.md new file mode 100644 index 000000000..1cc00cf7b --- /dev/null +++ b/readme/apps/home_directory.md @@ -0,0 +1,9 @@ +# Home directory + +Joplin stores some data in your home directory, such as your profile and certain files like crash reports. This directory will be in a location that depends on your operating system: + +| Operating System | Path | Environment Variable | +| --- | --- | --- | +| Windows | `C:\\Users\\(username)` | `%UserProfile%` | +| Linux | `/home/(username)` | `$HOME` | +| macOS | `/Users/(Username)` | `$HOME` | \ No newline at end of file diff --git a/readme/privacy.md b/readme/privacy.md index bd914d664..788d7f455 100644 --- a/readme/privacy.md +++ b/readme/privacy.md @@ -13,6 +13,7 @@ In order to provide certain features, Joplin may need to connect to third-party | Spellchecker dictionary | On Linux and Windows, the desktop application downloads the spellchecker dictionary from `redirector.gvt1.com`. | Enabled | Yes (2) | | Plugin repository | The desktop application downloads the list of available plugins from the [official GitHub repository](https://github.com/joplin/plugins). If this repository is not accessible (eg. in China) the app will try to get the plugin list from [various mirrors](https://github.com/laurent22/joplin/blob/8ac6017c02017b6efd59f5fcab7e0b07f8d44164/packages/lib/services/plugins/RepositoryApi.ts#L22), in which case the plugin screen [works slightly differently](https://github.com/laurent22/joplin/issues/5161#issuecomment-925226975). | Enabled | No | Voice typing | If you use the voice typing feature on Android, the application will download the language files from https://alphacephei.com/vosk/models | Disabled | Yes +| Crash reports | If you have enabled crash auto-upload, the application will upload the report to Sentry when a crash happens. When Sentry is initialised it will also connect to `sentry.io`. | Disabled | Yes (1) https://github.com/laurent22/joplin/issues/5705
(2) If the spellchecker is disabled, [it will not download the dictionary](https://discourse.joplinapp.org/t/new-version-of-joplin-contacting-google-servers-on-startup/23000/40?u=laurent).