uplink/README.adoc

32 lines
908 B
Plaintext

= Uplink
image:https://ci.jenkins.io/job/Infra/job/uplink/job/master/badge/icon?style=plastic[link="https://ci.jenkins.io/blue/organizations/jenkins/Infra%2Fuplink/branches"]
image:https://img.shields.io/docker/pulls/jenkinsciinfra/uplink.svg[link="https://hub.docker.com/r/jenkinsciinfra/uplink/"]
`uplink` is a simple web application to receive short bursts of anonymous
telemetry data from Jenkins instances.
image::https://raw.githubusercontent.com/rtyler/uplink/master/public/logged-in.png[role=center, title="Logged in to Uplink"]
== Development
* Running tests: `make check`
* Running the server: `make run`
=== Uploading a test event
[source,bash]
----
curl -d '{"type":"stapler", "correlator" : "my-correlator-id", "payload" : {"hi" : "there"}}' \
-H "Content-Type: application/json" \
http://localhost:3030/events
----
=== Database Debugging
[source,bash]
----
make debug-db
----