Adds the Security module to the documentation

2025-01-18 04:03:14 -08:00 · 2018-05-08 20:48:11 -07:00
parent 7edc5f8339
commit 4542abce60
23 changed files with 461 additions and 190 deletions
--- a/docs/posts/modules/bamboohr/index.html
+++ b/docs/posts/modules/bamboohr/index.html
@@ -51,11 +51,7 @@
    <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>
-      </ul>
-
-      <ul style="list-style-type: none;">
-        <li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
+        <li class="sidebar-list-item-1"><a href="/posts/installation/" class="disabled">Installation</a></li>
        <li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
      </ul>

@@ -63,16 +59,16 @@
        <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/clocks/">Clocks</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/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/git/" class="disabled">Git</a></li>
+        <li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
+        <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/security/">Security</a></li>
-        <li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/">Text Files</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>
+        <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>
+        <li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
      </ul>
    </div>

@@ -140,10 +136,10 @@ Your <a href="https://www.bamboohr.com/api/documentation/">BambooHR API</a> subd
  refreshInterval: 900
 </code></pre>

-<h3 id="definitions">Definitions</h3>
+<h3 id="attributes">Attributes</h3>

 <p><code>enabled</code> <br />
-Whether or not this module is executed and its data displayed onscreen. <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 />
--- a/docs/posts/modules/clocks/index.html
+++ b/docs/posts/modules/clocks/index.html
@@ -51,11 +51,7 @@
    <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>
-      </ul>
-
-      <ul style="list-style-type: none;">
-        <li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
+        <li class="sidebar-list-item-1"><a href="/posts/installation/" class="disabled">Installation</a></li>
        <li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
      </ul>

@@ -63,16 +59,16 @@
        <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/clocks/">Clocks</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/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/git/" class="disabled">Git</a></li>
+        <li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
+        <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/security/">Security</a></li>
-        <li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/">Text Files</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>
+        <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>
+        <li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
      </ul>
    </div>

@@ -152,7 +148,7 @@
  sort: &quot;alphabetical&quot;
 </code></pre>

-<h3 id="definitions">Definitions</h3>
+<h3 id="attributes">Attributes</h3>

 <p><code>colors.even</code> <br />
 Define the text color for even-numbered rows (2, 4, 6&hellip;). <br />
@@ -164,6 +160,10 @@ Define the text color for the odd-numbered rows (1, 3, 5&hellip;). <br />
 Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
 color name</a>.</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>locations</code> <br />
 Defines the timezones for the world clocks that you want to display.
 <code>key</code> is a unique label that will be displayed in the UI. <code>value</code> is a
--- a/docs/posts/modules/index.html
+++ b/docs/posts/modules/index.html
@@ -51,11 +51,7 @@
    <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>
-      </ul>
-
-      <ul style="list-style-type: none;">
-        <li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
+        <li class="sidebar-list-item-1"><a href="/posts/installation/" class="disabled">Installation</a></li>
        <li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
      </ul>

@@ -63,16 +59,16 @@
        <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/clocks/">Clocks</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/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/git/" class="disabled">Git</a></li>
+        <li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
+        <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/security/">Security</a></li>
-        <li class="sidebar-list-item-2"><a href="/posts/modules/textfiles/">Text Files</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>
+        <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>
+        <li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
      </ul>
    </div>

@@ -123,16 +119,16 @@ display in the &ldquo;Clocks&rdquo; widget.</p>
 <ul class="list-bare">
  <li><a href="/posts/modules/bamboohr">BambooHR</a>
  <li><a href="/posts/modules/clocks">Clocks</a>
-  <li><a href="/posts/modules/git">Git</a>
-  <li><a href="/posts/modules/github">Github</a>
-  <li><a href="/posts/modules/gcal">Google Calendar</a>
-  <li><a href="/posts/modules/jira">Jira</a>
-  <li><a href="/posts/modules/newrelic">New Relic</a>
-  <li><a href="/posts/modules/opsgenie">OpsGenie</a>
+  <li><a href="/posts/modules/git" class="disabled">Git</a>
+  <li><a href="/posts/modules/github" class="disabled">Github</a>
+  <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/security">Security</a>
-  <li><a href="/posts/modules/textfiles">Text Files</a>
-  <li><a href="/posts/modules/todo">Todo</a>
-  <li><a href="/posts/modules/weather">Weather</a>
+  <li><a href="/posts/modules/textfiles" class="disabled">Text Files</a>
+  <li><a href="/posts/modules/todo" class="disabled">Todo</a>
+  <li><a href="/posts/modules/weather" class="disabled">Weather</a>
 </ul>

 </div>
--- a/docs/posts/modules/security/index.html
+++ b/docs/posts/modules/security/index.html
@@ -0,0 +1,181 @@
+<!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>Security | WTF</title>
+<meta content="Security - WTF" 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="http://wtfutil.com/css/print.css" media="print">
+<link rel="stylesheet" href="http://wtfutil.com/css/poole.css">
+<link rel="stylesheet" href="http://wtfutil.com/css/hyde.css">
+<link rel="stylesheet" href="http://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="http://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 sidebar-sticky">
+		<div class="sidebar-about text-center">
+			
+      <a href="http://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/installation/" class="disabled">Installation</a></li>
+        <li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</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/clocks/">Clocks</a></li>
+        <li class="sidebar-list-item-2"><a href="/posts/modules/git/" class="disabled">Git</a></li>
+        <li class="sidebar-list-item-2"><a href="/posts/modules/github/" class="disabled">Github</a></li>
+        <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/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>
+        <li class="sidebar-list-item-2"><a href="/posts/modules/weather/" class="disabled">Weather</a></li>
+      </ul>
+    </div>
+
+    <p class="copyright">
+      &copy; 2018 Chris Cummer.
+      <br />
+      <a href="https://creativecommons.org/licenses/by/4.0">Some Rights Reserved</a>.
+    </p>
+    <p class="copyright">
+      Built with <a href="https://gohugo.io/">Hugo</a> &amp; <a href="https://github.com/htr3n/hyde-hyde">hyde-hyde</a>.
+    </p>
+	</div>
+</div>
+
+        <div class="content container">
+            <div class="post">
+  <h1>Security</h1>
+  
+  <div class="col-sm-12 col-md-12">
+    <span class="text-left post-date meta">
+            
+       
+        <i class="fas fa-calendar-alt"></i> May 08, 2018
+      
+      
+      
+      
+      <br/>
+      <i class="fas fa-clock"></i> 1 min read 
+      </span>  
+  </div>    
+  
+  
+
+<h2 id="description">Description</h2>
+
+<p>Displays some general information about the state of the machine&rsquo;s wifi
+connection, firewall, and DNS settings.</p>
+
+<h4 id="wifi-network">Wifi Network</h4>
+
+<ul class="list-ornate">
+  <li>The name of the current network</li>
+  <li>Whether or not the network uses <a href="https://www.howtogeek.com/167783/htg-explains-the-difference-between-wep-wpa-and-wpa2-wireless-encryption-and-why-it-matters/">encryption</a> and if so, what flavour</li>
+</ul>
+
+<h4 id="firewall">Firewall</h4>
+
+<ul class="list-ornate">
+<li>Whether or not the <a href="https://support.apple.com/en-ca/HT201642">firewall</a> is enabled</li>
+<li>Whether or not <a href="https://support.apple.com/en-ca/HT201642">Stealth Mode</a> is enabled</li>
+</ul>
+
+<h4 id="dns">DNS</h4>
+
+<ul class="list-ornate">
+<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>
+
+<p><img src="/imgs/modules/security.png" width="320" height="192" alt="clocks screenshot" /></p>
+
+<h2 id="location">Location</h2>
+
+<pre><code class="language-bash">wtf/security
+</code></pre>
+
+<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>
+
+<pre><code class="language-yaml">security:
+  enabled: true
+  position:
+    top: 1
+    left: 2
+    height: 1
+    width: 1
+  refreshInterval: 3600
+</code></pre>
+
+<h3 id="attributes">Attributes</h3>
+
+<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&rsquo;s widget will be displayed. <br /></p>
+
+<p><code>refreshInterval</code> <br />
+How often, in seconds, this module will update its data. <br />
+Values: Any positive integer, <code>0...n</code>.</p>
+
+</div>
+            <div class="footer">
+                
+
+
+            </div>
+        </div>
+        
+                
+    </body>
+</html>