KaKi87/glitchgit
Archived
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
Error tracking backend generating git repository issues compatible with the Sentry SDK.
This repository has been archived on 2022-12-21. You can view files and clone it, but you cannot make any changes to it's state, such as pushing and creating new issues, pull requests or comments.
23 commits 1 branch 0 tags 516 KiB
Find a file
Exact
KaKi87 dacfda5bca 📝 Add uptime badge
2022-12-21 21:23:55 +01:00
lib 🐛 Fix duplicated issue reports 2022-02-13 14:32:23 +01:00
.gitignore 🎉 Second commit 2020-09-08 17:13:12 +02:00
config.example.json ✨ Ignore Sentry reports when existing issue marked with specific label (default : 'wontfix') 2020-10-20 19:47:55 +02:00
index.js ✨ Add empty root endpoint for uptime check 2020-12-31 03:44:07 +01:00
package.json 🐛 Fix duplicated issues on low interval reports 2020-10-20 19:21:30 +02:00
README.md 📝 Add uptime badge 2022-12-21 21:23:55 +01:00
yarn.lock 🐛 Fix duplicated issues on low interval reports 2020-10-20 19:21:30 +02:00

README.md

glitchgit

Error tracking back-end generating git repository issues compatible with the Sentry SDK.

Idea and name inspired by GlitchTip, an alternative error tracking application compatible with the Sentry SDK.

Compatible git platforms :

Getting started

  1. Get git platform account tokens
  • Get a Gitea account token : /user/settings/applications
  • Get a GitHub account token (public_repo scope required for public repos, repo scope required for private repos)
  1. Clone the project, install its dependencies, create the configuration file
git clone https://git.kaki87.net/KaKi87/glitchgit.git
cd glitchgit
yarn install
cp config.example.json config.json
  1. Update the configuration file
  • port (integer) : web server port, to be used in Sentry DSN or virtual host
  • accounts (array) : git platform accounts
    • accounts[].type (string) : git platform type, must be gitea or github
    • accounts[].token (string) : git platform account token
    • accounts[].host (string) : git platform host
  • projects (array) : Sentry projects
    • projects[].account (integer) : accounts[] index (starts at 1)
    • projects[].repository (string) : git platform repository name in user/repo or org/repo format
  • maxBreadcrumbsCount (integer) : max Sentry breadcrumbs count
  • ignoredIssuesLabel (string) : git platform issue label to ignore further reports
  1. Start the server
yarn start
  1. Open config.json to get auto-generated 32-chars project IDs to be used in Sentry DSNs

Sentry DSN format : protocol://key@host/index

  • protocol = http or https
  • key = projects[].key
  • index = projects[] index (starts at 1)