taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

Minimal Configuration documentation

Browse Source
This commit is contained in:
Chris Cummer 2018-04-15 21:50:00 -07:00 committed by Chris Cummer
parent a3220be597
commit 2c4c220ea7
13 changed files with 370 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
_site/content/posts/configuration.md
View File

@ -4,4 +4,33 @@ date: 2018-04-15T21:17:16-07:00
draft: false
---
h1. Configuration
By default WTF looks in a `~/.wtf/` directory for a YAML file called
`config.yml`. If `~/.wtf/` doesn't exist, WTF will create that directory
on start-up, and then display instructions for creating the
configuration file.
## Config.yml
## Example Config Files
A few example config files are provided in the `_sample_configs/`
directory of the Git repository. To try out WTF quickly, copy
`simple_config.yml` into `~/.wtf/` as `config.yml` and relaunch WTF. You
should see the app launch and display the _Security_ and _Status_
modules.
## Custom Configuration Files
To load a custom configuration file (ie: one that's not
`~/.wtf/config.yml`), pass in the path to configuration file as a
parameter on launch:
```bash
$> wtf --config=path/to/custom/config.yml
```
Example:
```bash
%> wtf --config=~/Documents/monitoring.yml
```
This is also the easiest way to run multiple instances of WTF, should
you want to run multiple independent dashboards.

BIN
docs/.DS_Store vendored
View File

Binary file not shown.

4
docs/404.html
View File

@ -39,9 +39,9 @@
<div class="container text-center sidebar-sticky">
<div class="sidebar-about text-center">
<a href="http://wtfutil.com/"><h1 class="brand"></h1></a>
<img src="/img/wtf.png" alt="WFT Logo" class="" width="">
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead">
Wtf is that?
...is going on?
</p>
</div>

4
docs/categories/index.html
View File

@ -41,9 +41,9 @@
<div class="container text-center sidebar-sticky">
<div class="sidebar-about text-center">
<a href="http://wtfutil.com/"><h1 class="brand"></h1></a>
<img src="/img/wtf.png" alt="WFT Logo" class="" width="">
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead">
Wtf is that?
...is going on?
</p>
</div>

BIN
docs/img/screenshot.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 511 KiB

BIN
docs/img/screenshot_sm.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 190 KiB

45
docs/index.html
View File

@ -40,9 +40,9 @@
<div class="container text-center sidebar-sticky">
<div class="sidebar-about text-center">
<a href="http://wtfutil.com/"><h1 class="brand"></h1></a>
<img src="/img/wtf.png" alt="WFT Logo" class="" width="">
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead">
Wtf is that?
...is going on?
</p>
</div>
@ -78,8 +78,49 @@
</div>
<div class="content container">
<a href="/img/screenshot.png" target="_screenshot"><img src='/img/screenshot_sm.png' /></a>
<p>
<strong>WTF</strong> is a personal information dashboard for your terminal, made for those who spend their days in the terminal.
</p>
<p>
It provides a framework for efficiently viewing important at-a-glance information quickly.
</p>
<p>
Keep an eye on your OpsGenie schedules, your Google Calendar schedule, Git and Github repositories, New Relic deployments, see who's away in BambooHR, and a few more.*
</p>
<p>
It even has weather. And emoji. But not too much emoji. That would be bad.
</p>
<p>
Get it on <a href="https://github.com/senorprogrammer/wtf" class="button">Github</a>.
</p>
<p>
<small>
*WTF is endorsed by absolutely none of the companies mentioned above.
</small>
</p>
<div class="posts">
<div class="post">
<h1 class="post-title"><a href="http://wtfutil.com/posts/configuration/">Configuration</a></h1>
</div>
<div class="footer">

11
docs/index.xml
View File

@ -6,9 +6,20 @@
<description>Recent content on </description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Sun, 15 Apr 2018 21:17:16 -0700</lastBuildDate>
<atom:link href="http://wtfutil.com/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Configuration</title>
<link>http://wtfutil.com/posts/configuration/</link>
<pubDate>Sun, 15 Apr 2018 21:17:16 -0700</pubDate>
<guid>http://wtfutil.com/posts/configuration/</guid>
<description>By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If ~/.wtf/ doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating the configuration file.
Config.yml Example Config Files A few example config files are provided in the _sample_configs/ directory of the Git repository. To try out WTF quickly, copy simple_config.yml into ~/.wtf/ as config.yml and relaunch WTF. You should see the app launch and display the Security and Status modules.</description>
</item>
</channel>
</rss>

141
docs/posts/configuration/index.html Normal file
View File

@ -0,0 +1,141 @@
<!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>Configuration &middot; </title>
<meta content="Configuration - " property="og:title">
<meta content=" - " property="og:description">
<!-- 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">
<!-- 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">
</head>
<body>
<div class="sidebar">
<div class="container text-center sidebar-sticky">
<div class="sidebar-about text-center">
<a href="http://wtfutil.com/"><h1 class="brand"></h1></a>
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead">
...is going on?
</p>
</div>
<div>
<ul class="sidebar-nav">
</li>
</ul>
</div>
<p>
<section class="row text-center">
</section>
</p>
<p class="copyright">&copy; 2018 Chris Cummer.
<a href="https://creativecommons.org/licenses/by/4.0">Some Rights Reserved</a>.<br/>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>
</div>
<div class="content container">
<div class="post">
<h1>Configuration</h1>
<div class="col-sm-12 col-md-12">
<span class="text-left post-date meta">
<i class="fas fa-calendar-alt"></i> Apr 15, 2018
<br/>
<i class="fas fa-clock"></i> 1 min read
</span>
</div>
<p>By default WTF looks in a <code>~/.wtf/</code> directory for a YAML file called
<code>config.yml</code>. If <code>~/.wtf/</code> doesn&rsquo;t exist, WTF will create that directory
on start-up, and then display instructions for creating the
configuration file.</p>
<h2 id="config-yml">Config.yml</h2>
<h2 id="example-config-files">Example Config Files</h2>
<p>A few example config files are provided in the <code>_sample_configs/</code>
directory of the Git repository. To try out WTF quickly, copy
<code>simple_config.yml</code> into <code>~/.wtf/</code> as <code>config.yml</code> and relaunch WTF. You
should see the app launch and display the <em>Security</em> and <em>Status</em>
modules.</p>
<h2 id="custom-configuration-files">Custom Configuration Files</h2>
<p>To load a custom configuration file (ie: one that&rsquo;s not
<code>~/.wtf/config.yml</code>), pass in the path to configuration file as a
parameter on launch:</p>
<pre><code class="language-bash"> $&gt; wtf --config=path/to/custom/config.yml
</code></pre>
<p>Example:</p>
<pre><code class="language-bash"> %&gt; wtf --config=~/Documents/monitoring.yml
</code></pre>
<p>This is also the easiest way to run multiple instances of WTF, should
you want to run multiple independent dashboards.</p>
</div>
<div class="footer">
</div>
</div>
</body>
</html>

101
docs/posts/index.html Normal file
View File

@ -0,0 +1,101 @@
<!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>Posts &middot; </title>
<meta content="Posts - " property="og:title">
<meta content=" - " property="og:description">
<!-- 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">
<!-- 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">
<!-- RSS -->
<link href="http://wtfutil.com/posts/index.xml" rel="alternate" type="application/rss+xml" title="" />
<link href="http://wtfutil.com/posts/index.xml" rel="feed" type="application/rss+xml" title="" />
</head>
<body>
<div class="sidebar">
<div class="container text-center sidebar-sticky">
<div class="sidebar-about text-center">
<a href="http://wtfutil.com/"><h1 class="brand"></h1></a>
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead">
...is going on?
</p>
</div>
<div>
<ul class="sidebar-nav">
</li>
</ul>
</div>
<p>
<section class="row text-center">
</section>
</p>
<p class="copyright">&copy; 2018 Chris Cummer.
<a href="https://creativecommons.org/licenses/by/4.0">Some Rights Reserved</a>.<br/>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>
</div>
<div class="content container">
<h1 class="title">Posts</h1>
<ul class="posts">
<li>
<span>
<a href="http://wtfutil.com/posts/configuration/">Configuration</a>
<time class="pull-right post-list">Apr 15, 2018</time>
</span>
</li>
</ul>
<div class="footer">
</div>
</div>
</body>
</html>

25
docs/posts/index.xml Normal file
View File

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>Posts on </title>
<link>http://wtfutil.com/posts/</link>
<description>Recent content in Posts on </description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Sun, 15 Apr 2018 21:17:16 -0700</lastBuildDate>
<atom:link href="http://wtfutil.com/posts/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Configuration</title>
<link>http://wtfutil.com/posts/configuration/</link>
<pubDate>Sun, 15 Apr 2018 21:17:16 -0700</pubDate>
<guid>http://wtfutil.com/posts/configuration/</guid>
<description>By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If ~/.wtf/ doesn&amp;rsquo;t exist, WTF will create that directory on start-up, and then display instructions for creating the configuration file.
Config.yml Example Config Files A few example config files are provided in the _sample_configs/ directory of the Git repository. To try out WTF quickly, copy simple_config.yml into ~/.wtf/ as config.yml and relaunch WTF. You should see the app launch and display the Security and Status modules.</description>
</item>
</channel>
</rss>

12
docs/sitemap.xml
View File

@ -2,8 +2,14 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
xmlns:xhtml="http://www.w3.org/1999/xhtml">
<url>
<loc>http://wtfutil.com/posts/configuration/</loc>
<lastmod>2018-04-15T21:17:16-07:00</lastmod>
</url>
<url>
<loc>http://wtfutil.com/</loc>
<lastmod>2018-04-15T21:17:16-07:00</lastmod>
<priority>0</priority>
</url>
@ -12,6 +18,12 @@
<priority>0</priority>
</url>
<url>
<loc>http://wtfutil.com/posts/</loc>
<lastmod>2018-04-15T21:17:16-07:00</lastmod>
<priority>0</priority>
</url>
<url>
<loc>http://wtfutil.com/tags/</loc>
<priority>0</priority>

4
docs/tags/index.html
View File

@ -41,9 +41,9 @@
<div class="container text-center sidebar-sticky">
<div class="sidebar-about text-center">
<a href="http://wtfutil.com/"><h1 class="brand"></h1></a>
<img src="/img/wtf.png" alt="WFT Logo" class="" width="">
<a href="http://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
<p class="lead">
Wtf is that?
...is going on?
</p>
</div>