Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add section explaining Sentry crash report collection. #372

Merged
merged 1 commit into from
Nov 26, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# desktop comfyui
# ComfyUI Desktop (beta)

[![codecov](https://codecov.io/github/Comfy-Org/electron/graph/badge.svg?token=S64WJWD2ZX)](https://codecov.io/github/Comfy-Org/electron)
![Beta](https://img.shields.io/badge/beta-blue.svg)
Expand Down Expand Up @@ -271,6 +271,12 @@ yarn:clean:assets
yarn clean:slate
```

# Crash Reports

At the onboarding step, you can opt-in to send us crash reports, which **only** include stack trace for unhandled exceptions and native crashes. These are really helpful to help us debug issues in lieu of an actual Github bug report. However, you can opt-out and nothing will ever be sent. We use Sentry to send crash reports. Code [here](https://github.com/Comfy-Org/desktop/blob/main/src/services/sentry.ts).

In either case, no personal data, workflows or logs will be sent.

# Download

Windows NSIS x64: [Download](https://download.comfy.org/windows/nsis/x64)
Expand Down