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

Adds the OpsGenie module to the documentation

This commit is contained in:
Chris Cummer
2018-05-08 21:14:43 -07:00
parent 4542abce60
commit b4520f1410
28 changed files with 338 additions and 47 deletions

View File

@@ -16,11 +16,11 @@ wtf/bamboohr
## Required ENV Variables
`WTF_BAMBOO_HR_TOKEN` <br />
Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> token.
<span class="caption">Key:</span> `WTF_BAMBOO_HR_TOKEN` <br />
<span class="caption">Value:</span> 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.
<span class="caption">Key:</span> `WTF_BAMBOO_HR_SUBDOMAIN` <br />
<span class="caption">Value:</span> Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> subdomain name.
## Keyboard Commands

View File

@@ -8,7 +8,7 @@ draft: false
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" />
<img src="/imgs/modules/clocks.png" width="320" height="191" alt="clocks screenshot" />
## Location

View File

@@ -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.
<img src="/imgs/modules/opsgenie.png" width="320" height="389" alt="opsgenie screenshot" />
## Location
```bash
wtf/opsgenie
```
## Required ENV Variables
<span class="caption">Key:</span> `WTF_OPS_GENIE_API_KEY` <br />
<span class="caption">Value:</span> Your <a href="https://docs.opsgenie.com/docs/api-integration">OpsGenie
API</a> token.
## Keyboard Commands
None.
## Configuration
```yaml
opsgenie:
enabled: true
position:
top: 2
left: 1
height: 2
width: 1
refreshInterval: 21600
```
### Attributes
`enabled` <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: `true`, `false`.
`position` <br />
Defines where in the grid this module's widget will be displayed. <br />
`refreshInterval` <br />
How often, in seconds, this module will update its data. <br />
Values: Any positive integer, `0...n`.

View File

@@ -9,6 +9,8 @@ draft: false
Displays some general information about the state of the machine's wifi
connection, firewall, and DNS settings.
<img src="/imgs/modules/security.png" width="320" height="192" alt="security screenshot" />
#### Wifi Network
<ul class="list-ornate">
@@ -29,8 +31,6 @@ connection, firewall, and DNS settings.
<li>Which <a hre="https://developers.cloudflare.com/1.1.1.1/what-is-1.1.1.1/">DNS resolvers</a> (servers) the machine is configured to use</li>
</ul>
<img src="/imgs/modules/security.png" width="320" height="192" alt="clocks screenshot" />
## Location
```bash