Skip to content

Commit

Permalink
update README to warn about crash report env vars
Browse files Browse the repository at this point in the history
  • Loading branch information
mitchellh committed Sep 3, 2024
1 parent d885c81 commit 84f4743
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -471,11 +471,17 @@ be used. A future version of Ghostty will show you the contents of the
crash report directly in the terminal.

If Ghostty crashed, you can help the project by attaching the crash report
to a GitHub issue. The crash report doesn't contain any purposefully
sensitive information, but it may contain paths to files on your system,
information about your OS, or other details you may not want to share.
If you are concerned about this, you're welcome to transfer the crash report
privately to me.
to a GitHub issue.

> [!WARNING]
>
> The crash report can contain sensitive information. The report may contain
> file paths (such as for stack traces), environment variables when Ghostty
> was launched, and other information. Please review the crash report before
> sharing it. We are working to improve the crash report system to scrub
> some of this information. For example, we have no interest in environment
> variables at all but [Breakpad](https://chromium.googlesource.com/breakpad/breakpad)
> automatically includes them.
## Developing Ghostty

Expand Down

0 comments on commit 84f4743

Please sign in to comment.