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

Build of the site

Browse Source
This commit is contained in:
Chris Cummer 2018-05-08 20:24:31 -07:00
parent b55ca47678
commit 7edc5f8339
37 changed files with 1093 additions and 195 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
.DS_Store vendored
View File

Binary file not shown.

1
_site/config.toml
View File

@ -3,6 +3,7 @@ languageCode = "en-us"
publishDir = "../docs" publishDir = "../docs"
sectionPagesMenu = "main" sectionPagesMenu = "main"
theme = "hyde-hyde" theme = "hyde-hyde"
title = "WTF"
[params] [params]
author = "Chris Cummer" author = "Chris Cummer"

30
_site/content/posts/configuration.md
View File

@ -5,32 +5,32 @@ draft: false
--- ---
By default WTF looks in a `~/.wtf/` directory for a YAML file called By default WTF looks in a `~/.wtf/` directory for a YAML file called
`config.yml`. If `~/.wtf/` doesn't exist, WTF will create that directory `config.yml`. If the `~/.wtf/` directory doesn't exist, WTF will create that directory
on start-up, and then display instructions for creating the on start-up, and then display instructions for creating a new
configuration file. configuration file.
## Config.yml In other words, WTF expects to have a YAML config file at: `~/.wtf/config.yml`.
## Example Config Files ## Example Configuration Files
A few example config files are provided in the `_sample_configs/` A couple of example config files are provided in the `_sample_configs/`
directory of the Git repository. To try out WTF quickly, copy directory of the Git repository.
To try out WTF quickly, copy
`simple_config.yml` into `~/.wtf/` as `config.yml` and relaunch WTF. You `simple_config.yml` into `~/.wtf/` as `config.yml` and relaunch WTF. You
should see the app launch and display the _Security_ and _Status_ should see the app launch and display the <a href="/posts/modules/security/">Security</a>,
modules. <a href="/posts/modules/clocks/">Clocks</a> and <a href="/posts/modules/status/">Status</a> widgets onscreen.
## Custom Configuration Files ## Custom Configuration Files
To try out different configurations (or run multiple instances of WTF),
you can pass the path to a config file via command line arguments on
start-up.
To load a custom configuration file (ie: one that's not To load a custom configuration file (ie: one that's not
`~/.wtf/config.yml`), pass in the path to configuration file as a `~/.wtf/config.yml`), pass in the path to configuration file as a
parameter on launch: parameter on launch:
```bash ```bash
$> wtf --config=path/to/custom/config.yml $> wtf --config=path/to/custom/config.yml
``` ```
Example:
```bash
%> wtf --config=~/Documents/monitoring.yml
```
This is also the easiest way to run multiple instances of WTF, should
you want to run multiple independent dashboards.

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

@ -1,7 +1,35 @@
--- ---
title: "Modules" title: "Modules"
date: 2018-05-07T18:04:58-07:00 date: 2018-05-07T18:04:58-07:00
draft: true draft: false
--- ---
The heart of WTF is the modules. A module is a discreet unit of
functionality that extracts data from some source and packages that data
for display.
For example, the <a href="/posts/modules/newrelic">New Relic</a> module
uses New Relic's API to retrieve a list of the latest deploys and
packages that information as a list for display in the "New Relic"
widget.
The <a href="/posts/modules/clocks">Clocks</a> module takes a list of
timezones and packages that information as a list of city/time pairs for
display in the "Clocks" widget.
Available modules:
<ul class="list-bare">
<li><a href="/posts/modules/bamboohr">BambooHR</a>
<li><a href="/posts/modules/clocks">Clocks</a>
<li><a href="/posts/modules/git">Git</a>
<li><a href="/posts/modules/github">Github</a>
<li><a href="/posts/modules/gcal">Google Calendar</a>
<li><a href="/posts/modules/jira">Jira</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">Text Files</a>
<li><a href="/posts/modules/todo">Todo</a>
<li><a href="/posts/modules/weather">Weather</a>
</ul>

53
_site/content/posts/modules/bamboohr.md Normal file
View File

@ -0,0 +1,53 @@
---
title: "Bamboohr"
date: 2018-05-07T20:17:37-07:00
draft: false
---
## Description
Connects to the BambooHR API and displays who will be Away today.
## Location
```bash
wtf/bamboohr
```
## Required ENV Variables
`WTF_BAMBOO_HR_TOKEN` <br />
Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> token.
`WTF_BAMBOO_HR_SUBDOMAIN` <br />
Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> subdomain name.
## Keyboard Commands
None.
## Configuration
```yaml
bamboohr:
enabled: true
position:
top: 0
left: 1
height: 2
width: 1
refreshInterval: 900
```
### Definitions
`enabled` <br />
Whether or not this module is executed and 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: Any positive integer, `0...n`.

82
_site/content/posts/modules/clocks.md Normal file
View File

@ -0,0 +1,82 @@
---
title: "Clocks"
date: 2018-05-07T19:47:31-07:00
draft: false
---
## Description
Displays a configurable list of world clocks, the local time, and date.
<img src="/imgs/modules/clocks.png" width="320" height="180" alt="clocks screenshot" />
## Location
```bash
wtf/clocks/
```
## Required ENV Variables
None.
## Keyboard Commands
None.
## Configuration
```yaml
clocks:
colors:
rows:
even: "lightblue"
odd: "white"
enabled: true
locations:
# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Avignon: "Europe/Paris"
Barcelona: "Europe/Madrid"
Dubai: "Asia/Dubai"
UTC: "Etc/UTC"
Vancouver: "America/Vancouver"
Toronto: "America/Toronto"
position:
top: 4
left: 0
height: 1
width: 1
refreshInterval: 15
# Valid options are: alphabetical, chronological
sort: "alphabetical"
```
### Definitions
`colors.even` <br />
Define the text color for even-numbered rows (2, 4, 6...). <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.
`colors.odd` <br />
Define the text color for the odd-numbered rows (1, 3, 5...). <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.
`locations` <br />
Defines the timezones for the world clocks that you want to display.
`key` is a unique label that will be displayed in the UI. `value` is a
timezone name. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">TZ database timezone</a>.
`position` <br />
Defines where in the grid this module's widget will be displayed.
`refreshInterval` <br />
How often, in seconds, this module will update its data. <br />
Values: Any positive integer, `0...n`.
`sort` <br />
Defines the display order of the clocks in the widget. <br />
Values: `alphabetical` or `chronological`. `alphabetical` will sort in
acending order by `key`, `chronological` will sort in ascending order by
date/time.

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 62 KiB

BIN
_site/themes/hyde-hyde/images/main.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 317 KiB

BIN
_site/themes/hyde-hyde/images/posts.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 179 KiB

BIN
_site/themes/hyde-hyde/images/tn.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 204 KiB

8
_site/themes/hyde-hyde/layouts/index.html
View File

@ -3,14 +3,14 @@
{{- end }} {{- end }}
{{ define "content" -}} {{ define "content" -}}
<div style="float: right;"> <!--<div style="float: right;">-->
<a class="github-button" href="https://github.com/senorprogrammer/wtf" data-show-count="true" aria-label="Star senorprogrammer/wtf on GitHub">Star</a> <!--<a class="github-button" href="https://github.com/senorprogrammer/wtf" data-show-count="true" aria-label="Star senorprogrammer/wtf on GitHub">Star</a>-->
</div> <!--</div>-->
<a href="/img/screenshot.png" target="_screenshot"><img src='/img/screenshot_sm.png' /></a> <a href="/img/screenshot.png" target="_screenshot"><img src='/img/screenshot_sm.png' /></a>
<p> <p>
<span style="font-family: monospace; font-size: 1.5em;">WTF</span> is a personal information dashboard for your <span style="font-family: monospace; font-size: 1.6em;">WTF</span> is a personal information dashboard for your
terminal, made for those who spend most of their days in the command line. terminal, made for those who spend most of their days in the command line.
</p> </p>

2
_site/themes/hyde-hyde/layouts/partials/header.html
View File

@ -9,7 +9,7 @@
{{ if .IsHome -}} {{ if .IsHome -}}
<title>{{ .Site.Title }}</title> <title>{{ .Site.Title }}</title>
{{- else }} {{- else }}
<title>{{ .Title }} &middot; {{ .Site.Title }}</title> <title>{{ .Title }} | {{ .Site.Title }}</title>
{{- end }} {{- end }}
<meta content="{{ $isHomePage := eq .Title .Site.Title }}{{ .Title }}{{ if eq $isHomePage false }} - {{ .Site.Title }}{{ end }}" property="og:title"> <meta content="{{ $isHomePage := eq .Title .Site.Title }}{{ .Title }}{{ if eq $isHomePage false }} - {{ .Site.Title }}{{ end }}" property="og:title">
<meta content="{{ $isHomePage := eq .Title .Site.Title }}{{ .Site.Params.meta.description }}{{ if eq $isHomePage false }} - {{ .Description }}{{ end }}" property="og:description"> <meta content="{{ $isHomePage := eq .Title .Site.Title }}{{ .Site.Params.meta.description }}{{ if eq $isHomePage false }} - {{ .Description }}{{ end }}" property="og:description">

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

@ -1,7 +1,7 @@
<div class="sidebar"> <div class="sidebar">
<div class="container sidebar-sticky"> <div class="container sidebar-sticky">
<div class="sidebar-about text-center"> <div class="sidebar-about text-center">
<a href="{{ .Site.BaseURL }}"><h1 class="brand">{{ .Site.Title }}</h1></a> <!--<a href="{{ .Site.BaseURL }}"><h1 class="brand">{{ .Site.Title }}</h1></a>-->
<a href="{{ .Site.BaseURL }}">{{ with .Site.Params.authorimage }} <img src="{{.}}" alt="WFT Logo" class="" width=""> {{ end }}</a> <a href="{{ .Site.BaseURL }}">{{ with .Site.Params.authorimage }} <img src="{{.}}" alt="WFT Logo" class="" width=""> {{ end }}</a>
<p class="lead"> <p class="lead">
{{ with .Site.Params.description }} {{.}} {{ else }} {{end}} {{ with .Site.Params.description }} {{.}} {{ else }} {{end}}
@ -19,24 +19,20 @@
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li> <li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;">
<li class="sidebar-list-item-1"><a href="/posts/source/">Source Code</a></li>
</ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li> <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/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/clocks/">Clocks</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/git">Git</a></li> <li class="sidebar-list-item-2"><a href="/posts/modules/git/">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github">Github</a></li> <li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal">Google Calendar</a></li> <li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira">Jira</a></li> <li class="sidebar-list-item-2"><a href="/posts/modules/jira/">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/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/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/security/">Security</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/textfiles">Text Files</a></li> <li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo">Todo</a></li> <li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather">Weather</a></li> <li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
</ul> </ul>
</div> </div>

11
_site/themes/hyde-hyde/static/css/custom.css
View File

@ -52,12 +52,15 @@ pre
pre code, li code, td code, code pre code, li code, td code, code
{ {
border-radius: 4px; /*border-radius: 4px;*/
white-space: pre-wrap; white-space: pre-wrap;
padding:1px 4px; background-color: white;
background: #eee; margin: 0 !important;
padding: 0;
/*padding:1px 4px;*/
/*background: #eee;*/
/* color: #444; */ /* color: #444; */
border: 1px solid #d9d9d9; /*border: 1px solid #d9d9d9;*/
} }
code { code {

8
_site/themes/hyde-hyde/static/css/poole.css
View File

@ -150,11 +150,11 @@ pre {
font-family: Menlo, Monaco, "Courier New", monospace; font-family: Menlo, Monaco, "Courier New", monospace;
} }
code { code {
padding: .25em .5em; /*padding: .25em .5em;*/
font-size: 85%; font-size: 85%;
color: #bf616a; color: #bf616a;
background-color: #f9f9f9; /*background-color: #f9f9f9;*/
border-radius: 3px; /*border-radius: 3px;*/
} }
pre { pre {
display: block; display: block;
@ -173,7 +173,7 @@ pre code {
padding: 0; padding: 0;
font-size: 100%; font-size: 100%;
color: inherit; color: inherit;
background-color: transparent; /*background-color: transparent;*/
} }
.highlight { .highlight {
margin-bottom: 1rem; margin-bottom: 1rem;

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

@ -1,3 +1,27 @@
h1, h2, h3 {
letter-spacing: 0.25px;
}
h2 {
margin-top: 24px;
}
p {
font-size: 16px;
}
pre code {
padding-left: 8px !important;
}
.list-bare {
list-style-type: none;
}
.list-bare li {
margin: 2px 0 0 12px;
}
.sidebar-list-item-1 { .sidebar-list-item-1 {
font-size: 0.9em; font-size: 0.9em;
margin: 0 0 0 12px; margin: 0 0 0 12px;

4
bamboohr/widget.go
View File

@ -30,9 +30,7 @@ func (widget *Widget) Refresh() {
return return
} }
url, _ := Config.String("wtf.mods.bamboohr.url") client := NewClient("https://api.bamboohr.com/api/gateway.php")
client := NewClient(url)
todayItems := client.Away( todayItems := client.Away(
"timeOff", "timeOff",
wtf.Now().Format(wtf.DateFormat), wtf.Now().Format(wtf.DateFormat),

41
docs/404.html
View File

@ -10,8 +10,8 @@
<meta name="generator" content="Hugo 0.38.2" /> <meta name="generator" content="Hugo 0.38.2" />
<title>404 Page not found &middot; </title> <title>404 Page not found | WTF</title>
<meta content="404 Page not found - " property="og:title"> <meta content="404 Page not found - WTF" property="og:title">
<meta content=" - " property="og:description"> <meta content=" - " property="og:description">
<!-- CSS --> <!-- CSS -->
<link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css"> <link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
@ -19,6 +19,7 @@
<link rel="stylesheet" href="http://wtfutil.com/css/print.css" media="print"> <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/poole.css">
<link rel="stylesheet" href="http://wtfutil.com/css/hyde.css"> <link rel="stylesheet" href="http://wtfutil.com/css/hyde.css">
<link rel="stylesheet" href="http://wtfutil.com/css/wtf.css">
<!-- Font-Awesome --> <!-- 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> <script defer src="https://use.fontawesome.com/releases/v5.0.9/js/all.js" integrity="sha384-8iPTk2s/jMVj81dnzb/iFR2sdA7u06vHJyyLlAd4snFpCl/SnyUjRrbdJsw1pGIl" crossorigin="anonymous"></script>
@ -40,7 +41,7 @@
<div class="sidebar"> <div class="sidebar">
<div class="container sidebar-sticky"> <div class="container sidebar-sticky">
<div class="sidebar-about text-center"> <div class="sidebar-about text-center">
<a href="http://wtfutil.com/"><h1 class="brand"></h1></a>
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a> <a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead"> <p class="lead">
@ -50,30 +51,28 @@
<div> <div>
<h3 style="color: white;">Content</h3> <h3 style="color: white;">Content</h3>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/Installation/">Installation</a></li> <li class="sidebar-list-item-1"><a href="/posts/overview/">Overview</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/modules/">Modules</a></li> <li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/glossary/">Glossary</a></li> <li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/source/">Source Code</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/">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">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/textfiles/">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
</ul> </ul>
</div> </div>

33
docs/categories/index.html
View File

@ -10,8 +10,8 @@
<meta name="generator" content="Hugo 0.38.2" /> <meta name="generator" content="Hugo 0.38.2" />
<title>Categories &middot; </title> <title>Categories | WTF</title>
<meta content="Categories - " property="og:title"> <meta content="Categories - WTF" property="og:title">
<meta content=" - " property="og:description"> <meta content=" - " property="og:description">
<!-- CSS --> <!-- CSS -->
<link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css"> <link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
@ -19,6 +19,7 @@
<link rel="stylesheet" href="http://wtfutil.com/css/print.css" media="print"> <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/poole.css">
<link rel="stylesheet" href="http://wtfutil.com/css/hyde.css"> <link rel="stylesheet" href="http://wtfutil.com/css/hyde.css">
<link rel="stylesheet" href="http://wtfutil.com/css/wtf.css">
<!-- Font-Awesome --> <!-- 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> <script defer src="https://use.fontawesome.com/releases/v5.0.9/js/all.js" integrity="sha384-8iPTk2s/jMVj81dnzb/iFR2sdA7u06vHJyyLlAd4snFpCl/SnyUjRrbdJsw1pGIl" crossorigin="anonymous"></script>
@ -33,8 +34,8 @@
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png"> <link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png">
<link rel="shortcut icon" href="/favicon.png"> <link rel="shortcut icon" href="/favicon.png">
<!-- RSS --> <!-- RSS -->
<link href="http://wtfutil.com/categories/index.xml" rel="alternate" type="application/rss+xml" title="" /> <link href="http://wtfutil.com/categories/index.xml" rel="alternate" type="application/rss+xml" title="WTF" />
<link href="http://wtfutil.com/categories/index.xml" rel="feed" type="application/rss+xml" title="" /> <link href="http://wtfutil.com/categories/index.xml" rel="feed" type="application/rss+xml" title="WTF" />
<script async defer src="https://buttons.github.io/buttons.js"></script> <script async defer src="https://buttons.github.io/buttons.js"></script>
</head> </head>
@ -42,7 +43,7 @@
<div class="sidebar"> <div class="sidebar">
<div class="container sidebar-sticky"> <div class="container sidebar-sticky">
<div class="sidebar-about text-center"> <div class="sidebar-about text-center">
<a href="http://wtfutil.com/"><h1 class="brand"></h1></a>
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a> <a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead"> <p class="lead">
@ -52,18 +53,28 @@
<div> <div>
<h3 style="color: white;">Content</h3> <h3 style="color: white;">Content</h3>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/Installation/">Installation</a></li> <li class="sidebar-list-item-1"><a href="/posts/overview/">Overview</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/modules/">Modules</a></li> <li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/glossary/">Glossary</a></li> <li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/source/">Source Code</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/">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">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/textfiles/">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
</ul> </ul>
</div> </div>

4
docs/categories/index.xml
View File

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="yes" ?> <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel> <channel>
<title>Categories on </title> <title>Categories on WTF</title>
<link>http://wtfutil.com/categories/</link> <link>http://wtfutil.com/categories/</link>
<description>Recent content in Categories on </description> <description>Recent content in Categories on WTF</description>
<generator>Hugo -- gohugo.io</generator> <generator>Hugo -- gohugo.io</generator>
<language>en-us</language> <language>en-us</language>

11
docs/css/custom.css
View File

@ -52,12 +52,15 @@ pre
pre code, li code, td code, code pre code, li code, td code, code
{ {
border-radius: 4px; /*border-radius: 4px;*/
white-space: pre-wrap; white-space: pre-wrap;
padding:1px 4px; background-color: white;
background: #eee; margin: 0 !important;
padding: 0;
/*padding:1px 4px;*/
/*background: #eee;*/
/* color: #444; */ /* color: #444; */
border: 1px solid #d9d9d9; /*border: 1px solid #d9d9d9;*/
} }
code { code {

8
docs/css/poole.css
View File

@ -150,11 +150,11 @@ pre {
font-family: Menlo, Monaco, "Courier New", monospace; font-family: Menlo, Monaco, "Courier New", monospace;
} }
code { code {
padding: .25em .5em; /*padding: .25em .5em;*/
font-size: 85%; font-size: 85%;
color: #bf616a; color: #bf616a;
background-color: #f9f9f9; /*background-color: #f9f9f9;*/
border-radius: 3px; /*border-radius: 3px;*/
} }
pre { pre {
display: block; display: block;
@ -173,7 +173,7 @@ pre code {
padding: 0; padding: 0;
font-size: 100%; font-size: 100%;
color: inherit; color: inherit;
background-color: transparent; /*background-color: transparent;*/
} }
.highlight { .highlight {
margin-bottom: 1rem; margin-bottom: 1rem;

33
docs/css/wtf.css Normal file
View File

@ -0,0 +1,33 @@
h1, h2, h3 {
letter-spacing: 0.25px;
}
h2 {
margin-top: 24px;
}
p {
font-size: 16px;
}
pre code {
padding-left: 8px !important;
}
.list-bare {
list-style-type: none;
}
.list-bare li {
margin: 2px 0 0 12px;
}
.sidebar-list-item-1 {
font-size: 0.9em;
margin: 0 0 0 12px;
}
.sidebar-list-item-2 {
font-size: 0.9em;
margin: 0 0 0 24px;
}

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

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 62 KiB

53
docs/index.html
View File

@ -9,8 +9,8 @@
<meta name="generator" content="Hugo 0.38.2" /> <meta name="generator" content="Hugo 0.38.2" />
<title></title> <title>WTF</title>
<meta content="" property="og:title"> <meta content="WTF" property="og:title">
<meta content="" property="og:description"> <meta content="" property="og:description">
<!-- CSS --> <!-- CSS -->
<link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css"> <link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
@ -18,6 +18,7 @@
<link rel="stylesheet" href="http://wtfutil.com/css/print.css" media="print"> <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/poole.css">
<link rel="stylesheet" href="http://wtfutil.com/css/hyde.css"> <link rel="stylesheet" href="http://wtfutil.com/css/hyde.css">
<link rel="stylesheet" href="http://wtfutil.com/css/wtf.css">
<!-- Font-Awesome --> <!-- 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> <script defer src="https://use.fontawesome.com/releases/v5.0.9/js/all.js" integrity="sha384-8iPTk2s/jMVj81dnzb/iFR2sdA7u06vHJyyLlAd4snFpCl/SnyUjRrbdJsw1pGIl" crossorigin="anonymous"></script>
@ -32,8 +33,8 @@
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png"> <link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png">
<link rel="shortcut icon" href="/favicon.png"> <link rel="shortcut icon" href="/favicon.png">
<!-- RSS --> <!-- RSS -->
<link href="http://wtfutil.com/index.xml" rel="alternate" type="application/rss+xml" title="" /> <link href="http://wtfutil.com/index.xml" rel="alternate" type="application/rss+xml" title="WTF" />
<link href="http://wtfutil.com/index.xml" rel="feed" type="application/rss+xml" title="" /> <link href="http://wtfutil.com/index.xml" rel="feed" type="application/rss+xml" title="WTF" />
<script async defer src="https://buttons.github.io/buttons.js"></script> <script async defer src="https://buttons.github.io/buttons.js"></script>
</head> </head>
@ -41,7 +42,7 @@
<div class="sidebar"> <div class="sidebar">
<div class="container sidebar-sticky"> <div class="container sidebar-sticky">
<div class="sidebar-about text-center"> <div class="sidebar-about text-center">
<a href="http://wtfutil.com/"><h1 class="brand"></h1></a>
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a> <a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead"> <p class="lead">
@ -51,22 +52,28 @@
<div> <div>
<h3 style="color: white;">Content</h3> <h3 style="color: white;">Content</h3>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/Installation/">Installation</a></li> <li class="sidebar-list-item-1"><a href="/posts/overview/">Overview</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/modules/">Modules</a></li> <li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/glossary/">Glossary</a></li> <li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/source/">Source Code</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/">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">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/textfiles/">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
</ul> </ul>
</div> </div>
@ -82,14 +89,14 @@
</div> </div>
<div class="content container"> <div class="content container">
<div style="float: right;">
<a class="github-button" href="https://github.com/senorprogrammer/wtf" data-show-count="true" aria-label="Star senorprogrammer/wtf on GitHub">Star</a>
</div>
<a href="/img/screenshot.png" target="_screenshot"><img src='/img/screenshot_sm.png' /></a> <a href="/img/screenshot.png" target="_screenshot"><img src='/img/screenshot_sm.png' /></a>
<p> <p>
<span style="font-family: monospace; font-size: 1.5em;">WTF</span> is a personal information dashboard for your <span style="font-family: monospace; font-size: 1.6em;">WTF</span> is a personal information dashboard for your
terminal, made for those who spend most of their days in the command line. terminal, made for those who spend most of their days in the command line.
</p> </p>
@ -105,10 +112,10 @@
See who's away in BambooHR, which Jira tickets are assigned to you, and what time it is in Barcelona. See who's away in BambooHR, which Jira tickets are assigned to you, and what time it is in Barcelona.
</p> </p>
<p>
If you're a developer, adding new functionality is as easy as writing a new module in
<a href="https://golang.org">Go</a>, connecting it to whichever API you want, and writing that data to screen.
<p>
<p> <p>
It even has weather. And emoji. Just enough emoji. It even has weather. And emoji. Just enough emoji.

48
docs/index.xml
View File

@ -1,16 +1,53 @@
<?xml version="1.0" encoding="utf-8" standalone="yes" ?> <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel> <channel>
<title></title> <title>WTF</title>
<link>http://wtfutil.com/</link> <link>http://wtfutil.com/</link>
<description>Recent content on </description> <description>Recent content on WTF</description>
<generator>Hugo -- gohugo.io</generator> <generator>Hugo -- gohugo.io</generator>
<language>en-us</language> <language>en-us</language>
<lastBuildDate>Tue, 17 Apr 2018 12:34:51 -0700</lastBuildDate> <lastBuildDate>Mon, 07 May 2018 20:17:37 -0700</lastBuildDate>
<atom:link href="http://wtfutil.com/index.xml" rel="self" type="application/rss+xml" /> <atom:link href="http://wtfutil.com/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Bamboohr</title>
<link>http://wtfutil.com/posts/modules/bamboohr/</link>
<pubDate>Mon, 07 May 2018 20:17:37 -0700</pubDate>
<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 WTF_BAMBOO_HR_TOKEN Your BambooHR API token.
WTF_BAMBOO_HR_SUBDOMAIN Your BambooHR API subdomain name.
Keyboard Commands None.
Configuration bamboohr: enabled: true position: top: 0 left: 1 height: 2 width: 1 refreshInterval: 900 Definitions enabled Whether or not this module is executed and its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item>
<item>
<title>Clocks</title>
<link>http://wtfutil.com/posts/modules/clocks/</link>
<pubDate>Mon, 07 May 2018 19:47:31 -0700</pubDate>
<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.
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; Definitions colors.</description>
</item>
<item>
<title>Modules</title>
<link>http://wtfutil.com/posts/modules/</link>
<pubDate>Mon, 07 May 2018 18:04:58 -0700</pubDate>
<guid>http://wtfutil.com/posts/modules/</guid>
<description>The heart of WTF is the modules. A module is a discreet unit of functionality that extracts data from some source and packages that data for display.
For example, the New Relic module uses New Relic&amp;rsquo;s API to retrieve a list of the latest deploys and packages that information as a list for display in the &amp;ldquo;New Relic&amp;rdquo; widget.
The Clocks module takes a list of timezones and packages that information as a list of city/time pairs for display in the &amp;ldquo;Clocks&amp;rdquo; widget.</description>
</item>
<item> <item>
<title>Glossary</title> <title>Glossary</title>
<link>http://wtfutil.com/posts/glossary/</link> <link>http://wtfutil.com/posts/glossary/</link>
@ -29,8 +66,9 @@ Widgets are defined by a required widget.go file in a Module.</description>
<pubDate>Sun, 15 Apr 2018 21:17:16 -0700</pubDate> <pubDate>Sun, 15 Apr 2018 21:17:16 -0700</pubDate>
<guid>http://wtfutil.com/posts/configuration/</guid> <guid>http://wtfutil.com/posts/configuration/</guid>
<description>By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If ~/.wtf/ doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating the configuration file. <description>By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If the ~/.wtf/ directory doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file.
Config.yml Example Config Files A few example config files are provided in the _sample_configs/ directory of the Git repository. To try out WTF quickly, copy simple_config.yml into ~/.wtf/ as config.yml and relaunch WTF. You should see the app launch and display the Security and Status modules.</description> In other words, WTF expects to have a YAML config file at: ~/.wtf/config.yml.
Example Configuration Files A couple of example config files are provided in the _sample_configs/ directory of the Git repository.</description>
</item> </item>
</channel> </channel>

BIN
docs/modules/clocks.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 103 KiB

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

@ -10,8 +10,8 @@
<meta name="generator" content="Hugo 0.38.2" /> <meta name="generator" content="Hugo 0.38.2" />
<title>Configuration &middot; </title> <title>Configuration | WTF</title>
<meta content="Configuration - " property="og:title"> <meta content="Configuration - WTF" property="og:title">
<meta content=" - " property="og:description"> <meta content=" - " property="og:description">
<!-- CSS --> <!-- CSS -->
<link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css"> <link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
@ -19,6 +19,7 @@
<link rel="stylesheet" href="http://wtfutil.com/css/print.css" media="print"> <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/poole.css">
<link rel="stylesheet" href="http://wtfutil.com/css/hyde.css"> <link rel="stylesheet" href="http://wtfutil.com/css/hyde.css">
<link rel="stylesheet" href="http://wtfutil.com/css/wtf.css">
<!-- Font-Awesome --> <!-- 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> <script defer src="https://use.fontawesome.com/releases/v5.0.9/js/all.js" integrity="sha384-8iPTk2s/jMVj81dnzb/iFR2sdA7u06vHJyyLlAd4snFpCl/SnyUjRrbdJsw1pGIl" crossorigin="anonymous"></script>
@ -40,7 +41,7 @@
<div class="sidebar"> <div class="sidebar">
<div class="container sidebar-sticky"> <div class="container sidebar-sticky">
<div class="sidebar-about text-center"> <div class="sidebar-about text-center">
<a href="http://wtfutil.com/"><h1 class="brand"></h1></a>
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a> <a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead"> <p class="lead">
@ -50,18 +51,28 @@
<div> <div>
<h3 style="color: white;">Content</h3> <h3 style="color: white;">Content</h3>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/Installation/">Installation</a></li> <li class="sidebar-list-item-1"><a href="/posts/overview/">Overview</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/modules/">Modules</a></li> <li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/glossary/">Glossary</a></li> <li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/source/">Source Code</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/">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">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/textfiles/">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
</ul> </ul>
</div> </div>
@ -97,22 +108,28 @@
<p>By default WTF looks in a <code>~/.wtf/</code> directory for a YAML file called <p>By default WTF looks in a <code>~/.wtf/</code> directory for a YAML file called
<code>config.yml</code>. If <code>~/.wtf/</code> doesn&rsquo;t exist, WTF will create that directory <code>config.yml</code>. If the <code>~/.wtf/</code> directory doesn&rsquo;t exist, WTF will create that directory
on start-up, and then display instructions for creating the on start-up, and then display instructions for creating a new
configuration file.</p> configuration file.</p>
<h2 id="config-yml">Config.yml</h2> <p>In other words, WTF expects to have a YAML config file at: <code>~/.wtf/config.yml</code>.</p>
<h2 id="example-config-files">Example Config Files</h2> <h2 id="example-configuration-files">Example Configuration Files</h2>
<p>A few example config files are provided in the <code>_sample_configs/</code> <p>A couple of example config files are provided in the <code>_sample_configs/</code>
directory of the Git repository. To try out WTF quickly, copy directory of the Git repository.</p>
<p>To try out WTF quickly, copy
<code>simple_config.yml</code> into <code>~/.wtf/</code> as <code>config.yml</code> and relaunch WTF. You <code>simple_config.yml</code> into <code>~/.wtf/</code> as <code>config.yml</code> and relaunch WTF. You
should see the app launch and display the <em>Security</em> and <em>Status</em> should see the app launch and display the <a href="/posts/modules/security/">Security</a>,
modules.</p> <a href="/posts/modules/clocks/">Clocks</a> and <a href="/posts/modules/status/">Status</a> widgets onscreen.</p>
<h2 id="custom-configuration-files">Custom Configuration Files</h2> <h2 id="custom-configuration-files">Custom Configuration Files</h2>
<p>To try out different configurations (or run multiple instances of WTF),
you can pass the path to a config file via command line arguments on
start-up.</p>
<p>To load a custom configuration file (ie: one that&rsquo;s not <p>To load a custom configuration file (ie: one that&rsquo;s not
<code>~/.wtf/config.yml</code>), pass in the path to configuration file as a <code>~/.wtf/config.yml</code>), pass in the path to configuration file as a
parameter on launch:</p> parameter on launch:</p>
@ -120,14 +137,6 @@ parameter on launch:</p>
<pre><code class="language-bash"> $&gt; wtf --config=path/to/custom/config.yml <pre><code class="language-bash"> $&gt; wtf --config=path/to/custom/config.yml
</code></pre> </code></pre>
<p>Example:</p>
<pre><code class="language-bash"> %&gt; wtf --config=~/Documents/monitoring.yml
</code></pre>
<p>This is also the easiest way to run multiple instances of WTF, should
you want to run multiple independent dashboards.</p>
</div> </div>
<div class="footer"> <div class="footer">

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

@ -10,8 +10,8 @@
<meta name="generator" content="Hugo 0.38.2" /> <meta name="generator" content="Hugo 0.38.2" />
<title>Glossary &middot; </title> <title>Glossary | WTF</title>
<meta content="Glossary - " property="og:title"> <meta content="Glossary - WTF" property="og:title">
<meta content=" - " property="og:description"> <meta content=" - " property="og:description">
<!-- CSS --> <!-- CSS -->
<link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css"> <link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
@ -19,6 +19,7 @@
<link rel="stylesheet" href="http://wtfutil.com/css/print.css" media="print"> <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/poole.css">
<link rel="stylesheet" href="http://wtfutil.com/css/hyde.css"> <link rel="stylesheet" href="http://wtfutil.com/css/hyde.css">
<link rel="stylesheet" href="http://wtfutil.com/css/wtf.css">
<!-- Font-Awesome --> <!-- 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> <script defer src="https://use.fontawesome.com/releases/v5.0.9/js/all.js" integrity="sha384-8iPTk2s/jMVj81dnzb/iFR2sdA7u06vHJyyLlAd4snFpCl/SnyUjRrbdJsw1pGIl" crossorigin="anonymous"></script>
@ -40,7 +41,7 @@
<div class="sidebar"> <div class="sidebar">
<div class="container sidebar-sticky"> <div class="container sidebar-sticky">
<div class="sidebar-about text-center"> <div class="sidebar-about text-center">
<a href="http://wtfutil.com/"><h1 class="brand"></h1></a>
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a> <a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead"> <p class="lead">
@ -50,18 +51,28 @@
<div> <div>
<h3 style="color: white;">Content</h3> <h3 style="color: white;">Content</h3>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/Installation/">Installation</a></li> <li class="sidebar-list-item-1"><a href="/posts/overview/">Overview</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/modules/">Modules</a></li> <li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/glossary/">Glossary</a></li> <li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/source/">Source Code</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/">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">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/textfiles/">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
</ul> </ul>
</div> </div>

58
docs/posts/index.html
View File

@ -10,8 +10,8 @@
<meta name="generator" content="Hugo 0.38.2" /> <meta name="generator" content="Hugo 0.38.2" />
<title>Posts &middot; </title> <title>Posts | WTF</title>
<meta content="Posts - " property="og:title"> <meta content="Posts - WTF" property="og:title">
<meta content=" - " property="og:description"> <meta content=" - " property="og:description">
<!-- CSS --> <!-- CSS -->
<link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css"> <link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
@ -19,6 +19,7 @@
<link rel="stylesheet" href="http://wtfutil.com/css/print.css" media="print"> <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/poole.css">
<link rel="stylesheet" href="http://wtfutil.com/css/hyde.css"> <link rel="stylesheet" href="http://wtfutil.com/css/hyde.css">
<link rel="stylesheet" href="http://wtfutil.com/css/wtf.css">
<!-- Font-Awesome --> <!-- 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> <script defer src="https://use.fontawesome.com/releases/v5.0.9/js/all.js" integrity="sha384-8iPTk2s/jMVj81dnzb/iFR2sdA7u06vHJyyLlAd4snFpCl/SnyUjRrbdJsw1pGIl" crossorigin="anonymous"></script>
@ -33,8 +34,8 @@
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png"> <link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png">
<link rel="shortcut icon" href="/favicon.png"> <link rel="shortcut icon" href="/favicon.png">
<!-- RSS --> <!-- RSS -->
<link href="http://wtfutil.com/posts/index.xml" rel="alternate" type="application/rss+xml" title="" /> <link href="http://wtfutil.com/posts/index.xml" rel="alternate" type="application/rss+xml" title="WTF" />
<link href="http://wtfutil.com/posts/index.xml" rel="feed" type="application/rss+xml" title="" /> <link href="http://wtfutil.com/posts/index.xml" rel="feed" type="application/rss+xml" title="WTF" />
<script async defer src="https://buttons.github.io/buttons.js"></script> <script async defer src="https://buttons.github.io/buttons.js"></script>
</head> </head>
@ -42,7 +43,7 @@
<div class="sidebar"> <div class="sidebar">
<div class="container sidebar-sticky"> <div class="container sidebar-sticky">
<div class="sidebar-about text-center"> <div class="sidebar-about text-center">
<a href="http://wtfutil.com/"><h1 class="brand"></h1></a>
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a> <a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead"> <p class="lead">
@ -52,22 +53,28 @@
<div> <div>
<h3 style="color: white;">Content</h3> <h3 style="color: white;">Content</h3>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/Installation/">Installation</a></li> <li class="sidebar-list-item-1"><a href="/posts/overview/">Overview</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/modules/">Modules</a></li> <li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/glossary/">Glossary</a></li> <li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/source/">Source Code</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/">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">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/textfiles/">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
</ul> </ul>
</div> </div>
@ -86,6 +93,27 @@
<h1 class="title">Posts</h1> <h1 class="title">Posts</h1>
<ul class="posts"> <ul class="posts">
<li> <li>
<span>
<a href="http://wtfutil.com/posts/modules/bamboohr/">Bamboohr</a>
<time class="pull-right post-list">May 07, 2018</time>
</span>
</li><li>
<span>
<a href="http://wtfutil.com/posts/modules/clocks/">Clocks</a>
<time class="pull-right post-list">May 07, 2018</time>
</span>
</li><li>
<span>
<a href="http://wtfutil.com/posts/modules/">Modules</a>
<time class="pull-right post-list">May 07, 2018</time>
</span>
</li><li>
<span> <span>
<a href="http://wtfutil.com/posts/glossary/">Glossary</a> <a href="http://wtfutil.com/posts/glossary/">Glossary</a>

48
docs/posts/index.xml
View File

@ -1,16 +1,53 @@
<?xml version="1.0" encoding="utf-8" standalone="yes" ?> <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel> <channel>
<title>Posts on </title> <title>Posts on WTF</title>
<link>http://wtfutil.com/posts/</link> <link>http://wtfutil.com/posts/</link>
<description>Recent content in Posts on </description> <description>Recent content in Posts on WTF</description>
<generator>Hugo -- gohugo.io</generator> <generator>Hugo -- gohugo.io</generator>
<language>en-us</language> <language>en-us</language>
<lastBuildDate>Tue, 17 Apr 2018 12:34:51 -0700</lastBuildDate> <lastBuildDate>Mon, 07 May 2018 20:17:37 -0700</lastBuildDate>
<atom:link href="http://wtfutil.com/posts/index.xml" rel="self" type="application/rss+xml" /> <atom:link href="http://wtfutil.com/posts/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Bamboohr</title>
<link>http://wtfutil.com/posts/modules/bamboohr/</link>
<pubDate>Mon, 07 May 2018 20:17:37 -0700</pubDate>
<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 WTF_BAMBOO_HR_TOKEN Your BambooHR API token.
WTF_BAMBOO_HR_SUBDOMAIN Your BambooHR API subdomain name.
Keyboard Commands None.
Configuration bamboohr: enabled: true position: top: 0 left: 1 height: 2 width: 1 refreshInterval: 900 Definitions enabled Whether or not this module is executed and its data displayed onscreen. Values: true, false.
position Defines where in the grid this module&amp;rsquo;s widget will be displayed.</description>
</item>
<item>
<title>Clocks</title>
<link>http://wtfutil.com/posts/modules/clocks/</link>
<pubDate>Mon, 07 May 2018 19:47:31 -0700</pubDate>
<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.
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; Definitions colors.</description>
</item>
<item>
<title>Modules</title>
<link>http://wtfutil.com/posts/modules/</link>
<pubDate>Mon, 07 May 2018 18:04:58 -0700</pubDate>
<guid>http://wtfutil.com/posts/modules/</guid>
<description>The heart of WTF is the modules. A module is a discreet unit of functionality that extracts data from some source and packages that data for display.
For example, the New Relic module uses New Relic&amp;rsquo;s API to retrieve a list of the latest deploys and packages that information as a list for display in the &amp;ldquo;New Relic&amp;rdquo; widget.
The Clocks module takes a list of timezones and packages that information as a list of city/time pairs for display in the &amp;ldquo;Clocks&amp;rdquo; widget.</description>
</item>
<item> <item>
<title>Glossary</title> <title>Glossary</title>
<link>http://wtfutil.com/posts/glossary/</link> <link>http://wtfutil.com/posts/glossary/</link>
@ -29,8 +66,9 @@ Widgets are defined by a required widget.go file in a Module.</description>
<pubDate>Sun, 15 Apr 2018 21:17:16 -0700</pubDate> <pubDate>Sun, 15 Apr 2018 21:17:16 -0700</pubDate>
<guid>http://wtfutil.com/posts/configuration/</guid> <guid>http://wtfutil.com/posts/configuration/</guid>
<description>By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If ~/.wtf/ doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating the configuration file. <description>By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If the ~/.wtf/ directory doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file.
Config.yml Example Config Files A few example config files are provided in the _sample_configs/ directory of the Git repository. To try out WTF quickly, copy simple_config.yml into ~/.wtf/ as config.yml and relaunch WTF. You should see the app launch and display the Security and Status modules.</description> In other words, WTF expects to have a YAML config file at: ~/.wtf/config.yml.
Example Configuration Files A couple of example config files are provided in the _sample_configs/ directory of the Git repository.</description>
</item> </item>
</channel> </channel>

166
docs/posts/modules/bamboohr/index.html Normal file
View File

@ -0,0 +1,166 @@
<!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>Bamboohr | WTF</title>
<meta content="Bamboohr - 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/overview/">Overview</a></li>
</ul>
<ul style="list-style-type: none;">
<li class="sidebar-list-item-1"><a href="/posts/installation/">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/">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">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/textfiles/">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">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>Bamboohr</h1>
<div class="col-sm-12 col-md-12">
<span class="text-left post-date meta">
<i class="fas fa-calendar-alt"></i> May 07, 2018
<br/>
<i class="fas fa-clock"></i> 1 min read
</span>
</div>
<h2 id="description">Description</h2>
<p>Connects to the BambooHR API and displays who will be Away today.</p>
<h2 id="location">Location</h2>
<pre><code class="language-bash">wtf/bamboohr
</code></pre>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><code>WTF_BAMBOO_HR_TOKEN</code> <br />
Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> token.</p>
<p><code>WTF_BAMBOO_HR_SUBDOMAIN</code> <br />
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>
<pre><code class="language-yaml">bamboohr:
enabled: true
position:
top: 0
left: 1
height: 2
width: 1
refreshInterval: 900
</code></pre>
<h3 id="definitions">Definitions</h3>
<p><code>enabled</code> <br />
Whether or not this module is executed and 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: Any positive integer, <code>0...n</code>.</p>
</div>
<div class="footer">
</div>
</div>
</body>
</html>

196
docs/posts/modules/clocks/index.html Normal file
View File

@ -0,0 +1,196 @@
<!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>Clocks | WTF</title>
<meta content="Clocks - 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/overview/">Overview</a></li>
</ul>
<ul style="list-style-type: none;">
<li class="sidebar-list-item-1"><a href="/posts/installation/">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/">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">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/textfiles/">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">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>Clocks</h1>
<div class="col-sm-12 col-md-12">
<span class="text-left post-date meta">
<i class="fas fa-calendar-alt"></i> May 07, 2018
<br/>
<i class="fas fa-clock"></i> 1 min read
</span>
</div>
<h2 id="description">Description</h2>
<p>Displays a configurable list of world clocks, the local time, and date.</p>
<p><img src="/imgs/modules/clocks.png" width="320" height="180" alt="clocks screenshot" /></p>
<h2 id="location">Location</h2>
<pre><code class="language-bash">wtf/clocks/
</code></pre>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p>None.</p>
<h2 id="keyboard-commands">Keyboard Commands</h2>
<p>None.</p>
<h2 id="configuration">Configuration</h2>
<pre><code class="language-yaml">clocks:
colors:
rows:
even: &quot;lightblue&quot;
odd: &quot;white&quot;
enabled: true
locations:
# From https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Avignon: &quot;Europe/Paris&quot;
Barcelona: &quot;Europe/Madrid&quot;
Dubai: &quot;Asia/Dubai&quot;
UTC: &quot;Etc/UTC&quot;
Vancouver: &quot;America/Vancouver&quot;
Toronto: &quot;America/Toronto&quot;
position:
top: 4
left: 0
height: 1
width: 1
refreshInterval: 15
# Valid options are: alphabetical, chronological
sort: &quot;alphabetical&quot;
</code></pre>
<h3 id="definitions">Definitions</h3>
<p><code>colors.even</code> <br />
Define the text color for even-numbered rows (2, 4, 6&hellip;). <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.</p>
<p><code>colors.odd</code> <br />
Define the text color for the odd-numbered rows (1, 3, 5&hellip;). <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.</p>
<p><code>locations</code> <br />
Defines the timezones for the world clocks that you want to display.
<code>key</code> is a unique label that will be displayed in the UI. <code>value</code> is a
timezone name. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">TZ database timezone</a>.</p>
<p><code>position</code> <br />
Defines where in the grid this module&rsquo;s widget will be displayed.</p>
<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>
<p><code>sort</code> <br />
Defines the display order of the clocks in the widget. <br />
Values: <code>alphabetical</code> or <code>chronological</code>. <code>alphabetical</code> will sort in
acending order by <code>key</code>, <code>chronological</code> will sort in ascending order by
date/time.</p>
</div>
<div class="footer">
</div>
</div>
</body>
</html>

148
docs/posts/modules/index.html Normal file
View File

@ -0,0 +1,148 @@
<!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>Modules | WTF</title>
<meta content="Modules - 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/overview/">Overview</a></li>
</ul>
<ul style="list-style-type: none;">
<li class="sidebar-list-item-1"><a href="/posts/installation/">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/">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">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/textfiles/">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">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>Modules</h1>
<div class="col-sm-12 col-md-12">
<span class="text-left post-date meta">
<i class="fas fa-calendar-alt"></i> May 07, 2018
<br/>
<i class="fas fa-clock"></i> 1 min read
</span>
</div>
<p>The heart of WTF is the modules. A module is a discreet unit of
functionality that extracts data from some source and packages that data
for display.</p>
<p>For example, the <a href="/posts/modules/newrelic">New Relic</a> module
uses New Relic&rsquo;s API to retrieve a list of the latest deploys and
packages that information as a list for display in the &ldquo;New Relic&rdquo;
widget.</p>
<p>The <a href="/posts/modules/clocks">Clocks</a> module takes a list of
timezones and packages that information as a list of city/time pairs for
display in the &ldquo;Clocks&rdquo; widget.</p>
<p>Available modules:</p>
<ul class="list-bare">
<li><a href="/posts/modules/bamboohr">BambooHR</a>
<li><a href="/posts/modules/clocks">Clocks</a>
<li><a href="/posts/modules/git">Git</a>
<li><a href="/posts/modules/github">Github</a>
<li><a href="/posts/modules/gcal">Google Calendar</a>
<li><a href="/posts/modules/jira">Jira</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">Text Files</a>
<li><a href="/posts/modules/todo">Todo</a>
<li><a href="/posts/modules/weather">Weather</a>
</ul>
</div>
<div class="footer">
</div>
</div>
</body>
</html>

29
docs/sitemap.xml
View File

@ -2,6 +2,21 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
xmlns:xhtml="http://www.w3.org/1999/xhtml"> xmlns:xhtml="http://www.w3.org/1999/xhtml">
<url>
<loc>http://wtfutil.com/posts/modules/bamboohr/</loc>
<lastmod>2018-05-07T20:17:37-07:00</lastmod>
</url>
<url>
<loc>http://wtfutil.com/posts/modules/clocks/</loc>
<lastmod>2018-05-07T19:47:31-07:00</lastmod>
</url>
<url>
<loc>http://wtfutil.com/posts/modules/</loc>
<lastmod>2018-05-07T18:04:58-07:00</lastmod>
</url>
<url> <url>
<loc>http://wtfutil.com/posts/glossary/</loc> <loc>http://wtfutil.com/posts/glossary/</loc>
<lastmod>2018-04-17T12:34:51-07:00</lastmod> <lastmod>2018-04-17T12:34:51-07:00</lastmod>
@ -12,12 +27,6 @@
<lastmod>2018-04-15T21:17:16-07:00</lastmod> <lastmod>2018-04-15T21:17:16-07:00</lastmod>
</url> </url>
<url>
<loc>http://wtfutil.com/</loc>
<lastmod>2018-04-17T12:34:51-07:00</lastmod>
<priority>0</priority>
</url>
<url> <url>
<loc>http://wtfutil.com/categories/</loc> <loc>http://wtfutil.com/categories/</loc>
<priority>0</priority> <priority>0</priority>
@ -25,7 +34,7 @@
<url> <url>
<loc>http://wtfutil.com/posts/</loc> <loc>http://wtfutil.com/posts/</loc>
<lastmod>2018-04-17T12:34:51-07:00</lastmod> <lastmod>2018-05-07T20:17:37-07:00</lastmod>
<priority>0</priority> <priority>0</priority>
</url> </url>
@ -34,4 +43,10 @@
<priority>0</priority> <priority>0</priority>
</url> </url>
<url>
<loc>http://wtfutil.com/</loc>
<lastmod>2018-05-07T20:17:37-07:00</lastmod>
<priority>0</priority>
</url>
</urlset> </urlset>

33
docs/tags/index.html
View File

@ -10,8 +10,8 @@
<meta name="generator" content="Hugo 0.38.2" /> <meta name="generator" content="Hugo 0.38.2" />
<title>Tags &middot; </title> <title>Tags | WTF</title>
<meta content="Tags - " property="og:title"> <meta content="Tags - WTF" property="og:title">
<meta content=" - " property="og:description"> <meta content=" - " property="og:description">
<!-- CSS --> <!-- CSS -->
<link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css"> <link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
@ -19,6 +19,7 @@
<link rel="stylesheet" href="http://wtfutil.com/css/print.css" media="print"> <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/poole.css">
<link rel="stylesheet" href="http://wtfutil.com/css/hyde.css"> <link rel="stylesheet" href="http://wtfutil.com/css/hyde.css">
<link rel="stylesheet" href="http://wtfutil.com/css/wtf.css">
<!-- Font-Awesome --> <!-- 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> <script defer src="https://use.fontawesome.com/releases/v5.0.9/js/all.js" integrity="sha384-8iPTk2s/jMVj81dnzb/iFR2sdA7u06vHJyyLlAd4snFpCl/SnyUjRrbdJsw1pGIl" crossorigin="anonymous"></script>
@ -33,8 +34,8 @@
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png"> <link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png">
<link rel="shortcut icon" href="/favicon.png"> <link rel="shortcut icon" href="/favicon.png">
<!-- RSS --> <!-- RSS -->
<link href="http://wtfutil.com/tags/index.xml" rel="alternate" type="application/rss+xml" title="" /> <link href="http://wtfutil.com/tags/index.xml" rel="alternate" type="application/rss+xml" title="WTF" />
<link href="http://wtfutil.com/tags/index.xml" rel="feed" type="application/rss+xml" title="" /> <link href="http://wtfutil.com/tags/index.xml" rel="feed" type="application/rss+xml" title="WTF" />
<script async defer src="https://buttons.github.io/buttons.js"></script> <script async defer src="https://buttons.github.io/buttons.js"></script>
</head> </head>
@ -42,7 +43,7 @@
<div class="sidebar"> <div class="sidebar">
<div class="container sidebar-sticky"> <div class="container sidebar-sticky">
<div class="sidebar-about text-center"> <div class="sidebar-about text-center">
<a href="http://wtfutil.com/"><h1 class="brand"></h1></a>
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a> <a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead"> <p class="lead">
@ -52,18 +53,28 @@
<div> <div>
<h3 style="color: white;">Content</h3> <h3 style="color: white;">Content</h3>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/Installation/">Installation</a></li> <li class="sidebar-list-item-1"><a href="/posts/overview/">Overview</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/modules/">Modules</a></li> <li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
</ul> </ul>
<ul style="list-style-type: none;"> <ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/glossary/">Glossary</a></li> <li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/source/">Source Code</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/">Git</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/github/">Github</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/">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/textfiles/">Text Files</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
</ul> </ul>
</div> </div>

4
docs/tags/index.xml
View File

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8" standalone="yes" ?> <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel> <channel>
<title>Tags on </title> <title>Tags on WTF</title>
<link>http://wtfutil.com/tags/</link> <link>http://wtfutil.com/tags/</link>
<description>Recent content in Tags on </description> <description>Recent content in Tags on WTF</description>
<generator>Hugo -- gohugo.io</generator> <generator>Hugo -- gohugo.io</generator>
<language>en-us</language> <language>en-us</language>