mixmaxhq/jqd repository overview

⁠jqd

jqd is a Jira query daemon that exposes the ability to search for Jira issues in a rich manner and to visualize those over different time periods.

⁠Get it

⁠Docker

If you want to run jqd via docker, you can:

docker pull mixmaxhq/jqd

⁠Source

If you want to get it and run it from source, you can:

go get github.com/mixmaxhq/jqd
dep ensure
go run main.go

⁠Running jqd

⁠Required values

To run jqd, you need to provide it with some information. In order to communicate with Jira, jqd needs to know:

• The username of a Jira account to connect with
• Either an API token or the password for that account, please only use API tokens - NEVER use passwords.
• The base URL for the Jira deployment to communicate with.

If running jqd from source, this will need to be provided via the environment for now as:

• $JIRA_USER
• $JIRA_API_TOKEN (this can be a password, but please don't)
• $JIRA_BASE_URL

If running via docker, you can do so as:

docker run -d -p 9090:9090            \
    -e JIRA_USER=$JIRA_USER           \
    -e JIRA_API_TOKEN=$JIRA_API_TOKEN \
    -e JIRA_BASE_URL=$JIRA_BASE_URL   \
    mixmaxhq/jqd:latest

⁠Searching

Currently, jqd exposes a single API endpoint at /api/search. This API endpoint only supports GET requests and responds with a JSON resource. It supports search parameters via query parameters. The supported values are:

There are optional parameters to mutate the response with.

⁠Developing

If you'd like to contribute to jqd, there's a utility function in the Makefile to make this easier, once done modifying the code you can run

make test

Which will rebuild the binary, then a new docker image and will launch it, pulling in the needed envvars.