diff --git a/_site/content/posts/modules.md b/_site/content/posts/modules.md index 19d36a90..463f2524 100644 --- a/_site/content/posts/modules.md +++ b/_site/content/posts/modules.md @@ -22,14 +22,14 @@ Available modules: diff --git a/_site/content/posts/modules/bamboohr.md b/_site/content/posts/modules/bamboohr.md index 7f377ac5..5c3bf201 100644 --- a/_site/content/posts/modules/bamboohr.md +++ b/_site/content/posts/modules/bamboohr.md @@ -39,10 +39,10 @@ bamboohr: refreshInterval: 900 ``` -### Definitions +### Attributes `enabled`
-Whether or not this module is executed and its data displayed onscreen.
+Determines whether or not this module is executed and if its data displayed onscreen.
Values: `true`, `false`. `position`
diff --git a/_site/content/posts/modules/clocks.md b/_site/content/posts/modules/clocks.md index 2d33c34e..43580a59 100644 --- a/_site/content/posts/modules/clocks.md +++ b/_site/content/posts/modules/clocks.md @@ -50,7 +50,7 @@ clocks: # Valid options are: alphabetical, chronological sort: "alphabetical" ``` -### Definitions +### Attributes `colors.even`
Define the text color for even-numbered rows (2, 4, 6...).
@@ -62,6 +62,10 @@ Define the text color for the odd-numbered rows (1, 3, 5...).
Values: Any X11 color name. +`enabled`
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + `locations`
Defines the timezones for the world clocks that you want to display. `key` is a unique label that will be displayed in the UI. `value` is a diff --git a/_site/content/posts/modules/security.md b/_site/content/posts/modules/security.md new file mode 100644 index 00000000..eaeb6df6 --- /dev/null +++ b/_site/content/posts/modules/security.md @@ -0,0 +1,72 @@ +--- +title: "Security" +date: 2018-05-08T20:33:28-07:00 +draft: false +--- + +## Description + +Displays some general information about the state of the machine's wifi +connection, firewall, and DNS settings. + +#### Wifi Network + + + +#### Firewall + + + +#### DNS + + + +clocks screenshot + +## Location + +```bash +wtf/security +``` + +## Required ENV Variables + +None. + +## Keyboard Commands + +None. + +## Configuration + +```yaml +security: + enabled: true + position: + top: 1 + left: 2 + height: 1 + width: 1 + refreshInterval: 3600 +``` + +### 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/static/imgs/modules/security.png b/_site/static/imgs/modules/security.png new file mode 100644 index 00000000..380ee287 Binary files /dev/null and b/_site/static/imgs/modules/security.png differ diff --git a/_site/themes/hyde-hyde/layouts/partials/sidebar.html b/_site/themes/hyde-hyde/layouts/partials/sidebar.html index 8a8aea86..bf348ea0 100644 --- a/_site/themes/hyde-hyde/layouts/partials/sidebar.html +++ b/_site/themes/hyde-hyde/layouts/partials/sidebar.html @@ -11,11 +11,7 @@

Content

- - @@ -23,16 +19,16 @@ - - - - - - + + + + + + - - - + + +
diff --git a/_site/themes/hyde-hyde/static/css/wtf.css b/_site/themes/hyde-hyde/static/css/wtf.css index 2246b446..32c5e206 100644 --- a/_site/themes/hyde-hyde/static/css/wtf.css +++ b/_site/themes/hyde-hyde/static/css/wtf.css @@ -1,4 +1,4 @@ -h1, h2, h3 { +h1, h2, h3, h4 { letter-spacing: 0.25px; } @@ -14,14 +14,25 @@ pre code { padding-left: 8px !important; } +.disabled { + color: gray !important; + cursor: not-allowed; + opacity: 0.5 !important; + text-decoration: none !important; +} + .list-bare { list-style-type: none; } -.list-bare li { +.list-bare li, .list-ornate li { margin: 2px 0 0 12px; } +.list-ornate { + list-style-type: disc; +} + .sidebar-list-item-1 { font-size: 0.9em; margin: 0 0 0 12px; diff --git a/docs/404.html b/docs/404.html index bc171d07..526ee95e 100644 --- a/docs/404.html +++ b/docs/404.html @@ -51,11 +51,7 @@

Content

- - @@ -63,16 +59,16 @@ - - - - - - + + + + + + - - - + + +
diff --git a/docs/categories/index.html b/docs/categories/index.html index 0c9194ef..4847d788 100644 --- a/docs/categories/index.html +++ b/docs/categories/index.html @@ -53,11 +53,7 @@

Content

- - @@ -65,16 +61,16 @@ - - - - - - + + + + + + - - - + + +
diff --git a/docs/css/wtf.css b/docs/css/wtf.css index 2246b446..32c5e206 100644 --- a/docs/css/wtf.css +++ b/docs/css/wtf.css @@ -1,4 +1,4 @@ -h1, h2, h3 { +h1, h2, h3, h4 { letter-spacing: 0.25px; } @@ -14,14 +14,25 @@ pre code { padding-left: 8px !important; } +.disabled { + color: gray !important; + cursor: not-allowed; + opacity: 0.5 !important; + text-decoration: none !important; +} + .list-bare { list-style-type: none; } -.list-bare li { +.list-bare li, .list-ornate li { margin: 2px 0 0 12px; } +.list-ornate { + list-style-type: disc; +} + .sidebar-list-item-1 { font-size: 0.9em; margin: 0 0 0 12px; diff --git a/docs/imgs/modules/security.png b/docs/imgs/modules/security.png new file mode 100644 index 00000000..380ee287 Binary files /dev/null and b/docs/imgs/modules/security.png differ diff --git a/docs/index.html b/docs/index.html index 3d8939af..af54c993 100644 --- a/docs/index.html +++ b/docs/index.html @@ -52,11 +52,7 @@

Content

- - @@ -64,16 +60,16 @@ - - - - - - + + + + + + - - - + + +
diff --git a/docs/index.xml b/docs/index.xml index bb0101cb..9b90f030 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -6,11 +6,21 @@ Recent content on WTF Hugo -- gohugo.io en-us - Mon, 07 May 2018 20:17:37 -0700 + Tue, 08 May 2018 20:33:28 -0700 + + Security + http://wtfutil.com/posts/modules/security/ + Tue, 08 May 2018 20:33:28 -0700 + + http://wtfutil.com/posts/modules/security/ + Description Displays some general information about the state of the machine’s wifi connection, firewall, and DNS settings. +Wifi Network The name of the current network Whether or not the network uses encryption and if so, what flavour Firewall Whether or not the firewall is enabled Whether or not Stealth Mode is enabled DNS Which DNS resolvers (servers) the machine is configured to use Location wtf/security Required ENV Variables None. + + Bamboohr http://wtfutil.com/posts/modules/bamboohr/ @@ -21,7 +31,7 @@ Location wtf/bamboohr Required ENV Variables WTF_BAMBOO_HR_TOKEN Your BambooHR API token. WTF_BAMBOO_HR_SUBDOMAIN Your BambooHR API subdomain name. Keyboard Commands None. -Configuration bamboohr: enabled: true position: top: 0 left: 1 height: 2 width: 1 refreshInterval: 900 Definitions enabled Whether or not this module is executed and its data displayed onscreen. Values: true, false. +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. @@ -34,7 +44,7 @@ position Defines where in the grid this module’s widget will be displa Description Displays a configurable list of world clocks, the local time, and date. Location wtf/clocks/ Required ENV Variables None. Keyboard Commands None. -Configuration clocks: colors: rows: even: "lightblue" odd: "white" enabled: true locations: # From https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Avignon: "Europe/Paris" Barcelona: "Europe/Madrid" Dubai: "Asia/Dubai" UTC: "Etc/UTC" Vancouver: "America/Vancouver" Toronto: "America/Toronto" position: top: 4 left: 0 height: 1 width: 1 refreshInterval: 15 # Valid options are: alphabetical, chronological sort: "alphabetical" Definitions colors. +Configuration clocks: colors: rows: even: "lightblue" odd: "white" enabled: true locations: # From https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Avignon: "Europe/Paris" Barcelona: "Europe/Madrid" Dubai: "Asia/Dubai" UTC: "Etc/UTC" Vancouver: "America/Vancouver" Toronto: "America/Toronto" position: top: 4 left: 0 height: 1 width: 1 refreshInterval: 15 # Valid options are: alphabetical, chronological sort: "alphabetical" Attributes colors. diff --git a/docs/posts/configuration/index.html b/docs/posts/configuration/index.html index bdb0871b..1e86ebc4 100644 --- a/docs/posts/configuration/index.html +++ b/docs/posts/configuration/index.html @@ -51,11 +51,7 @@

Content

- - @@ -63,16 +59,16 @@ - - - - - - + + + + + + - - - + + +
diff --git a/docs/posts/glossary/index.html b/docs/posts/glossary/index.html index 84cfa086..00abff6f 100644 --- a/docs/posts/glossary/index.html +++ b/docs/posts/glossary/index.html @@ -51,11 +51,7 @@

Content

- - @@ -63,16 +59,16 @@ - - - - - - + + + + + + - - - + + +
diff --git a/docs/posts/index.html b/docs/posts/index.html index 371a9877..8892b031 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -53,11 +53,7 @@

Content

- - @@ -65,16 +61,16 @@ - - - - - - + + + + + + - - - + + +
@@ -93,6 +89,13 @@

Posts

@@ -140,10 +136,10 @@ Your BambooHR API subd refreshInterval: 900 -

Definitions

+

Attributes

enabled
-Whether or not this module is executed and its data displayed onscreen.
+Determines whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

position
diff --git a/docs/posts/modules/clocks/index.html b/docs/posts/modules/clocks/index.html index 45b6b291..9fc791c0 100644 --- a/docs/posts/modules/clocks/index.html +++ b/docs/posts/modules/clocks/index.html @@ -51,11 +51,7 @@

Content

- - @@ -63,16 +59,16 @@ - - - - - - + + + + + + - - - + + +
@@ -152,7 +148,7 @@ sort: "alphabetical" -

Definitions

+

Attributes

colors.even
Define the text color for even-numbered rows (2, 4, 6…).
@@ -164,6 +160,10 @@ Define the text color for the odd-numbered rows (1, 3, 5…).
Values: Any X11 color name.

+

enabled
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: true, false.

+

locations
Defines the timezones for the world clocks that you want to display. key is a unique label that will be displayed in the UI. value is a diff --git a/docs/posts/modules/index.html b/docs/posts/modules/index.html index 2f069949..26e65271 100644 --- a/docs/posts/modules/index.html +++ b/docs/posts/modules/index.html @@ -51,11 +51,7 @@

Content

- - @@ -63,16 +59,16 @@ - - - - - - + + + + + + - - - + + +
@@ -123,16 +119,16 @@ display in the “Clocks” widget.

diff --git a/docs/posts/modules/security/index.html b/docs/posts/modules/security/index.html new file mode 100644 index 00000000..ead86148 --- /dev/null +++ b/docs/posts/modules/security/index.html @@ -0,0 +1,181 @@ + + + + + + + + + + + + +Security | WTF + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+

Security

+ +
+ +
+ + + +

Description

+ +

Displays some general information about the state of the machine’s wifi +connection, firewall, and DNS settings.

+ +

Wifi Network

+ +
    +
  • The name of the current network
  • +
  • Whether or not the network uses encryption and if so, what flavour
  • +
+ +

Firewall

+ + + +

DNS

+ +
    +
  • Which DNS resolvers (servers) the machine is configured to use
  • +
+ +

clocks screenshot

+ +

Location

+ +
wtf/security
+
+ +

Required ENV Variables

+ +

None.

+ +

Keyboard Commands

+ +

None.

+ +

Configuration

+ +
security:
+  enabled: true
+  position:
+    top: 1
+    left: 2
+    height: 1
+    width: 1
+  refreshInterval: 3600
+
+ +

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/docs/sitemap.xml b/docs/sitemap.xml index 208b4920..61733959 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -2,6 +2,11 @@ + + http://wtfutil.com/posts/modules/security/ + 2018-05-08T20:33:28-07:00 + + http://wtfutil.com/posts/modules/bamboohr/ 2018-05-07T20:17:37-07:00 @@ -34,7 +39,7 @@ http://wtfutil.com/posts/ - 2018-05-07T20:17:37-07:00 + 2018-05-08T20:33:28-07:00 0 @@ -45,7 +50,7 @@ http://wtfutil.com/ - 2018-05-07T20:17:37-07:00 + 2018-05-08T20:33:28-07:00 0 diff --git a/docs/tags/index.html b/docs/tags/index.html index 73542d37..80a2ce73 100644 --- a/docs/tags/index.html +++ b/docs/tags/index.html @@ -53,11 +53,7 @@

Content

- - @@ -65,16 +61,16 @@ - - - - - - + + + + + + - - - + + +