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:
@@ -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 <a href="/posts/modules/security/">Security</a>,
|
||||
<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
|
||||
@@ -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 <a href="/posts/modules/opgenie/">OpsGenie</a> for an example.
|
||||
|
||||
@@ -27,7 +27,7 @@ Available modules:
|
||||
<li><a href="/posts/modules/gcal" class="disabled">Google Calendar</a>
|
||||
<li><a href="/posts/modules/jira" class="disabled">Jira</a>
|
||||
<li><a href="/posts/modules/newrelic" class="disabled">New Relic</a>
|
||||
<li><a href="/posts/modules/opsgenie" class="disabled">OpsGenie</a>
|
||||
<li><a href="/posts/modules/opsgenie">OpsGenie</a>
|
||||
<li><a href="/posts/modules/security">Security</a>
|
||||
<li><a href="/posts/modules/textfiles" class="disabled">Text Files</a>
|
||||
<li><a href="/posts/modules/todo" class="disabled">Todo</a>
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
54
_site/content/posts/modules/opsgenie.md
Normal file
54
_site/content/posts/modules/opsgenie.md
Normal 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`.
|
||||
@@ -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
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 63 KiB |
BIN
_site/static/imgs/modules/opsgenie.png
Normal file
BIN
_site/static/imgs/modules/opsgenie.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 43 KiB |
@@ -24,7 +24,7 @@
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/gcal/" class="disabled">Google Calendar</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/jira/" class="disabled">Jira</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/" class="disabled">New Relic</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/" class="disabled">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/textfiles/" class="disabled">Text Files</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
|
||||
|
||||
@@ -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;
|
||||
|
||||
Reference in New Issue
Block a user