diff --git a/_site/content/posts/configuration.md b/_site/content/posts/configuration.md index d98603fb..691012a8 100644 --- a/_site/content/posts/configuration.md +++ b/_site/content/posts/configuration.md @@ -4,6 +4,8 @@ date: 2018-04-15T21:17:16-07:00 draft: false --- +## Configuration Files + By default WTF looks in a `~/.wtf/` directory for a YAML file called `config.yml`. If the `~/.wtf/` directory doesn't exist, WTF will create that directory on start-up, and then display instructions for creating a new @@ -11,7 +13,7 @@ configuration file. In other words, WTF expects to have a YAML config file at: `~/.wtf/config.yml`. -## Example Configuration Files +#### Example Configuration Files A couple of example config files are provided in the `_sample_configs/` directory of the Git repository. @@ -21,7 +23,7 @@ To try out WTF quickly, copy should see the app launch and display the Security, Clocks and Status 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 @@ -34,3 +36,13 @@ parameter on launch: ```bash $> wtf --config=path/to/custom/config.yml ``` + +## Environment (ENV) Variables + +Some modules require the presence of environment variables to function +properly. Usually these are API keys or other sensitive data that one +wouldn't want to have laying about in the config files. + +For modules that require them, the name of the required environment +variable(s) can be found in that module's "Required ENV Variables" +section of the documentation. See OpsGenie for an example. diff --git a/_site/content/posts/modules.md b/_site/content/posts/modules.md index 463f2524..1e873b51 100644 --- a/_site/content/posts/modules.md +++ b/_site/content/posts/modules.md @@ -27,7 +27,7 @@ Available modules:
  • Google Calendar
  • Jira
  • New Relic -
  • OpsGenie +
  • OpsGenie
  • Security
  • Text Files
  • Todo diff --git a/_site/content/posts/modules/bamboohr.md b/_site/content/posts/modules/bamboohr.md index 5c3bf201..59af17e2 100644 --- a/_site/content/posts/modules/bamboohr.md +++ b/_site/content/posts/modules/bamboohr.md @@ -16,11 +16,11 @@ wtf/bamboohr ## Required ENV Variables -`WTF_BAMBOO_HR_TOKEN`
    -Your BambooHR API token. +Key: `WTF_BAMBOO_HR_TOKEN`
    +Value: Your BambooHR API token. -`WTF_BAMBOO_HR_SUBDOMAIN`
    -Your BambooHR API subdomain name. +Key: `WTF_BAMBOO_HR_SUBDOMAIN`
    +Value: Your BambooHR API subdomain name. ## Keyboard Commands diff --git a/_site/content/posts/modules/clocks.md b/_site/content/posts/modules/clocks.md index 43580a59..622b69e5 100644 --- a/_site/content/posts/modules/clocks.md +++ b/_site/content/posts/modules/clocks.md @@ -8,7 +8,7 @@ draft: false Displays a configurable list of world clocks, the local time, and date. -clocks screenshot +clocks screenshot ## Location diff --git a/_site/content/posts/modules/opsgenie.md b/_site/content/posts/modules/opsgenie.md new file mode 100644 index 00000000..51993cbb --- /dev/null +++ b/_site/content/posts/modules/opsgenie.md @@ -0,0 +1,54 @@ +--- +title: "Opsgenie" +date: 2018-05-08T20:53:40-07:00 +draft: false +--- + +## Description + +Connects to the OpsGenie API and displays all your scheduled rotations +and who's currently on call. + +opsgenie screenshot + +## Location + +```bash +wtf/opsgenie +``` + +## Required ENV Variables + +Key: `WTF_OPS_GENIE_API_KEY`
    +Value: Your OpsGenie +API token. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +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.
    + +`refreshInterval`
    +How often, in seconds, this module will update its data.
    +Values: Any positive integer, `0...n`. diff --git a/_site/content/posts/modules/security.md b/_site/content/posts/modules/security.md index eaeb6df6..6c9878d7 100644 --- a/_site/content/posts/modules/security.md +++ b/_site/content/posts/modules/security.md @@ -9,6 +9,8 @@ draft: false Displays some general information about the state of the machine's wifi connection, firewall, and DNS settings. +security screenshot + #### Wifi Network -clocks screenshot - ## Location ```bash diff --git a/_site/static/imgs/modules/clocks.png b/_site/static/imgs/modules/clocks.png index 842a2db2..3bf984a7 100644 Binary files a/_site/static/imgs/modules/clocks.png and b/_site/static/imgs/modules/clocks.png differ diff --git a/_site/static/imgs/modules/opsgenie.png b/_site/static/imgs/modules/opsgenie.png new file mode 100644 index 00000000..ccb3fbbe Binary files /dev/null and b/_site/static/imgs/modules/opsgenie.png differ diff --git a/_site/themes/hyde-hyde/layouts/partials/sidebar.html b/_site/themes/hyde-hyde/layouts/partials/sidebar.html index bf348ea0..541b2402 100644 --- a/_site/themes/hyde-hyde/layouts/partials/sidebar.html +++ b/_site/themes/hyde-hyde/layouts/partials/sidebar.html @@ -24,7 +24,7 @@
  • Google Calendar
  • Jira
  • New Relic
    • -
  • OpsGenie
    • +
  • OpsGenie
  • Security
  • Text Files
  • Todo
    • diff --git a/_site/themes/hyde-hyde/static/css/wtf.css b/_site/themes/hyde-hyde/static/css/wtf.css index 32c5e206..8a92dcd2 100644 --- a/_site/themes/hyde-hyde/static/css/wtf.css +++ b/_site/themes/hyde-hyde/static/css/wtf.css @@ -14,6 +14,13 @@ pre code { padding-left: 8px !important; } +span.caption { + display: inline-block; + margin-right: 4px; + min-width: 50px; + text-align: right; +} + .disabled { color: gray !important; cursor: not-allowed; diff --git a/docs/404.html b/docs/404.html index 526ee95e..bf6f1f1b 100644 --- a/docs/404.html +++ b/docs/404.html @@ -64,7 +64,7 @@
  • Google Calendar
  • Jira
  • New Relic
    • -
  • OpsGenie
    • +
  • OpsGenie
  • Security
  • Text Files
  • Todo
    • diff --git a/docs/categories/index.html b/docs/categories/index.html index 4847d788..331f2e9e 100644 --- a/docs/categories/index.html +++ b/docs/categories/index.html @@ -66,7 +66,7 @@
  • Google Calendar
  • Jira
  • New Relic
    • -
  • OpsGenie
    • +
  • OpsGenie
  • Security
  • Text Files
  • Todo
    • diff --git a/docs/css/wtf.css b/docs/css/wtf.css index 32c5e206..8a92dcd2 100644 --- a/docs/css/wtf.css +++ b/docs/css/wtf.css @@ -14,6 +14,13 @@ pre code { padding-left: 8px !important; } +span.caption { + display: inline-block; + margin-right: 4px; + min-width: 50px; + text-align: right; +} + .disabled { color: gray !important; cursor: not-allowed; diff --git a/docs/imgs/modules/clocks.png b/docs/imgs/modules/clocks.png index 842a2db2..3bf984a7 100644 Binary files a/docs/imgs/modules/clocks.png and b/docs/imgs/modules/clocks.png differ diff --git a/docs/imgs/modules/opsgenie.png b/docs/imgs/modules/opsgenie.png new file mode 100644 index 00000000..ccb3fbbe Binary files /dev/null and b/docs/imgs/modules/opsgenie.png differ diff --git a/docs/index.html b/docs/index.html index af54c993..c6669848 100644 --- a/docs/index.html +++ b/docs/index.html @@ -65,7 +65,7 @@
  • Google Calendar
  • Jira
  • New Relic
    • -
  • OpsGenie
    • +
  • OpsGenie
  • Security
  • Text Files
  • Todo
    • diff --git a/docs/index.xml b/docs/index.xml index 9b90f030..74a5a99f 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -6,11 +6,24 @@ Recent content on WTF Hugo -- gohugo.io en-us - Tue, 08 May 2018 20:33:28 -0700 + Tue, 08 May 2018 20:53:40 -0700 + + Opsgenie + http://wtfutil.com/posts/modules/opsgenie/ + Tue, 08 May 2018 20:53:40 -0700 + + 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. +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. + + Security http://wtfutil.com/posts/modules/security/ @@ -28,11 +41,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 WTF_BAMBOO_HR_TOKEN Your BambooHR API token. -WTF_BAMBOO_HR_SUBDOMAIN Your BambooHR API subdomain name. +Location 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. -position Defines where in the grid this module’s widget will be displayed. +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. @@ -76,7 +88,7 @@ Widgets are defined by a required widget.go file in a Module. Sun, 15 Apr 2018 21:17:16 -0700 http://wtfutil.com/posts/configuration/ - By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If the ~/.wtf/ directory doesn’t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file. + Configuration Files By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If the ~/.wtf/ directory doesn’t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file. 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. diff --git a/docs/posts/configuration/index.html b/docs/posts/configuration/index.html index 1e86ebc4..7eeb63e8 100644 --- a/docs/posts/configuration/index.html +++ b/docs/posts/configuration/index.html @@ -64,7 +64,7 @@
  • Google Calendar
  • Jira
  • New Relic
    • -
  • OpsGenie
    • +
  • OpsGenie
  • Security
  • Text Files
  • Todo
    • @@ -97,12 +97,14 @@
    - 1 min read + 2 min read +

    Configuration Files

    +

    By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If the ~/.wtf/ directory doesn’t exist, WTF will create that directory on start-up, and then display instructions for creating a new @@ -110,7 +112,7 @@ configuration file.

    In other words, WTF expects to have a YAML config file at: ~/.wtf/config.yml.

    -

    Example Configuration Files

    +

    Example Configuration Files

    A couple of example config files are provided in the _sample_configs/ directory of the Git repository.

    @@ -120,7 +122,7 @@ directory of the Git repository.

    should see the app launch and display the Security, Clocks and Status 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 @@ -133,6 +135,16 @@ parameter on launch:

        $> wtf --config=path/to/custom/config.yml
    +

    Environment (ENV) Variables

    + +

    Some modules require the presence of environment variables to function +properly. Usually these are API keys or other sensitive data that one +wouldn’t want to have laying about in the config files.

    + +

    For modules that require them, the name of the required environment +variable(s) can be found in that module’s “Required ENV Variables” +section of the documentation. See OpsGenie for an example.

    +
    diff --git a/docs/posts/glossary/index.html b/docs/posts/glossary/index.html index 00abff6f..5c0251f0 100644 --- a/docs/posts/glossary/index.html +++ b/docs/posts/glossary/index.html @@ -64,7 +64,7 @@
  • Google Calendar
  • Jira
  • New Relic
    • -
  • OpsGenie
    • +
  • OpsGenie
  • Security
  • Text Files
  • Todo
    • diff --git a/docs/posts/index.html b/docs/posts/index.html index 8892b031..e70bac0f 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -66,7 +66,7 @@
  • Google Calendar
  • Jira
  • New Relic
    • -
  • OpsGenie
    • +
  • OpsGenie
  • Security
  • Text Files
  • Todo
    • @@ -89,6 +89,13 @@

    Posts