mystiq
/
rageshake
Archived
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
This repository has been archived on 2022-08-18. You can view files and clone it, but cannot push or open issues or pull requests.
8 Commits 13 Branches 8 Tags 6.5 MiB
Go 93.3%
Shell 4.4%
HCL 1.2%
Dockerfile 1.1%
Go to file
Richard van der Hoff 16ce63c208 add some comments about path sanitisation 2017-04-06 12:16:28 +01:00
hooks fix up the pre-commit hook (#1) 2017-04-05 14:51:07 +01:00
src/github.com/matrix-org/rageshake add some comments about path sanitisation 2017-04-06 12:16:28 +01:00
.gitignore Travis build script and gitignores 2017-04-04 12:01:28 +01:00
.travis.yml Travis build script and gitignores 2017-04-04 12:01:28 +01:00
CONTRIBUTING.rst Add readme, contributing, license 2017-04-04 16:20:50 +01:00
LICENSE Add readme, contributing, license 2017-04-04 16:20:50 +01:00
README.md Move logserver to separate file 2017-04-05 18:16:42 +01:00

README.md

rageshake Build Status

Web service which collects and serves bug reports.

To run it, do:

go get github.com/constabulary/gb/...
gb build
BUGS_USER=<user> BUGS_PASS=<password> ./bin/rageshake PORT
# example:
# BUGS_USER=alice BUGS_PASS=secret ./bin/rageshake 8080

HTTP endpoints

The following HTTP endpoints are exposed:

GET /api/listing/

Serves submitted bug reports. Protected by basic HTTP auth using the username/password provided in the environment. A browsable list, collated by report submission date and time.

POST /api/submit

Submission endpoint: this is where applications should send their reports.

The body of the request should be a JSON object with the following fields:

  • text: A textual description of the problem. Included in the details.log.gz file.

  • user_agent: Application user-agent. Included in the details.log.gz file.

  • version: Application version. Included in the details.log.gz file.

  • logs: an of log files. Each entry in the list should be an object with the following fields:

    • id: textual identifier for the logs. Currently ignored.
    • lines: log data. Lines should be separated by newline characters (encoded as \n, as normal in JSON).