{"id":20217962,"url":"https://github.com/matrix-org/rageshake","last_synced_at":"2025-08-24T19:42:08.064Z","repository":{"id":19549887,"uuid":"87176714","full_name":"matrix-org/rageshake","owner":"matrix-org","description":"Bug report server","archived":false,"fork":false,"pushed_at":"2025-03-19T14:03:14.000Z","size":1675,"stargazers_count":32,"open_issues_count":12,"forks_count":13,"subscribers_count":28,"default_branch":"main","last_synced_at":"2025-03-24T13:36:15.067Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matrix-org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-04T11:02:20.000Z","updated_at":"2025-03-19T14:02:43.000Z","dependencies_parsed_at":"2023-11-08T11:39:23.613Z","dependency_job_id":"f8e04349-d004-49ac-a6db-23a8dc1ab0a0","html_url":"https://github.com/matrix-org/rageshake","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-org%2Frageshake","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-org%2Frageshake/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-org%2Frageshake/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matrix-org%2Frageshake/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matrix-org","download_url":"https://codeload.github.com/matrix-org/rageshake/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248243509,"owners_count":21071055,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T06:36:37.972Z","updated_at":"2025-08-24T19:42:08.039Z","avatar_url":"https://github.com/matrix-org.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rageshake ![Build status](https://github.com/matrix-org/rageshake/actions/workflows/build.yaml/badge.svg)\n\nWeb service which collects and serves bug reports.\n\nrageshake requires Go version 1.23 or later.\n\nTo run it, do:\n\n```\ngo build\n./bin/rageshake\n```\n\nOptional parameters:\n\n * `-config \u003cpath\u003e`: The path to a YAML config file; see\n   [rageshake.sample.yaml](rageshake.sample.yaml) for more information.\n * `-listen \u003caddress\u003e`: TCP network address to listen for HTTP requests\n   on. Example: `:9110`.\n\n## Issue template\n\nIt is possible to override the templates used to construct emails, and Github and Gitlab issues.\nSee [templates/README.md](templates/README.md) for more information.\n\n## API Documentation\n\nSee [docs/api.md](docs/api.md) for more information.\n\n## Data stored on disk\n\nEach request to `POST /api/submit` results in data being written to the local disk.\nA new directory is created within `./bugs` (relative to the working directory of the `rageshake` server) for\neach submission; within that directory is created:\n * Any log files attached to the submission, named as chosen by the client (provided the name is moderately sensible),\n   and gzipped.\n * `details.log.gz`: a gzipped text file giving metadata about the submission, in an undocumented format. Now\n   deprecated, but retained for backwards compatibility with existing tooling.\n * `details.json`: Metadata about the submission, in the same format as submitted to the\n   [generic webhooks](./docs/generic_webhook.md).\n\n## Notifications\n\nYou can get notifications when a new rageshake arrives on the server.\n\nCurrently this tool supports pushing notifications as GitHub issues in a repo,\nthrough a Slack webhook or by email, cf sample config file for how to\nconfigure them.\n\n### Generic Webhook Notifications\n\nYou can receive a webhook notifications when a new rageshake arrives on the server.\n\nThese requests contain all the parsed metadata, and links to the uploaded files, and any github/gitlab\nissues created.\n\nDetails on the request and expected response are [available](docs/generic\\_webhook.md).\n\n\n## Cleanup script\n\nA python script is provided in scripts/cleanup.py and in a\n[docker container](https://github.com/orgs/matrix-org/packages/container/package/rageshake%2Fscripts).\nIt can be configured using the commandline options available via `cleaup.py --help`.\n\nIt can either be run via a cronjob at appropriate intervals (typically daily), or\nbe set to run in a continual mode with something like `--repeat-delay-hours 24`\nto repeat running after approximately 24 hours.\n\nNote that this script will scan all logs older than the smallest configured retention period,\nup to the limit specified by `--max-days` or each of the days in `--days-to-check`.\nThis can be an IO and CPU intensive process if a large number of files are scanned.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrix-org%2Frageshake","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatrix-org%2Frageshake","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatrix-org%2Frageshake/lists"}