taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

Adds the New Relic and Textfile modules to the documentation

Browse Source
This commit is contained in:
Chris Cummer 2018-05-09 11:28:04 -07:00
parent 7adc0cdb11
commit decc8cd5e5
31 changed files with 607 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
_site/content/posts/modules.md
View File

@ -26,10 +26,10 @@ Available modules:
<li><a href="/posts/modules/github" class="disabled">Github</a>
<li><a href="/posts/modules/gcal" class="disabled">Google Calendar</a>
<li><a href="/posts/modules/jira" class="disabled">Jira</a>
<li><a href="/posts/modules/newrelic" class="disabled">New Relic</a>
<li><a href="/posts/modules/newrelic">New Relic</a>
<li><a href="/posts/modules/opsgenie">OpsGenie</a>
<li><a href="/posts/modules/security">Security</a>
<li><a href="/posts/modules/textfiles" class="disabled">Text Files</a>
<li><a href="/posts/modules/textfile">Text File</a>
<li><a href="/posts/modules/todo" class="disabled">Todo</a>
<li><a href="/posts/modules/weather" class="disabled">Weather</a>
</ul>

2
_site/content/posts/modules/bamboohr.md
View File

@ -8,7 +8,7 @@ draft: false
Connects to the BambooHR API and displays who will be Away today.
## Location
## Source Code
```bash
wtf/bamboohr

2
_site/content/posts/modules/clocks.md
View File

@ -10,7 +10,7 @@ Displays a configurable list of world clocks, the local time, and date.
<img src="/imgs/modules/clocks.png" width="320" height="191" alt="clocks screenshot" />
## Location
## Source Code
```bash
wtf/clocks/

65
_site/content/posts/modules/newrelic.md Normal file
View File

@ -0,0 +1,65 @@
---
title: "Newrelic"
date: 2018-05-09T09:01:14-07:00
draft: false
---
## 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.
<img src="/imgs/modules/newrelic.png" width="640" height="189" alt="newrelic screenshot" />
## Source Code
```bash
wtf/newrelic/
```
## Required ENV Variables
<span class="caption">Key:</span> `WTF_NEW_RELIC_API_KEY` <br />
<span class="caption">Value:</span> Your <a href="">New Relic API</a>
token.
## Keyboard Commands
None.
## Configuration
```yaml
newrelic:
applicationId: 10549735
deployCount: 6
enabled: true
position:
top: 4
left: 3
height: 1
width: 2
refreshInterval: 900
```
### Attributes
`applicationId` <br />
The integer ID of the New Relic application you wish to report on. <br
/>
Values: A positive integer, `0...n`.
`deployCount` <br />
The number of past deploys to display on screen. <br />
Values: A positive integer, `0...n`.
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
`position` <br />
Defines where in the grid this module's widget will be displayed. <br />
`refreshInterval` <br />
How often, in seconds, this module will update its data. <br />
Values: A positive integer, `0...n`.

6
_site/content/posts/modules/opsgenie.md
View File

@ -11,10 +11,10 @@ and who's currently on call.
<img src="/imgs/modules/opsgenie.png" width="320" height="389" alt="opsgenie screenshot" />
## Location
## Source Code
```bash
wtf/opsgenie
wtf/opsgenie/
```
## Required ENV Variables
@ -51,4 +51,4 @@ Defines where in the grid this module's widget will be displayed. <br />
`refreshInterval` <br />
How often, in seconds, this module will update its data. <br />
Values: Any positive integer, `0...n`.
Values: A positive integer, `0...n`.

2
_site/content/posts/modules/security.md
View File

@ -31,7 +31,7 @@ connection, firewall, and DNS settings.
<li>Which <a hre="https://developers.cloudflare.com/1.1.1.1/what-is-1.1.1.1/">DNS resolvers</a> (servers) the machine is configured to use</li>
</ul>
## Location
## Source Code
```bash
wtf/security

62
_site/content/posts/modules/textfile.md Normal file
View File

@ -0,0 +1,62 @@
---
title: "Textfile"
date: 2018-05-09T11:13:11-07:00
draft: false
---
## Description
Displays the contents of the specified text file in the widget.
<img src="/imgs/modules/textfile.png" width="320" height="133" alt="textfile screenshot" />
## Source Code
```bash
wtf/textfile/
```
## Required ENV Variables
None.
## Keyboard Commands
<span class="caption">Key:</span> `h` <br />
<span class="caption">Action:</span> Open/close the widget's help window.
<span class="caption">Key:</span> `o` <br />
<span class="caption">Action:</span> Opens the text file in whichever
text editor is associated with that file type.
## Configuration
```yaml
textfile:
enabled: true
filename: "notes.md"
position:
top: 5
left: 4
height: 2
width: 1
refreshInterval: 15
```
### Attributes
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
`filename` <br />
The name of the file to be displayed in the widget. <br />
*Note:* Currently this file *must* reside in the `~/.wtf/` directory.
This is a <a href="https://github.com/senorprogrammer/wtf/issues/35">known bug</a>.
`position` <br />
Defines where in the grid this module's widget will be displayed. <br />
`refreshInterval` <br />
How often, in seconds, this module will update its data. <br />
Values: A positive integer, `0...n`.

BIN
_site/static/imgs/modules/newrelic.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 88 KiB

BIN
_site/static/imgs/modules/textfile.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 46 KiB

4
_site/themes/hyde-hyde/layouts/partials/sidebar.html
View File

@ -23,10 +23,10 @@
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/" class="disabled">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>

1
_site/themes/hyde-hyde/static/css/wtf.css
View File

@ -16,6 +16,7 @@ pre code {
span.caption {
display: inline-block;
font-weight: bold;
margin-right: 4px;
min-width: 50px;
text-align: right;

4
docs/404.html
View File

@ -63,10 +63,10 @@
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/" class="disabled">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>

4
docs/categories/index.html
View File

@ -65,10 +65,10 @@
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/" class="disabled">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>

1
docs/css/wtf.css
View File

@ -16,6 +16,7 @@ pre code {
span.caption {
display: inline-block;
font-weight: bold;
margin-right: 4px;
min-width: 50px;
text-align: right;

BIN
docs/imgs/modules/newrelic.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 88 KiB

BIN
docs/imgs/modules/textfile.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 46 KiB

4
docs/index.html
View File

@ -64,10 +64,10 @@
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/" class="disabled">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>

40
docs/index.xml
View File

@ -6,11 +6,36 @@
<description>Recent content on WTF</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Tue, 08 May 2018 20:53:40 -0700</lastBuildDate>
<lastBuildDate>Wed, 09 May 2018 11:13:11 -0700</lastBuildDate>
<atom:link href="http://wtfutil.com/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Textfile</title>
<link>http://wtfutil.com/posts/modules/textfile/</link>
<pubDate>Wed, 09 May 2018 11:13:11 -0700</pubDate>
<guid>http://wtfutil.com/posts/modules/textfile/</guid>
<description>Description Displays the contents of the specified text file in the widget.
Source Code wtf/textfile/ Required ENV Variables None.
Keyboard Commands Key: h Action: Open/close the widget&amp;rsquo;s help window.
Key: o Action: Opens the text file in whichever text editor is associated with that file type.
Configuration textfile: enabled: true filename: &amp;quot;notes.md&amp;quot; position: top: 5 left: 4 height: 2 width: 1 refreshInterval: 15 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
</item>
<item>
<title>Newrelic</title>
<link>http://wtfutil.com/posts/modules/newrelic/</link>
<pubDate>Wed, 09 May 2018 09:01:14 -0700</pubDate>
<guid>http://wtfutil.com/posts/modules/newrelic/</guid>
<description>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: 10549735 deployCount: 6 enabled: true position: top: 4 left: 3 height: 1 width: 2 refreshInterval: 900 Attributes applicationId The integer ID of the New Relic application you wish to report on.</description>
</item>
<item>
<title>Opsgenie</title>
<link>http://wtfutil.com/posts/modules/opsgenie/</link>
@ -18,10 +43,9 @@
<guid>http://wtfutil.com/posts/modules/opsgenie/</guid>
<description>Description Connects to the OpsGenie API and displays all your scheduled rotations and who&amp;rsquo;s currently on call.
Location wtf/opsgenie Required ENV Variables Key: WTF_OPS_GENIE_API_KEY Value: Your OpsGenie API token.
Source Code wtf/opsgenie/ Required ENV Variables Key: WTF_OPS_GENIE_API_KEY Value: Your OpsGenie API token.
Keyboard Commands None.
Configuration opsgenie: enabled: true position: top: 2 left: 1 height: 2 width: 1 refreshInterval: 21600 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.</description>
Configuration opsgenie: enabled: true position: top: 2 left: 1 height: 2 width: 1 refreshInterval: 21600 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.</description>
</item>
<item>
@ -31,7 +55,7 @@ position Defines where in the grid this module&amp;rsquo;s widget will be displa
<guid>http://wtfutil.com/posts/modules/security/</guid>
<description>Description Displays some general information about the state of the machine&amp;rsquo;s wifi connection, firewall, and DNS settings.
Wifi Network The name of the current network Whether or not the network uses encryption and if so, what flavour Firewall Whether or not the firewall is enabled Whether or not Stealth Mode is enabled DNS Which DNS resolvers (servers) the machine is configured to use Location wtf/security Required ENV Variables None.</description>
Wifi Network The name of the current network Whether or not the network uses encryption and if so, what flavour Firewall Whether or not the firewall is enabled Whether or not Stealth Mode is enabled DNS Which DNS resolvers (servers) the machine is configured to use Source Code wtf/security Required ENV Variables None.</description>
</item>
<item>
@ -41,10 +65,10 @@ Wifi Network The name of the current network Whether or not the network uses enc
<guid>http://wtfutil.com/posts/modules/bamboohr/</guid>
<description>Description Connects to the BambooHR API and displays who will be Away today.
Location wtf/bamboohr Required ENV Variables Key: WTF_BAMBOO_HR_TOKEN Value: Your BambooHR API token.
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: true position: top: 0 left: 1 height: 2 width: 1 refreshInterval: 900 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.</description>
Configuration bamboohr: enabled: true position: top: 0 left: 1 height: 2 width: 1 refreshInterval: 900 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
</item>
<item>
@ -54,7 +78,7 @@ Configuration bamboohr: enabled: true position: top: 0 left: 1 height: 2 width:
<guid>http://wtfutil.com/posts/modules/clocks/</guid>
<description>Description Displays a configurable list of world clocks, the local time, and date.
Location wtf/clocks/ Required ENV Variables None.
Source Code wtf/clocks/ Required ENV Variables None.
Keyboard Commands None.
Configuration clocks: colors: rows: even: &amp;quot;lightblue&amp;quot; odd: &amp;quot;white&amp;quot; enabled: true locations: # From https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Avignon: &amp;quot;Europe/Paris&amp;quot; Barcelona: &amp;quot;Europe/Madrid&amp;quot; Dubai: &amp;quot;Asia/Dubai&amp;quot; UTC: &amp;quot;Etc/UTC&amp;quot; Vancouver: &amp;quot;America/Vancouver&amp;quot; Toronto: &amp;quot;America/Toronto&amp;quot; position: top: 4 left: 0 height: 1 width: 1 refreshInterval: 15 # Valid options are: alphabetical, chronological sort: &amp;quot;alphabetical&amp;quot; Attributes colors.</description>
</item>

4
docs/posts/configuration/index.html
View File

@ -63,10 +63,10 @@
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/" class="disabled">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>

4
docs/posts/glossary/index.html
View File

@ -63,10 +63,10 @@
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/" class="disabled">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>

18
docs/posts/index.html
View File

@ -65,10 +65,10 @@
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/" class="disabled">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>
@ -89,6 +89,20 @@
<h1 class="title">Posts</h1>
<ul class="posts">
<li>
<span>
<a href="http://wtfutil.com/posts/modules/textfile/">Textfile</a>
<time class="pull-right post-list">May 09, 2018</time>
</span>
</li><li>
<span>
<a href="http://wtfutil.com/posts/modules/newrelic/">Newrelic</a>
<time class="pull-right post-list">May 09, 2018</time>
</span>
</li><li>
<span>
<a href="http://wtfutil.com/posts/modules/opsgenie/">Opsgenie</a>

40
docs/posts/index.xml
View File

@ -6,11 +6,36 @@
<description>Recent content in Posts on WTF</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Tue, 08 May 2018 20:53:40 -0700</lastBuildDate>
<lastBuildDate>Wed, 09 May 2018 11:13:11 -0700</lastBuildDate>
<atom:link href="http://wtfutil.com/posts/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Textfile</title>
<link>http://wtfutil.com/posts/modules/textfile/</link>
<pubDate>Wed, 09 May 2018 11:13:11 -0700</pubDate>
<guid>http://wtfutil.com/posts/modules/textfile/</guid>
<description>Description Displays the contents of the specified text file in the widget.
Source Code wtf/textfile/ Required ENV Variables None.
Keyboard Commands Key: h Action: Open/close the widget&amp;rsquo;s help window.
Key: o Action: Opens the text file in whichever text editor is associated with that file type.
Configuration textfile: enabled: true filename: &amp;quot;notes.md&amp;quot; position: top: 5 left: 4 height: 2 width: 1 refreshInterval: 15 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
</item>
<item>
<title>Newrelic</title>
<link>http://wtfutil.com/posts/modules/newrelic/</link>
<pubDate>Wed, 09 May 2018 09:01:14 -0700</pubDate>
<guid>http://wtfutil.com/posts/modules/newrelic/</guid>
<description>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: 10549735 deployCount: 6 enabled: true position: top: 4 left: 3 height: 1 width: 2 refreshInterval: 900 Attributes applicationId The integer ID of the New Relic application you wish to report on.</description>
</item>
<item>
<title>Opsgenie</title>
<link>http://wtfutil.com/posts/modules/opsgenie/</link>
@ -18,10 +43,9 @@
<guid>http://wtfutil.com/posts/modules/opsgenie/</guid>
<description>Description Connects to the OpsGenie API and displays all your scheduled rotations and who&amp;rsquo;s currently on call.
Location wtf/opsgenie Required ENV Variables Key: WTF_OPS_GENIE_API_KEY Value: Your OpsGenie API token.
Source Code wtf/opsgenie/ Required ENV Variables Key: WTF_OPS_GENIE_API_KEY Value: Your OpsGenie API token.
Keyboard Commands None.
Configuration opsgenie: enabled: true position: top: 2 left: 1 height: 2 width: 1 refreshInterval: 21600 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.</description>
Configuration opsgenie: enabled: true position: top: 2 left: 1 height: 2 width: 1 refreshInterval: 21600 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.</description>
</item>
<item>
@ -31,7 +55,7 @@ position Defines where in the grid this module&amp;rsquo;s widget will be displa
<guid>http://wtfutil.com/posts/modules/security/</guid>
<description>Description Displays some general information about the state of the machine&amp;rsquo;s wifi connection, firewall, and DNS settings.
Wifi Network The name of the current network Whether or not the network uses encryption and if so, what flavour Firewall Whether or not the firewall is enabled Whether or not Stealth Mode is enabled DNS Which DNS resolvers (servers) the machine is configured to use Location wtf/security Required ENV Variables None.</description>
Wifi Network The name of the current network Whether or not the network uses encryption and if so, what flavour Firewall Whether or not the firewall is enabled Whether or not Stealth Mode is enabled DNS Which DNS resolvers (servers) the machine is configured to use Source Code wtf/security Required ENV Variables None.</description>
</item>
<item>
@ -41,10 +65,10 @@ Wifi Network The name of the current network Whether or not the network uses enc
<guid>http://wtfutil.com/posts/modules/bamboohr/</guid>
<description>Description Connects to the BambooHR API and displays who will be Away today.
Location wtf/bamboohr Required ENV Variables Key: WTF_BAMBOO_HR_TOKEN Value: Your BambooHR API token.
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: true position: top: 0 left: 1 height: 2 width: 1 refreshInterval: 900 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.</description>
Configuration bamboohr: enabled: true position: top: 0 left: 1 height: 2 width: 1 refreshInterval: 900 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
</item>
<item>
@ -54,7 +78,7 @@ Configuration bamboohr: enabled: true position: top: 0 left: 1 height: 2 width:
<guid>http://wtfutil.com/posts/modules/clocks/</guid>
<description>Description Displays a configurable list of world clocks, the local time, and date.
Location wtf/clocks/ Required ENV Variables None.
Source Code wtf/clocks/ Required ENV Variables None.
Keyboard Commands None.
Configuration clocks: colors: rows: even: &amp;quot;lightblue&amp;quot; odd: &amp;quot;white&amp;quot; enabled: true locations: # From https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Avignon: &amp;quot;Europe/Paris&amp;quot; Barcelona: &amp;quot;Europe/Madrid&amp;quot; Dubai: &amp;quot;Asia/Dubai&amp;quot; UTC: &amp;quot;Etc/UTC&amp;quot; Vancouver: &amp;quot;America/Vancouver&amp;quot; Toronto: &amp;quot;America/Toronto&amp;quot; position: top: 4 left: 0 height: 1 width: 1 refreshInterval: 15 # Valid options are: alphabetical, chronological sort: &amp;quot;alphabetical&amp;quot; Attributes colors.</description>
</item>

6
docs/posts/modules/bamboohr/index.html
View File

@ -63,10 +63,10 @@
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/" class="disabled">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>
@ -107,7 +107,7 @@
<p>Connects to the BambooHR API and displays who will be Away today.</p>
<h2 id="location">Location</h2>
<h2 id="source-code">Source Code</h2>
<pre><code class="language-bash">wtf/bamboohr
</code></pre>

8
docs/posts/modules/clocks/index.html
View File

@ -63,10 +63,10 @@
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/" class="disabled">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>
@ -97,7 +97,7 @@
<br/>
<i class="fas fa-clock"></i> 1 min read
<i class="fas fa-clock"></i> 2 min read
</span>
</div>
@ -109,7 +109,7 @@
<p><img src="/imgs/modules/clocks.png" width="320" height="191" alt="clocks screenshot" /></p>
<h2 id="location">Location</h2>
<h2 id="source-code">Source Code</h2>
<pre><code class="language-bash">wtf/clocks/
</code></pre>

8
docs/posts/modules/index.html
View File

@ -63,10 +63,10 @@
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/" class="disabled">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>
@ -123,10 +123,10 @@ display in the &ldquo;Clocks&rdquo; widget.</p>
<li><a href="/posts/modules/github" class="disabled">Github</a>
<li><a href="/posts/modules/gcal" class="disabled">Google Calendar</a>
<li><a href="/posts/modules/jira" class="disabled">Jira</a>
<li><a href="/posts/modules/newrelic" class="disabled">New Relic</a>
<li><a href="/posts/modules/newrelic">New Relic</a>
<li><a href="/posts/modules/opsgenie">OpsGenie</a>
<li><a href="/posts/modules/security">Security</a>
<li><a href="/posts/modules/textfiles" class="disabled">Text Files</a>
<li><a href="/posts/modules/textfile">Text File</a>
<li><a href="/posts/modules/todo" class="disabled">Todo</a>
<li><a href="/posts/modules/weather" class="disabled">Weather</a>
</ul>

174
docs/posts/modules/newrelic/index.html Normal file
View File

@ -0,0 +1,174 @@
<!DOCTYPE html>
<html lang="en-us" class="wf-firasans-n4-active wf-active">
<head>
<link href="http://gmpg.org/xfn/11" rel="profile">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!-- Enable responsiveness on mobile devices -->
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
<meta name="generator" content="Hugo 0.38.2" />
<title>Newrelic | WTF</title>
<meta content="Newrelic - WTF" property="og:title">
<meta content=" - " property="og:description">
<!-- CSS -->
<link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
<link href="https://fonts.googleapis.com/css?family=Fira+Sans:300,300i,400,400i|Roboto+Mono:300,300i,400,400i" rel="stylesheet">
<link rel="stylesheet" href="http://wtfutil.com/css/print.css" media="print">
<link rel="stylesheet" href="http://wtfutil.com/css/poole.css">
<link rel="stylesheet" href="http://wtfutil.com/css/hyde.css">
<link rel="stylesheet" href="http://wtfutil.com/css/wtf.css">
<!-- Font-Awesome -->
<script defer src="https://use.fontawesome.com/releases/v5.0.9/js/all.js" integrity="sha384-8iPTk2s/jMVj81dnzb/iFR2sdA7u06vHJyyLlAd4snFpCl/SnyUjRrbdJsw1pGIl" crossorigin="anonymous"></script>
<!-- Customised CSS -->
<link rel="stylesheet" href="http://wtfutil.com/css/custom.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<!-- Icons -->
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png">
<link rel="shortcut icon" href="/favicon.png">
<script async defer src="https://buttons.github.io/buttons.js"></script>
</head>
<body>
<div class="sidebar">
<div class="container sidebar-sticky">
<div class="sidebar-about text-center">
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead">
</p>
</div>
<div>
<h3 style="color: white;">Content</h3>
<ul style="list-style-type: none;">
<li class="sidebar-list-item-1"><a href="/posts/installation/" class="disabled">Installation</a></li>
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
</ul>
<ul style="list-style-type: none;">
<li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/bamboohr/">BambooHR</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/clocks/">Clocks</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/git/" class="disabled">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>
</div>
<p class="copyright">
&copy; 2018 Chris Cummer.
<br />
<a href="https://creativecommons.org/licenses/by/4.0">Some Rights Reserved</a>.
</p>
<p class="copyright">
Built with <a href="https://gohugo.io/">Hugo</a> &amp; <a href="https://github.com/htr3n/hyde-hyde">hyde-hyde</a>.
</p>
</div>
</div>
<div class="content container">
<div class="post">
<h1>Newrelic</h1>
<div class="col-sm-12 col-md-12">
<span class="text-left post-date meta">
<i class="fas fa-calendar-alt"></i> May 09, 2018
<br/>
<i class="fas fa-clock"></i> 1 min read
</span>
</div>
<h2 id="description">Description</h2>
<p>Connects to the New Relic API and displays the last n deploys of the
monitored application: deploy ID, deploy time, and who deployed it.</p>
<p><img src="/imgs/modules/newrelic.png" width="640" height="189" alt="newrelic screenshot" /></p>
<h2 id="source-code">Source Code</h2>
<pre><code class="language-bash">wtf/newrelic/
</code></pre>
<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>
<pre><code class="language-yaml">newrelic:
applicationId: 10549735
deployCount: 6
enabled: true
position:
top: 4
left: 3
height: 1
width: 2
refreshInterval: 900
</code></pre>
<h3 id="attributes">Attributes</h3>
<p><code>applicationId</code> <br />
The integer ID of the New Relic application you wish to report on. <br
/>
Values: A positive integer, <code>0...n</code>.</p>
<p><code>deployCount</code> <br />
The number of past deploys to display on screen. <br />
Values: A positive integer, <code>0...n</code>.</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>
<p><code>position</code> <br />
Defines where in the grid this module&rsquo;s widget will be displayed. <br /></p>
<p><code>refreshInterval</code> <br />
How often, in seconds, this module will update its data. <br />
Values: A positive integer, <code>0...n</code>.</p>
</div>
<div class="footer">
</div>
</div>
</body>
</html>

10
docs/posts/modules/opsgenie/index.html
View File

@ -63,10 +63,10 @@
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/" class="disabled">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>
@ -110,9 +110,9 @@ and who&rsquo;s currently on call.</p>
<p><img src="/imgs/modules/opsgenie.png" width="320" height="389" alt="opsgenie screenshot" /></p>
<h2 id="location">Location</h2>
<h2 id="source-code">Source Code</h2>
<pre><code class="language-bash">wtf/opsgenie
<pre><code class="language-bash">wtf/opsgenie/
</code></pre>
<h2 id="required-env-variables">Required ENV Variables</h2>
@ -148,7 +148,7 @@ Defines where in the grid this module&rsquo;s widget will be displayed. <br /></
<p><code>refreshInterval</code> <br />
How often, in seconds, this module will update its data. <br />
Values: Any positive integer, <code>0...n</code>.</p>
Values: A positive integer, <code>0...n</code>.</p>
</div>
<div class="footer">

6
docs/posts/modules/security/index.html
View File

@ -63,10 +63,10 @@
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/" class="disabled">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>
@ -130,7 +130,7 @@ connection, firewall, and DNS settings.</p>
<li>Which <a hre="https://developers.cloudflare.com/1.1.1.1/what-is-1.1.1.1/">DNS resolvers</a> (servers) the machine is configured to use</li>
</ul>
<h2 id="location">Location</h2>
<h2 id="source-code">Source Code</h2>
<pre><code class="language-bash">wtf/security
</code></pre>

171
docs/posts/modules/textfile/index.html Normal file
View File

@ -0,0 +1,171 @@
<!DOCTYPE html>
<html lang="en-us" class="wf-firasans-n4-active wf-active">
<head>
<link href="http://gmpg.org/xfn/11" rel="profile">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<!-- Enable responsiveness on mobile devices -->
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
<meta name="generator" content="Hugo 0.38.2" />
<title>Textfile | WTF</title>
<meta content="Textfile - WTF" property="og:title">
<meta content=" - " property="og:description">
<!-- CSS -->
<link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
<link href="https://fonts.googleapis.com/css?family=Fira+Sans:300,300i,400,400i|Roboto+Mono:300,300i,400,400i" rel="stylesheet">
<link rel="stylesheet" href="http://wtfutil.com/css/print.css" media="print">
<link rel="stylesheet" href="http://wtfutil.com/css/poole.css">
<link rel="stylesheet" href="http://wtfutil.com/css/hyde.css">
<link rel="stylesheet" href="http://wtfutil.com/css/wtf.css">
<!-- Font-Awesome -->
<script defer src="https://use.fontawesome.com/releases/v5.0.9/js/all.js" integrity="sha384-8iPTk2s/jMVj81dnzb/iFR2sdA7u06vHJyyLlAd4snFpCl/SnyUjRrbdJsw1pGIl" crossorigin="anonymous"></script>
<!-- Customised CSS -->
<link rel="stylesheet" href="http://wtfutil.com/css/custom.css">
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<!-- Icons -->
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png">
<link rel="shortcut icon" href="/favicon.png">
<script async defer src="https://buttons.github.io/buttons.js"></script>
</head>
<body>
<div class="sidebar">
<div class="container sidebar-sticky">
<div class="sidebar-about text-center">
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead">
</p>
</div>
<div>
<h3 style="color: white;">Content</h3>
<ul style="list-style-type: none;">
<li class="sidebar-list-item-1"><a href="/posts/installation/" class="disabled">Installation</a></li>
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
</ul>
<ul style="list-style-type: none;">
<li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/bamboohr/">BambooHR</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/clocks/">Clocks</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/git/" class="disabled">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>
</div>
<p class="copyright">
&copy; 2018 Chris Cummer.
<br />
<a href="https://creativecommons.org/licenses/by/4.0">Some Rights Reserved</a>.
</p>
<p class="copyright">
Built with <a href="https://gohugo.io/">Hugo</a> &amp; <a href="https://github.com/htr3n/hyde-hyde">hyde-hyde</a>.
</p>
</div>
</div>
<div class="content container">
<div class="post">
<h1>Textfile</h1>
<div class="col-sm-12 col-md-12">
<span class="text-left post-date meta">
<i class="fas fa-calendar-alt"></i> May 09, 2018
<br/>
<i class="fas fa-clock"></i> 1 min read
</span>
</div>
<h2 id="description">Description</h2>
<p>Displays the contents of the specified text file in the widget.</p>
<p><img src="/imgs/modules/textfile.png" width="320" height="133" alt="textfile screenshot" /></p>
<h2 id="source-code">Source Code</h2>
<pre><code class="language-bash">wtf/textfile/
</code></pre>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p>None.</p>
<h2 id="keyboard-commands">Keyboard Commands</h2>
<p><span class="caption">Key:</span> <code>h</code> <br />
<span class="caption">Action:</span> Open/close the widget&rsquo;s help window.</p>
<p><span class="caption">Key:</span> <code>o</code> <br />
<span class="caption">Action:</span> Opens the text file in whichever
text editor is associated with that file type.</p>
<h2 id="configuration">Configuration</h2>
<pre><code class="language-yaml">textfile:
enabled: true
filename: &quot;notes.md&quot;
position:
top: 5
left: 4
height: 2
width: 1
refreshInterval: 15
</code></pre>
<h3 id="attributes">Attributes</h3>
<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>
<p><code>filename</code> <br />
The name of the file to be displayed in the widget. <br />
<em>Note:</em> Currently this file <em>must</em> reside in the <code>~/.wtf/</code> directory.
This is a <a href="https://github.com/senorprogrammer/wtf/issues/35">known bug</a>.</p>
<p><code>position</code> <br />
Defines where in the grid this module&rsquo;s widget will be displayed. <br /></p>
<p><code>refreshInterval</code> <br />
How often, in seconds, this module will update its data. <br />
Values: A positive integer, <code>0...n</code>.</p>
</div>
<div class="footer">
</div>
</div>
</body>
</html>

14
docs/sitemap.xml
View File

@ -2,6 +2,16 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
xmlns:xhtml="http://www.w3.org/1999/xhtml">
<url>
<loc>http://wtfutil.com/posts/modules/textfile/</loc>
<lastmod>2018-05-09T11:13:11-07:00</lastmod>
</url>
<url>
<loc>http://wtfutil.com/posts/modules/newrelic/</loc>
<lastmod>2018-05-09T09:01:14-07:00</lastmod>
</url>
<url>
<loc>http://wtfutil.com/posts/modules/opsgenie/</loc>
<lastmod>2018-05-08T20:53:40-07:00</lastmod>
@ -44,7 +54,7 @@
<url>
<loc>http://wtfutil.com/posts/</loc>
<lastmod>2018-05-08T20:53:40-07:00</lastmod>
<lastmod>2018-05-09T11:13:11-07:00</lastmod>
<priority>0</priority>
</url>
@ -55,7 +65,7 @@
<url>
<loc>http://wtfutil.com/</loc>
<lastmod>2018-05-08T20:53:40-07:00</lastmod>
<lastmod>2018-05-09T11:13:11-07:00</lastmod>
<priority>0</priority>
</url>

4
docs/tags/index.html
View File

@ -65,10 +65,10 @@
<li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/" class="disabled">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
</ul>