mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Adds the Security module to the documentation
This commit is contained in:
@@ -22,14 +22,14 @@ Available modules:
|
||||
<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>
|
||||
|
||||
@@ -39,10 +39,10 @@ bamboohr:
|
||||
refreshInterval: 900
|
||||
```
|
||||
|
||||
### Definitions
|
||||
### Attributes
|
||||
|
||||
`enabled` <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: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
|
||||
@@ -50,7 +50,7 @@ clocks:
|
||||
# Valid options are: alphabetical, chronological
|
||||
sort: "alphabetical"
|
||||
```
|
||||
### Definitions
|
||||
### Attributes
|
||||
|
||||
`colors.even` <br />
|
||||
Define the text color for even-numbered rows (2, 4, 6...). <br />
|
||||
@@ -62,6 +62,10 @@ Define the text color for the odd-numbered rows (1, 3, 5...). <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color name</a>.
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`locations` <br />
|
||||
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
|
||||
|
||||
72
_site/content/posts/modules/security.md
Normal file
72
_site/content/posts/modules/security.md
Normal file
@@ -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
|
||||
|
||||
<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>
|
||||
|
||||
#### Firewall
|
||||
|
||||
<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>
|
||||
|
||||
#### DNS
|
||||
|
||||
<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>
|
||||
|
||||
<img src="/imgs/modules/security.png" width="320" height="192" alt="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` <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`.
|
||||
BIN
_site/static/imgs/modules/security.png
Normal file
BIN
_site/static/imgs/modules/security.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
@@ -11,11 +11,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>
|
||||
|
||||
@@ -23,16 +19,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>
|
||||
|
||||
|
||||
@@ -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;
|
||||
|
||||
Reference in New Issue
Block a user