wtf/_site/content/posts/modules/jenkins.md

title, date, draft

title	date	draft
Modules: Jenkins	2018-06-09T20:53:35-07:00	false

Added in v0.0.8.

Displays jenkins status of given builds in a project or view

<img src="/imgs/modules/jenkins.png" alt="jenkins screenshot", width="320" height="68" alt="jenkins screenshot" />

Source Code

wtf/jenkins/

Required ENV Variables

Key: WTF_JENKINS_API_KEY
Value: Your Jenkins API key.

Keyboard Commands

None.

Configuration

jenkins:
  enabled: true
  position:
    top: 2
    left: 3
    height: 2
    width: 3
  refreshInterval: 300
  url: "https://jenkins.domain.com/jenkins/view_url"
  user: "username"
  verifyServerCertificate: true

Attributes

enabled
Determines whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

position
Defines where in the grid this module's widget will be displayed.

refreshInterval
How often, in seconds, this module will update its data.
Values: A positive integer, 0..n.

user
Your Jenkins username.

url
The url to your Jenkins project or view.
Values: A valid URI.

verifyServerCertificate
Optional
Determines whether or not the server's certificate chain and host name are verified.
Values: true, false.