1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00

Add new documentation for config API key modules

This commit is contained in:
Chris Cummer
2018-07-31 14:48:26 -07:00
parent 9059b73c51
commit ebad879e0a
14 changed files with 129 additions and 145 deletions

View File

@@ -49,12 +49,13 @@ position Defines where in the grid this module’s widget will be displa
<guid>https://wtfutil.com/posts/modules/todoist/</guid>
<description>Added in v0.0.11.
Displays all items on specified project.
Source Code wtf/todoist/ Required ENV Variables Key: WTF_TODOIST_TOKEN Value: Your Todoist API Token. You can get your API Token at: todoist.com/prefs/integrations.
Keyboard Commands Key: h Action: Show the previous project.
Source Code wtf/todoist/ Keyboard Commands Key: h Action: Show the previous project.
Key: ← Action: Show the previous project.
Key: l Action: Show the next project.
Key: → Action: Show the next project.
Key: j Action: Select the next item in the list.</description>
Key: j Action: Select the next item in the list.
Key: ↓ Action: Select the next item in the list.
Key: k Action: Select the previous item in the list.</description>
</item>
<item>
@@ -339,12 +340,12 @@ Key: j Action: Select the next item in the list.</description>
<guid>https://wtfutil.com/posts/modules/jira/</guid>
<description>Displays all Jira issues assigned to you for the specified project.
Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key.
Keyboard Commands Key: [return] Action: Open the selected issue in the browser.
Source Code wtf/jira/ Keyboard Commands Key: [return] Action: Open the selected issue in the browser.
Key: j Action: Select the next item in the list.
Key: k Action: Select the previous item in the list.
Key: ↓ Action: Select the next item in the list.
Key: ↑ Action: Select the previous item in the list.</description>
Key: ↑ Action: Select the previous item in the list.
Configuration Single Jira Project jira:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;domain:&amp;#34;https://umbrellacorp.</description>
</item>
<item>
@@ -382,10 +383,11 @@ Configuration gcal:colors:title:&amp;#34;red&amp;#34;description:&amp;#34;lightb
<description>Displays information about your git repositories hosted on GitHub:
Open Review Requests All open code review requests assigned to you.
Open Pull Requests All open pull requests created by you.
Source Code wtf/github/ GitHub Required ENV Variables Key: WTF_GITHUB_TOKEN Action: Your GitHub API token.
GitHub Enterprise Required ENV Variables Key: WTF_GITHUB_TOKEN Action: Your GitHub API token.
Key: WTF_GITHUB_BASE_URL Action: Your GitHub Enterprise API URL.
Key: WTF_GITHUB_UPLOAD_URL Action: Your GitHub Enterprise upload URL (often the same as API URL).</description>
Source Code wtf/github/ Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Key: h Action: Show the previous git repository.
Key: l Action: Show the next git repository.
Key: ← Action: Show the previous git repository.
Key: → Action: Show the next git repository.</description>
</item>
<item>
@@ -438,10 +440,10 @@ filePath The path to the file to be displayed in the widget.</description>
<guid>https://wtfutil.com/posts/modules/newrelic/</guid>
<description>Connects to the New Relic API and displays the last n deploys of the monitored application: deploy ID, deploy time, and who deployed it.
Source Code wtf/newrelic/ Required ENV Variables Key: WTF_NEW_RELIC_API_KEY Value: Your New Relic API token.
Keyboard Commands None.
Configuration newrelic:applicationId:10549735deployCount:6enabled:trueposition:top:4left:3height:1width:2refreshInterval:900 Attributes applicationId The integer ID of the New Relic application you wish to report on. Values: A positive integer, 0..n.
deployCount The number of past deploys to display on screen.</description>
Source Code wtf/newrelic/ Keyboard Commands None.
Configuration newrelic:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;applicationId:10549735deployCount:6enabled:trueposition:top:4left:3height:1width:2refreshInterval:900 Attributes apiKey Value: Your New Relic API token.
applicationId The integer ID of the New Relic application you wish to report on. Values: A positive integer, 0..n.
deployCount The number of past deploys to display on screen. Values: A positive integer, 0.</description>
</item>
<item>
@@ -451,9 +453,9 @@ deployCount The number of past deploys to display on screen.</description>
<guid>https://wtfutil.com/posts/modules/opsgenie/</guid>
<description>Connects to the OpsGenie API and displays all your scheduled rotations and who&amp;rsquo;s currently on call.
Source Code wtf/opsgenie/ Required ENV Variables Key: WTF_OPS_GENIE_API_KEY Value: Your OpsGenie API token.
Keyboard Commands None.
Configuration opsgenie:displayEmpty:falseenabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 Attributes displayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false.
Source Code wtf/opsgenie/ Keyboard Commands None.
Configuration opsgenie:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;displayEmpty:falseenabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 Attributes apiKey &amp;lt; br /&amp;gt; Value: Your OpsGenie API token.
displayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false.
enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item>
@@ -475,11 +477,10 @@ Wifi Network The name of the current network Whether or not the network uses enc
<guid>https://wtfutil.com/posts/modules/bamboohr/</guid>
<description>Connects to the BambooHR API and displays who will be Away today.
Source Code wtf/bamboohr/ Required ENV Variables Key: WTF_BAMBOO_HR_TOKEN Value: Your BambooHR API token.
Key: WTF_BAMBOO_HR_SUBDOMAIN Value: Your BambooHR API subdomain name.
Keyboard Commands None.
Configuration bamboohr:enabled:trueposition:top:0left:1height:2width:1refreshInterval:900 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&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description>
Source Code wtf/bamboohr/ Keyboard Commands None.
Configuration bamboohr:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:0left:1height:2width:1refreshInterval:900subdomain:&amp;#34;testco&amp;#34; Attributes apiKey Value: Your BambooHR API token.
enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: Any positive integer, 0.</description>
</item>
<item>

View File

@@ -49,12 +49,13 @@ position Defines where in the grid this module&amp;rsquo;s widget will be displa
<guid>https://wtfutil.com/posts/modules/todoist/</guid>
<description>Added in v0.0.11.
Displays all items on specified project.
Source Code wtf/todoist/ Required ENV Variables Key: WTF_TODOIST_TOKEN Value: Your Todoist API Token. You can get your API Token at: todoist.com/prefs/integrations.
Keyboard Commands Key: h Action: Show the previous project.
Source Code wtf/todoist/ Keyboard Commands Key: h Action: Show the previous project.
Key: ← Action: Show the previous project.
Key: l Action: Show the next project.
Key: → Action: Show the next project.
Key: j Action: Select the next item in the list.</description>
Key: j Action: Select the next item in the list.
Key: ↓ Action: Select the next item in the list.
Key: k Action: Select the previous item in the list.</description>
</item>
<item>
@@ -339,12 +340,12 @@ Key: j Action: Select the next item in the list.</description>
<guid>https://wtfutil.com/posts/modules/jira/</guid>
<description>Displays all Jira issues assigned to you for the specified project.
Source Code wtf/jira/ Required ENV Variables Key: WTF_JIRA_API_KEY Value: Your Jira API key.
Keyboard Commands Key: [return] Action: Open the selected issue in the browser.
Source Code wtf/jira/ Keyboard Commands Key: [return] Action: Open the selected issue in the browser.
Key: j Action: Select the next item in the list.
Key: k Action: Select the previous item in the list.
Key: ↓ Action: Select the next item in the list.
Key: ↑ Action: Select the previous item in the list.</description>
Key: ↑ Action: Select the previous item in the list.
Configuration Single Jira Project jira:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;colors:rows:even:&amp;#34;lightblue&amp;#34;odd:&amp;#34;white&amp;#34;domain:&amp;#34;https://umbrellacorp.</description>
</item>
<item>
@@ -382,10 +383,11 @@ Configuration gcal:colors:title:&amp;#34;red&amp;#34;description:&amp;#34;lightb
<description>Displays information about your git repositories hosted on GitHub:
Open Review Requests All open code review requests assigned to you.
Open Pull Requests All open pull requests created by you.
Source Code wtf/github/ GitHub Required ENV Variables Key: WTF_GITHUB_TOKEN Action: Your GitHub API token.
GitHub Enterprise Required ENV Variables Key: WTF_GITHUB_TOKEN Action: Your GitHub API token.
Key: WTF_GITHUB_BASE_URL Action: Your GitHub Enterprise API URL.
Key: WTF_GITHUB_UPLOAD_URL Action: Your GitHub Enterprise upload URL (often the same as API URL).</description>
Source Code wtf/github/ Keyboard Commands Key: / Action: Open/close the widget&amp;rsquo;s help window.
Key: h Action: Show the previous git repository.
Key: l Action: Show the next git repository.
Key: ← Action: Show the previous git repository.
Key: → Action: Show the next git repository.</description>
</item>
<item>
@@ -438,10 +440,10 @@ filePath The path to the file to be displayed in the widget.</description>
<guid>https://wtfutil.com/posts/modules/newrelic/</guid>
<description>Connects to the New Relic API and displays the last n deploys of the monitored application: deploy ID, deploy time, and who deployed it.
Source Code wtf/newrelic/ Required ENV Variables Key: WTF_NEW_RELIC_API_KEY Value: Your New Relic API token.
Keyboard Commands None.
Configuration newrelic:applicationId:10549735deployCount:6enabled:trueposition:top:4left:3height:1width:2refreshInterval:900 Attributes applicationId The integer ID of the New Relic application you wish to report on. Values: A positive integer, 0..n.
deployCount The number of past deploys to display on screen.</description>
Source Code wtf/newrelic/ Keyboard Commands None.
Configuration newrelic:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;applicationId:10549735deployCount:6enabled:trueposition:top:4left:3height:1width:2refreshInterval:900 Attributes apiKey Value: Your New Relic API token.
applicationId The integer ID of the New Relic application you wish to report on. Values: A positive integer, 0..n.
deployCount The number of past deploys to display on screen. Values: A positive integer, 0.</description>
</item>
<item>
@@ -451,9 +453,9 @@ deployCount The number of past deploys to display on screen.</description>
<guid>https://wtfutil.com/posts/modules/opsgenie/</guid>
<description>Connects to the OpsGenie API and displays all your scheduled rotations and who&amp;rsquo;s currently on call.
Source Code wtf/opsgenie/ Required ENV Variables Key: WTF_OPS_GENIE_API_KEY Value: Your OpsGenie API token.
Keyboard Commands None.
Configuration opsgenie:displayEmpty:falseenabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 Attributes displayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false.
Source Code wtf/opsgenie/ Keyboard Commands None.
Configuration opsgenie:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;displayEmpty:falseenabled:trueposition:top:2left:1height:2width:1refreshInterval:21600 Attributes apiKey &amp;lt; br /&amp;gt; Value: Your OpsGenie API token.
displayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false.
enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item>
@@ -475,11 +477,10 @@ Wifi Network The name of the current network Whether or not the network uses enc
<guid>https://wtfutil.com/posts/modules/bamboohr/</guid>
<description>Connects to the BambooHR API and displays who will be Away today.
Source Code wtf/bamboohr/ Required ENV Variables Key: WTF_BAMBOO_HR_TOKEN Value: Your BambooHR API token.
Key: WTF_BAMBOO_HR_SUBDOMAIN Value: Your BambooHR API subdomain name.
Keyboard Commands None.
Configuration bamboohr:enabled:trueposition:top:0left:1height:2width:1refreshInterval:900 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&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data.</description>
Source Code wtf/bamboohr/ Keyboard Commands None.
Configuration bamboohr:apiKey:&amp;#34;3276d7155dd9ee27b8b14f8743a408a9&amp;#34;enabled:trueposition:top:0left:1height:2width:1refreshInterval:900subdomain:&amp;#34;testco&amp;#34; Attributes apiKey Value: Your BambooHR API token.
enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: Any positive integer, 0.</description>
</item>
<item>

View File

@@ -141,31 +141,28 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/bamboohr/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_BAMBOO_HR_TOKEN</code> <br />
<span class="caption">Value:</span> Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> token.</p>
<p><span class="caption">Key:</span> <code>WTF_BAMBOO_HR_SUBDOMAIN</code> <br />
<span class="caption">Value:</span> Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> subdomain name.</p>
<h2 id="keyboard-commands">Keyboard Commands</h2>
<p>None.</p>
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">bamboohr<span class="p">:</span><span class="w">
</span><span class="w"> </span>apiKey<span class="p">:</span><span class="w"> </span><span class="s2">&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;</span><span class="w">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">0</span><span class="w">
</span><span class="w"> </span>left<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w">
</span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">900</span></code></pre></div>
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">900</span><span class="w">
</span><span class="w"> </span>subdomain<span class="p">:</span><span class="w"> </span><span class="s2">&#34;testco&#34;</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>apiKey</code> <br />
Value: Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> token.</p>
<p><code>enabled</code> <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p>
<p><code>position</code> <br />
@@ -175,6 +172,9 @@ Defines where in the grid this module&rsquo;s widget will be displayed. <br /></
How often, in seconds, this module will update its data. <br />
Values: Any positive integer, <code>0..n</code>.</p>
<p><code>subdomain</code> <br />
Value: Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> subdomain name.</p>
</div>
<div class="footer">

View File

@@ -151,22 +151,6 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/github/</code></pre></div>
<h2 id="github-required-env-variables">GitHub Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_GITHUB_TOKEN</code> <br />
<span class="caption">Action:</span> Your <a href="https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization">GitHub API</a> token.</p>
<h2 id="github-enterprise-required-env-variables">GitHub Enterprise Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_GITHUB_TOKEN</code> <br />
<span class="caption">Action:</span> Your <a href="https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization">GitHub API</a> token.</p>
<p><span class="caption">Key:</span> <code>WTF_GITHUB_BASE_URL</code> <br />
<span class="caption">Action:</span> Your <a href="https://developer.github.com/enterprise/2.13/v3/enterprise-admin/">GitHub Enterprise</a> API URL.</p>
<p><span class="caption">Key:</span> <code>WTF_GITHUB_UPLOAD_URL</code> <br />
<span class="caption">Action:</span> Your <a href="https://developer.github.com/enterprise/2.13/v3/enterprise-admin/">GitHub Enterprise</a> upload URL (often the same as API URL).</p>
<h2 id="keyboard-commands">Keyboard Commands</h2>
<p><span class="caption">Key:</span> <code>/</code> <br />
@@ -186,6 +170,8 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">github<span class="p">:</span><span class="w">
</span><span class="w"> </span>apiKey<span class="p">:</span><span class="w"> </span><span class="s2">&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;</span><span class="w">
</span><span class="w"> </span>baseURL<span class="p">:</span><span class="w"> </span><span class="s2">&#34;&#34;</span><span class="w">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>enableStatus<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
@@ -197,11 +183,19 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
</span><span class="w"> </span>repositories<span class="p">:</span><span class="w">
</span><span class="w"> </span>wesker-api<span class="p">:</span><span class="w"> </span><span class="s2">&#34;UmbrellaCorp&#34;</span><span class="w">
</span><span class="w"> </span>wtf<span class="p">:</span><span class="w"> </span><span class="s2">&#34;senorprogrammer&#34;</span><span class="w">
</span><span class="w"> </span>uploadURL<span class="p">:</span><span class="w"> </span><span class="s2">&#34;&#34;</span><span class="w">
</span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span><span class="s2">&#34;senorprogrammer&#34;</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>apiKey</code> <br />
Value: Your <a href="https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization">GitHub API</a> token.</p>
<p><code>baseURL</code> <br />
<em>Optional</em> <br />
Value: Your <a href="https://developer.github.com/enterprise/2.13/v3/enterprise-admin/">GitHub Enterprise</a> API URL.</p>
<p><code>enabled</code> <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p>
<p><code>enableStatus</code> <br />
@@ -222,6 +216,10 @@ for. <br />
<span class="caption">Key:</span> The name of the repository. <br />
<span class="caption">Value:</span> The name of the account or organization that owns the repository.</p>
<p><code>uploadURL</code> <br />
<em>Optional</em> <br />
Value: Your <a href="https://developer.github.com/enterprise/2.13/v3/enterprise-admin/">GitHub Enterprise</a> upload URL (often the same as API URL).</p>
<p><code>username</code> <br />
Your GitHub username. Used to figure out which review requests you&rsquo;ve
been added to.</p>

View File

@@ -143,11 +143,6 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/jira/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_JIRA_API_KEY</code> <br />
<span class="caption">Value:</span> Your <a href="https://confluence.atlassian.com/cloud/api-tokens-938839638.html">Jira API</a> key.</p>
<h2 id="keyboard-commands">Keyboard Commands</h2>
<p><span class="caption">Key:</span> <code>[return]</code> <br />
@@ -169,6 +164,7 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h3 id="single-jira-project">Single Jira Project</h3>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">jira<span class="p">:</span><span class="w">
</span><span class="w"> </span>apiKey<span class="p">:</span><span class="w"> </span><span class="s2">&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;</span><span class="w">
</span><span class="w"> </span>colors<span class="p">:</span><span class="w">
</span><span class="w"> </span>rows<span class="p">:</span><span class="w">
</span><span class="w"> </span>even<span class="p">:</span><span class="w"> </span><span class="s2">&#34;lightblue&#34;</span><span class="w">
@@ -191,6 +187,7 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<p>If you want to monitor multiple Jira projects, use the following
configuration (note the difference in <code>project</code>):</p>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">jira<span class="p">:</span><span class="w">
</span><span class="w"> </span>apiKey<span class="p">:</span><span class="w"> </span><span class="s2">&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;</span><span class="w">
</span><span class="w"> </span>colors<span class="p">:</span><span class="w">
</span><span class="w"> </span>rows<span class="p">:</span><span class="w">
</span><span class="w"> </span>even<span class="p">:</span><span class="w"> </span><span class="s2">&#34;lightblue&#34;</span><span class="w">
@@ -210,6 +207,9 @@ configuration (note the difference in <code>project</code>):</p>
</span><span class="w"> </span>verifyServerCertificate<span class="p">:</span><span class="w"> </span><span class="kc">true</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>apiKey</code> <br />
Value: Your <a href="https://confluence.atlassian.com/cloud/api-tokens-938839638.html">Jira API</a> key.</p>
<p><code>colors.rows.even</code> <br />
Define the foreground color for even-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11

View File

@@ -144,18 +144,13 @@ monitored application: deploy ID, deploy time, and who deployed it.</p>
<h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/newrelic/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_NEW_RELIC_API_KEY</code> <br />
<span class="caption">Value:</span> Your <a href="">New Relic API</a>
token.</p>
<h2 id="keyboard-commands">Keyboard Commands</h2>
<p>None.</p>
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">newrelic<span class="p">:</span><span class="w">
</span><span class="w"> </span>apiKey<span class="p">:</span><span class="w"> </span><span class="s2">&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;</span><span class="w">
</span><span class="w"> </span>applicationId<span class="p">:</span><span class="w"> </span><span class="m">10549735</span><span class="w">
</span><span class="w"> </span>deployCount<span class="p">:</span><span class="w"> </span><span class="m">6</span><span class="w">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
@@ -167,6 +162,9 @@ token.</p>
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">900</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>apiKey</code> <br />
Value: Your <a href="https://docs.newrelic.com/docs/apis/getting-started/intro-apis/access-rest-api-keys">New Relic API</a> token.</p>
<p><code>applicationId</code> <br />
The integer ID of the New Relic application you wish to report on. <br
/>

View File

@@ -144,18 +144,13 @@ and who&rsquo;s currently on call.</p>
<h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/opsgenie/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_OPS_GENIE_API_KEY</code> <br />
<span class="caption">Value:</span> Your <a href="https://docs.opsgenie.com/docs/api-integration">OpsGenie
API</a> token.</p>
<h2 id="keyboard-commands">Keyboard Commands</h2>
<p>None.</p>
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">opsgenie<span class="p">:</span><span class="w">
</span><span class="w"> </span>apiKey<span class="p">:</span><span class="w"> </span><span class="s2">&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;</span><span class="w">
</span><span class="w"> </span>displayEmpty<span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="w">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
@@ -166,6 +161,9 @@ API</a> token.</p>
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">21600</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>apiKey</code> &lt; br /&gt;
Value: Your <a href="https://docs.opsgenie.com/docs/api-integration">OpsGenie API</a> token.</p>
<p><code>displayEmpty</code> <br />
Whether schedules with no assigned person on-call should be displayed. <br />
Values: <code>true</code>, <code>false</code>.</p>

View File

@@ -145,13 +145,6 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/todoist/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>WTF_TODOIST_TOKEN</code> <br />
<span class="caption">Value:</span> Your Todoist API Token. <br /></p>
<p><em>You can get your API Token at: todoist.com/prefs/integrations.</em></p>
<h2 id="keyboard-commands">Keyboard Commands</h2>
<p><span class="caption">Key:</span> <code>h</code> <br />
@@ -189,6 +182,7 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">todoist<span class="p">:</span><span class="w">
</span><span class="w"> </span>apiKey<span class="p">:</span><span class="w"> </span><span class="s2">&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;</span><span class="w">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">0</span><span class="w">
@@ -200,6 +194,9 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">3600</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>apiKey</code> <br />
Value: Your <a href="https://developer.todoist.com/sync/v7/">Todoist API</a> token.</p>
<p><code>enabled</code> <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p>