diff --git a/_site/content/posts/modules.md b/_site/content/posts/modules.md index 1e873b51..99cfea1d 100644 --- a/_site/content/posts/modules.md +++ b/_site/content/posts/modules.md @@ -26,10 +26,10 @@ Available modules:
  • Github
  • Google Calendar
  • Jira -
  • New Relic +
  • New Relic
  • OpsGenie
  • Security -
  • Text Files +
  • Text File
  • Todo
  • Weather diff --git a/_site/content/posts/modules/bamboohr.md b/_site/content/posts/modules/bamboohr.md index 59af17e2..510e6c32 100644 --- a/_site/content/posts/modules/bamboohr.md +++ b/_site/content/posts/modules/bamboohr.md @@ -8,7 +8,7 @@ draft: false Connects to the BambooHR API and displays who will be Away today. -## Location +## Source Code ```bash wtf/bamboohr diff --git a/_site/content/posts/modules/clocks.md b/_site/content/posts/modules/clocks.md index 622b69e5..40a0d6e5 100644 --- a/_site/content/posts/modules/clocks.md +++ b/_site/content/posts/modules/clocks.md @@ -10,7 +10,7 @@ Displays a configurable list of world clocks, the local time, and date. clocks screenshot -## Location +## Source Code ```bash wtf/clocks/ diff --git a/_site/content/posts/modules/newrelic.md b/_site/content/posts/modules/newrelic.md new file mode 100644 index 00000000..f44158e2 --- /dev/null +++ b/_site/content/posts/modules/newrelic.md @@ -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. + +newrelic screenshot + +## Source Code + +```bash +wtf/newrelic/ +``` + +## Required ENV Variables + +Key: `WTF_NEW_RELIC_API_KEY`
    +Value: Your New Relic API +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`
    +The integer ID of the New Relic application you wish to report on.
    +Values: A positive integer, `0...n`. + +`deployCount`
    +The number of past deploys to display on screen.
    +Values: A positive integer, `0...n`. + +`enabled`
    +Determines whether or not this module is executed and if its data displayed onscreen.
    +Values: `true`, `false`. + +`position`
    +Defines where in the grid this module's widget will be displayed.
    + +`refreshInterval`
    +How often, in seconds, this module will update its data.
    +Values: A positive integer, `0...n`. diff --git a/_site/content/posts/modules/opsgenie.md b/_site/content/posts/modules/opsgenie.md index 51993cbb..a111c385 100644 --- a/_site/content/posts/modules/opsgenie.md +++ b/_site/content/posts/modules/opsgenie.md @@ -11,10 +11,10 @@ and who's currently on call. 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.
    `refreshInterval`
    How often, in seconds, this module will update its data.
    -Values: Any positive integer, `0...n`. +Values: A positive integer, `0...n`. diff --git a/_site/content/posts/modules/security.md b/_site/content/posts/modules/security.md index 6c9878d7..a1c4226e 100644 --- a/_site/content/posts/modules/security.md +++ b/_site/content/posts/modules/security.md @@ -31,7 +31,7 @@ connection, firewall, and DNS settings.
  • Which DNS resolvers (servers) the machine is configured to use
  • -## Location +## Source Code ```bash wtf/security diff --git a/_site/content/posts/modules/textfile.md b/_site/content/posts/modules/textfile.md new file mode 100644 index 00000000..71864eea --- /dev/null +++ b/_site/content/posts/modules/textfile.md @@ -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. + +textfile screenshot + +## Source Code + +```bash +wtf/textfile/ +``` + +## Required ENV Variables + +None. + +## Keyboard Commands + +Key: `h`
    +Action: Open/close the widget's help window. + +Key: `o`
    +Action: 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`
    +Determines whether or not this module is executed and if its data displayed onscreen.
    +Values: `true`, `false`. + +`filename`
    +The name of the file to be displayed in the widget.
    +*Note:* Currently this file *must* reside in the `~/.wtf/` directory. +This is a known bug. + +`position`
    +Defines where in the grid this module's widget will be displayed.
    + +`refreshInterval`
    +How often, in seconds, this module will update its data.
    +Values: A positive integer, `0...n`. diff --git a/_site/static/imgs/modules/newrelic.png b/_site/static/imgs/modules/newrelic.png new file mode 100644 index 00000000..b1cc1db5 Binary files /dev/null and b/_site/static/imgs/modules/newrelic.png differ diff --git a/_site/static/imgs/modules/textfile.png b/_site/static/imgs/modules/textfile.png new file mode 100644 index 00000000..b852062e Binary files /dev/null and b/_site/static/imgs/modules/textfile.png differ diff --git a/_site/themes/hyde-hyde/layouts/partials/sidebar.html b/_site/themes/hyde-hyde/layouts/partials/sidebar.html index 541b2402..9b6ce1d3 100644 --- a/_site/themes/hyde-hyde/layouts/partials/sidebar.html +++ b/_site/themes/hyde-hyde/layouts/partials/sidebar.html @@ -23,10 +23,10 @@ - + - + diff --git a/_site/themes/hyde-hyde/static/css/wtf.css b/_site/themes/hyde-hyde/static/css/wtf.css index 8a92dcd2..5db9d0d6 100644 --- a/_site/themes/hyde-hyde/static/css/wtf.css +++ b/_site/themes/hyde-hyde/static/css/wtf.css @@ -16,6 +16,7 @@ pre code { span.caption { display: inline-block; + font-weight: bold; margin-right: 4px; min-width: 50px; text-align: right; diff --git a/docs/404.html b/docs/404.html index bf6f1f1b..342d7ca8 100644 --- a/docs/404.html +++ b/docs/404.html @@ -63,10 +63,10 @@ - + - + diff --git a/docs/categories/index.html b/docs/categories/index.html index 331f2e9e..73712ba4 100644 --- a/docs/categories/index.html +++ b/docs/categories/index.html @@ -65,10 +65,10 @@ - + - + diff --git a/docs/css/wtf.css b/docs/css/wtf.css index 8a92dcd2..5db9d0d6 100644 --- a/docs/css/wtf.css +++ b/docs/css/wtf.css @@ -16,6 +16,7 @@ pre code { span.caption { display: inline-block; + font-weight: bold; margin-right: 4px; min-width: 50px; text-align: right; diff --git a/docs/imgs/modules/newrelic.png b/docs/imgs/modules/newrelic.png new file mode 100644 index 00000000..b1cc1db5 Binary files /dev/null and b/docs/imgs/modules/newrelic.png differ diff --git a/docs/imgs/modules/textfile.png b/docs/imgs/modules/textfile.png new file mode 100644 index 00000000..b852062e Binary files /dev/null and b/docs/imgs/modules/textfile.png differ diff --git a/docs/index.html b/docs/index.html index c6669848..acaea82d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -64,10 +64,10 @@ - + - + diff --git a/docs/index.xml b/docs/index.xml index 74a5a99f..9620d0b3 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -6,11 +6,36 @@ Recent content on WTF Hugo -- gohugo.io en-us - Tue, 08 May 2018 20:53:40 -0700 + Wed, 09 May 2018 11:13:11 -0700 + + Textfile + http://wtfutil.com/posts/modules/textfile/ + Wed, 09 May 2018 11:13:11 -0700 + + http://wtfutil.com/posts/modules/textfile/ + 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’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: "notes.md" 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. + + + + Newrelic + http://wtfutil.com/posts/modules/newrelic/ + Wed, 09 May 2018 09:01:14 -0700 + + http://wtfutil.com/posts/modules/newrelic/ + 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. + + Opsgenie http://wtfutil.com/posts/modules/opsgenie/ @@ -18,10 +43,9 @@ http://wtfutil.com/posts/modules/opsgenie/ Description Connects to the OpsGenie API and displays all your scheduled rotations and who’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’s widget will be displayed. +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. @@ -31,7 +55,7 @@ position Defines where in the grid this module’s widget will be displa http://wtfutil.com/posts/modules/security/ Description Displays some general information about the state of the machine’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. +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. @@ -41,10 +65,10 @@ Wifi Network The name of the current network Whether or not the network uses enc http://wtfutil.com/posts/modules/bamboohr/ 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. +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. @@ -54,7 +78,7 @@ Configuration bamboohr: enabled: true position: top: 0 left: 1 height: 2 width: http://wtfutil.com/posts/modules/clocks/ 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: "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" Attributes colors. diff --git a/docs/posts/configuration/index.html b/docs/posts/configuration/index.html index 7eeb63e8..75da43fc 100644 --- a/docs/posts/configuration/index.html +++ b/docs/posts/configuration/index.html @@ -63,10 +63,10 @@ - + - + diff --git a/docs/posts/glossary/index.html b/docs/posts/glossary/index.html index 5c0251f0..e1596cf2 100644 --- a/docs/posts/glossary/index.html +++ b/docs/posts/glossary/index.html @@ -63,10 +63,10 @@ - + - + diff --git a/docs/posts/index.html b/docs/posts/index.html index e70bac0f..2fdd7cfb 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -65,10 +65,10 @@ - + - + @@ -89,6 +89,20 @@

    Posts

    @@ -107,7 +107,7 @@

    Connects to the BambooHR API and displays who will be Away today.

    -

    Location

    +

    Source Code

    wtf/bamboohr
     
    diff --git a/docs/posts/modules/clocks/index.html b/docs/posts/modules/clocks/index.html index 9206bea5..b058e189 100644 --- a/docs/posts/modules/clocks/index.html +++ b/docs/posts/modules/clocks/index.html @@ -63,10 +63,10 @@ - + - + @@ -97,7 +97,7 @@
    - 1 min read + 2 min read @@ -109,7 +109,7 @@

    clocks screenshot

    -

    Location

    +

    Source Code

    wtf/clocks/
     
    diff --git a/docs/posts/modules/index.html b/docs/posts/modules/index.html index 5525d31f..de223c4a 100644 --- a/docs/posts/modules/index.html +++ b/docs/posts/modules/index.html @@ -63,10 +63,10 @@ - + - + @@ -123,10 +123,10 @@ display in the “Clocks” widget.

  • Github
  • Google Calendar
  • Jira -
  • New Relic +
  • New Relic
  • OpsGenie
  • Security -
  • Text Files +
  • Text File
  • Todo
  • Weather diff --git a/docs/posts/modules/newrelic/index.html b/docs/posts/modules/newrelic/index.html new file mode 100644 index 00000000..4dc53dd7 --- /dev/null +++ b/docs/posts/modules/newrelic/index.html @@ -0,0 +1,174 @@ + + + + + + + + + + + + +Newrelic | WTF + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +

    Newrelic

    + +
    + +
    + + + +

    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.

    + +

    newrelic screenshot

    + +

    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.
    +Values: A positive integer, 0...n.

    + +

    deployCount
    +The number of past deploys to display on screen.
    +Values: A positive integer, 0...n.

    + +

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

    + +

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

    + +

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

    + +
    + +
    + + + + diff --git a/docs/posts/modules/opsgenie/index.html b/docs/posts/modules/opsgenie/index.html index 4944592d..5493fb47 100644 --- a/docs/posts/modules/opsgenie/index.html +++ b/docs/posts/modules/opsgenie/index.html @@ -63,10 +63,10 @@
  • - + - + @@ -110,9 +110,9 @@ and who’s currently on call.

    opsgenie screenshot

    -

    Location

    +

    Source Code

    -
    wtf/opsgenie
    +
    wtf/opsgenie/
     

    Required ENV Variables

    @@ -148,7 +148,7 @@ Defines where in the grid this module’s widget will be displayed.
    refreshInterval
    How often, in seconds, this module will update its data.
    -Values: Any positive integer, 0...n.

    +Values: A positive integer, 0...n.