Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yoshuawuyts/electron-crash-report-service
Aggregate crash reports for Electron apps
https://github.com/yoshuawuyts/electron-crash-report-service
breakpad electron json-schema merry no-peer-deps service
Last synced: about 1 month ago
JSON representation
Aggregate crash reports for Electron apps
- Host: GitHub
- URL: https://github.com/yoshuawuyts/electron-crash-report-service
- Owner: yoshuawuyts
- License: mit
- Created: 2017-01-14T17:17:33.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-26T20:48:13.000Z (over 7 years ago)
- Last Synced: 2024-09-16T06:00:23.388Z (about 2 months ago)
- Topics: breakpad, electron, json-schema, merry, no-peer-deps, service
- Language: JavaScript
- Size: 49.8 KB
- Stars: 19
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
electron-crash-report-service
Aggregate crash reports for Electron applications
## Usage
### Commands
```sh
$ npm install # Install dependencies
$ npm start # Start service in development
```
### Client code
```js
var electron = require('electron')
electron.crashReporter.start({
companyName: '',
productName: '',
submitURL: ''
})
```
## Environment variables
```sh
PORT [80] # Set the port the service should listen to
STORAGE_PATH [/var/crash-reports] # Location to store crash reports
NODE_ENV [production] # production|development
```
## Routes
```txt
/crash-report POST Submit a new crash report
/404 GET 404 handler
```
## Peer Dependencies
None
## Unit file
Save the unit file as `/etc/systemd/system/electron-crash-reporter.service`,
and the application image as `/images/electron-crash-report-service.aci`
```unit
[Unit]
Description=electron-crash-report-service
Requires=network-online.target
After=network-online.target
[Service]
Slice=machine.slice
Delegate=true
CPUQuota=10%
MemoryLimit=1G
Environment=PORT=80
Environment=STORAGE_PATH=/var/crash-reports
Environment=NODE_ENV=production
ExecStart=/usr/bin/rkt run --inherit-env /images/electron-crash-report-service.aci
ExecStopPost=/usr/bin/rkt gc --mark-only
KillMode=mixed
Restart=always
```
You can then run it using `systemctl`:
```sh
$ sudo systemctl start etcd.service
$ sudo systemctl stop etcd.service
$ sudo systemctl restart etcd.service
```
## See Also
- [electron/api/crash-reporters](https://github.com/electron/electron/blob/master/docs/api/crash-reporter.md)
- [feross/webtorrent.io](https://github.com/feross/webtorrent.io/blob/master/server/desktop-api.js)
## License
[MIT](https://tldrlegal.com/license/mit-license)