diff --git a/_site/content/posts/modules/ipapi.md b/_site/content/posts/modules/ipapi.md new file mode 100644 index 00000000..e93c3410 --- /dev/null +++ b/_site/content/posts/modules/ipapi.md @@ -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`
+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.
+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/index.xml b/docs/index.xml index 0259bfcb..0da6f5b2 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -6,11 +6,26 @@ Recent content on WTF - A Terminal Dashboard Hugo -- gohugo.io en-us - Sun, 10 Jun 2018 19:26:08 -0400 + Sun, 10 Jun 2018 19:41:52 -0400 + + IP API + https://wtfutil.com/posts/modules/ipapi/ + Sun, 10 Jun 2018 19:41:52 -0400 + + https://wtfutil.com/posts/modules/ipapi/ + 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. + + CircleCI https://wtfutil.com/posts/modules/circleci/ diff --git a/docs/posts/index.html b/docs/posts/index.html index ddb5c845..80f562b5 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -101,6 +101,13 @@

Posts