Skip to content

oxyno-zeta/ECRS

Repository files navigation

ECRS (Electron Crash Report Server)

GitHub release GitHub license Build Status CircleCI Coverage Status

Docker

There is some docker image with ECRS :

  • x64: Docker Pulls
  • raspberrypi: Docker Pulls

Description

Electron Crash Report Server to see crash report data, statistics and some others...

Features

  • Manage multiple projects on same server
  • Publish your electron crash reports
  • Download them
  • Get some statistics
  • Email on new crash report
  • Everything configurable with environment variables

Screenshots

Login Administration All Projects
Login Administration All Projects
Crash Reports Statistics
Crash Reports Statistics

Configuration

Environment variables

Server

  • CRASH_REPORTER_PORT: Server port
  • CRASH_REPORTER_LOG_LEVEL: Log level (Possible values: debug|info|error|warn)
  • CRASH_REPORTER_URL: Server url for mails or code example (Ex: 'http://your-domain.com')

Crash Reports

  • CRASH_REPORTER_LOG_UPLOAD_DIR: Upload directory path when report is post (temporary)
  • CRASH_REPORTER_LOG_APP_CRASH_DIR: Directory where are saved reports

Database

  • CRASH_REPORTER_DATABASE_URL: Database URL (Ex: mongodb://mongo:27017/crash-db)
  • CRASH_REPORTER_DATABASE_LOGIN: Database login
  • CRASH_REPORTER_DATABASE_PASSWORD: Database password

Auth

  • CRASH_REPORTER_AUTH_GITHUB_OAUTH_ENABLED: Enable Github authentication
  • CRASH_REPORTER_AUTH_GITHUB_CLIENT_ID: Github Client id
  • CRASH_REPORTER_AUTH_GITHUB_CLIENT_SECRET: Github Client secret
  • CRASH_REPORTER_AUTH_JWT_SECRET: JWT Secret (Ex: Random "aqnzr0pD2c0yv1o0{C6!99^aQ1fk<4|][4Jh2XjK4)N2sXIY8Wxj/1YWGr>")
  • CRASH_REPORTER_AUTH_LOCAL_AUTH_ENABLED: Enable Local Authentication
  • CRASH_REPORTER_LOCAL_REGISTER_ENABLED: Enable Local Register

Mail

  • CRASH_REPORTER_MAIL_HOST: Mail Server host
  • CRASH_REPORTER_MAIL_POOL: Enable Mail pool
  • CRASH_REPORTER_MAIL_PORT: Mail Server port
  • CRASH_REPORTER_MAIL_SECURE: Mail Server Secure (SSL)
  • CRASH_REPORTER_MAIL_AUTH_USER: Mail Server Auth User
  • CRASH_REPORTER_MAIL_AUTH_PASS: Mail Server Auth Password
  • CRASH_REPORTER_MAIL_FROM: Mail From

Roadmap

See ROADMAP.md

Thanks

  • My wife BH to support me doing this

Author

  • Oxyno-zeta (Havrileck Alexandre)

License

MIT (See in License.md)