mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Add documentation for IP-API modules
This commit is contained in:
Chris Cummer
parent
0a62a643fb
commit
1d1e280282
60
_site/content/posts/modules/ipapi.md
Normal file
60
_site/content/posts/modules/ipapi.md
Normal file
@ -0,0 +1,60 @@
|
||||
---
|
||||
title: "IP API"
|
||||
date: 2018-06-10T19:41:52-04:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
Displays your current IP address information, from [IP-APIcom](http://ip-api.com).
|
||||
|
||||
**Note:** IP-API.com has a free-plan rate limit of 120 requests per
|
||||
minute.
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/ipapi/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
None.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
ipinfo:
|
||||
colors:
|
||||
name: red
|
||||
value: white
|
||||
enabled: true
|
||||
position:
|
||||
top: 1
|
||||
left: 2
|
||||
height: 1
|
||||
width: 1
|
||||
refreshInterval: 150
|
||||
```
|
||||
### Attributes
|
||||
|
||||
`colors.name` <br />
|
||||
The default colour for the row names. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`colors.value` <br />
|
||||
The default colour for the row values. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`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: A positive integer, `0..n`.
|
||||
@ -6,11 +6,26 @@
|
||||
<description>Recent content on WTF - A Terminal Dashboard</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-us</language>
|
||||
<lastBuildDate>Sun, 10 Jun 2018 19:26:08 -0400</lastBuildDate>
|
||||
<lastBuildDate>Sun, 10 Jun 2018 19:41:52 -0400</lastBuildDate>
|
||||
|
||||
<atom:link href="https://wtfutil.com/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
|
||||
<item>
|
||||
<title>IP API</title>
|
||||
<link>https://wtfutil.com/posts/modules/ipapi/</link>
|
||||
<pubDate>Sun, 10 Jun 2018 19:41:52 -0400</pubDate>
|
||||
|
||||
<guid>https://wtfutil.com/posts/modules/ipapi/</guid>
|
||||
<description>Displays your current IP address information, from IP-APIcom.
|
||||
Note: IP-API.com has a free-plan rate limit of 120 requests per minute.
|
||||
Source Code wtf/ipapi/ Required ENV Variables None.
|
||||
Keyboard Commands None.
|
||||
Configuration ipinfo:colors:name:redvalue:whiteenabled:trueposition:top:1left:2height:1width:1refreshInterval:150 Attributes colors.name The default colour for the row names. Values: Any X11 color name.
|
||||
colors.value The default colour for the row values. Values: Any X11 color name.
|
||||
enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>CircleCI</title>
|
||||
<link>https://wtfutil.com/posts/modules/circleci/</link>
|
||||
|
||||
@ -101,6 +101,13 @@
|
||||
<h1 class="title">Posts</h1>
|
||||
<ul class="posts">
|
||||
<li>
|
||||
<span>
|
||||
<a href="https://wtfutil.com/posts/modules/ipapi/">IP API</a>
|
||||
|
||||
<time class="pull-right post-list">Jun 10, 2018</time>
|
||||
|
||||
</span>
|
||||
</li><li>
|
||||
<span>
|
||||
<a href="https://wtfutil.com/posts/modules/circleci/">CircleCI</a>
|
||||
|
||||
|
||||
@ -6,11 +6,26 @@
|
||||
<description>Recent content in Posts on WTF - A Terminal Dashboard</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-us</language>
|
||||
<lastBuildDate>Sun, 10 Jun 2018 19:26:08 -0400</lastBuildDate>
|
||||
<lastBuildDate>Sun, 10 Jun 2018 19:41:52 -0400</lastBuildDate>
|
||||
|
||||
<atom:link href="https://wtfutil.com/posts/index.xml" rel="self" type="application/rss+xml" />
|
||||
|
||||
|
||||
<item>
|
||||
<title>IP API</title>
|
||||
<link>https://wtfutil.com/posts/modules/ipapi/</link>
|
||||
<pubDate>Sun, 10 Jun 2018 19:41:52 -0400</pubDate>
|
||||
|
||||
<guid>https://wtfutil.com/posts/modules/ipapi/</guid>
|
||||
<description>Displays your current IP address information, from IP-APIcom.
|
||||
Note: IP-API.com has a free-plan rate limit of 120 requests per minute.
|
||||
Source Code wtf/ipapi/ Required ENV Variables None.
|
||||
Keyboard Commands None.
|
||||
Configuration ipinfo:colors:name:redvalue:whiteenabled:trueposition:top:1left:2height:1width:1refreshInterval:150 Attributes colors.name The default colour for the row names. Values: Any X11 color name.
|
||||
colors.value The default colour for the row values. Values: Any X11 color name.
|
||||
enabled Determines whether or not this module is executed and if its data displayed onscreen.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
<title>CircleCI</title>
|
||||
<link>https://wtfutil.com/posts/modules/circleci/</link>
|
||||
|
||||
177
docs/posts/modules/ipapi/index.html
Normal file
177
docs/posts/modules/ipapi/index.html
Normal file
@ -0,0 +1,177 @@
|
||||
<!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>IP API | WTF - A Terminal Dashboard</title>
|
||||
<meta content="IP API - WTF - A Terminal Dashboard" 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="https://wtfutil.com/css/print.css" media="print">
|
||||
<link rel="stylesheet" href="https://wtfutil.com/css/poole.css">
|
||||
<link rel="stylesheet" href="https://wtfutil.com/css/hyde.css">
|
||||
<link rel="stylesheet" href="https://wtfutil.com/css/syntax.css">
|
||||
<link rel="stylesheet" href="https://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="https://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">
|
||||
<div class="sidebar-about text-center">
|
||||
|
||||
<a href="https://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>
|
||||
<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>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/configuration/iterm2/">iTerm2</a></li>
|
||||
<li class="sidebar-list-item-1"><a href="https://github.com/senorprogrammer/wtf/releases">Releases</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/cryptocurrencies/bittrex/">Bittrex</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/circleci/">CircleCI</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/cryptocurrencies/cryptolive/">CryptoLive</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</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/gspreadsheet">Google Spreadsheet</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</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/power/">Power</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/prettyweather/">PrettyWeather</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/textfile/">Text File</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">
|
||||
© 2018 Chris Cummer.
|
||||
<br />
|
||||
<a href="https://creativecommons.org/licenses/by/4.0">Some Rights Reserved</a>.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="content container">
|
||||
<div class="post">
|
||||
<h1>IP API</h1>
|
||||
|
||||
<div class="col-sm-12 col-md-12">
|
||||
<span class="text-left post-date meta">
|
||||
|
||||
|
||||
Jun 10, 2018
|
||||
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
</span>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<p>Displays your current IP address information, from <a href="http://ip-api.com">IP-APIcom</a>.</p>
|
||||
|
||||
<p><strong>Note:</strong> IP-API.com has a free-plan rate limit of 120 requests per
|
||||
minute.</p>
|
||||
|
||||
<h2 id="source-code">Source Code</h2>
|
||||
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/ipapi/</code></pre></div>
|
||||
<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>
|
||||
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">ipinfo<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>colors<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>name<span class="p">:</span><span class="w"> </span>red<span class="w">
|
||||
</span><span class="w"> </span>value<span class="p">:</span><span class="w"> </span>white<span class="w">
|
||||
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||||
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
|
||||
</span><span class="w"> </span>left<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w">
|
||||
</span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
|
||||
</span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
|
||||
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">150</span></code></pre></div>
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<p><code>colors.name</code> <br />
|
||||
The default colour for the row names. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.</p>
|
||||
|
||||
<p><code>colors.value</code> <br />
|
||||
The default colour for the row values. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.</p>
|
||||
|
||||
<p><code>enabled</code> <br />
|
||||
Determines whether or not this module is executed and if 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’s widget will be displayed. <br /></p>
|
||||
|
||||
<p><code>refreshInterval</code> <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, <code>0..n</code>.</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -2,6 +2,11 @@
|
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
|
||||
xmlns:xhtml="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<url>
|
||||
<loc>https://wtfutil.com/posts/modules/ipapi/</loc>
|
||||
<lastmod>2018-06-10T19:41:52-04:00</lastmod>
|
||||
</url>
|
||||
|
||||
<url>
|
||||
<loc>https://wtfutil.com/posts/modules/circleci/</loc>
|
||||
<lastmod>2018-06-10T19:26:08-04:00</lastmod>
|
||||
@ -144,7 +149,7 @@
|
||||
|
||||
<url>
|
||||
<loc>https://wtfutil.com/posts/</loc>
|
||||
<lastmod>2018-06-10T19:26:08-04:00</lastmod>
|
||||
<lastmod>2018-06-10T19:41:52-04:00</lastmod>
|
||||
<priority>0</priority>
|
||||
</url>
|
||||
|
||||
@ -155,7 +160,7 @@
|
||||
|
||||
<url>
|
||||
<loc>https://wtfutil.com/</loc>
|
||||
<lastmod>2018-06-10T19:26:08-04:00</lastmod>
|
||||
<lastmod>2018-06-10T19:41:52-04:00</lastmod>
|
||||
<priority>0</priority>
|
||||
</url>
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user