electron-crash-report-server

by johnmuhl

GitHub Readme.md

electron-crash-report-server is a Node.js (hapi, svelte) and PostgreSQL (massive) application for collecting crash reports from Electron applications.

install

Deploy

During setup change the AUTH_USER and AUTH_PASS environment variables. Once the app has deployed use those values to login.

If crash reports do not appear after the first deploy restart the app.

Read the development section for information about running in other environments.

usage

const { crashReporter } = require("electron");
crashReporter.start({
  // ...other options
  submitURL: "https://app-name-12345.herokuapp.com/",
});

Refer to the crashReporter documentation for the full details.

Important: Don't forget to start the crashReporter in the main process and each renderer that will create crash reports.

Check out the example electron app and demo server for a working example. The login and password for the demo are crash and electron.

If there are no sample reports use the example (or any other) app to add some reports to the demo server.

development

Requirements: Node.js LTS 8.9+ and PostgreSQL 9.4+.

git clone https://github.com/johnmuhl/electron-crash-report-server
cd electron-crash-report-server
createdb electron-crash-report-server
cp .env-example .env
yarn && yarn dev
# make changes
yarn fmt

bugs & features

Use the issue tracker to report bugs or discuss changes and features.

license

MIT license