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

Build of the site

Browse Source
This commit is contained in:
Chris Cummer
2018-05-08 20:24:31 -07:00
parent b55ca47678
commit 7edc5f8339
37 changed files with 1093 additions and 195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
docs/posts/configuration/index.html
View File

@@ -10,8 +10,8 @@
<meta name="generator" content="Hugo 0.38.2" />
<title>Configuration &middot; </title>
<meta content="Configuration - " property="og:title">
<title>Configuration | WTF</title>
<meta content="Configuration - WTF" property="og:title">
<meta content=" - " property="og:description">
<!-- CSS -->
<link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
@@ -19,6 +19,7 @@
<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>
@@ -40,7 +41,7 @@
<div class="sidebar">
<div class="container 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">
@@ -50,18 +51,28 @@
<div>
<h3 style="color: white;">Content</h3>
<ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/Installation/">Installation</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/configuration/">Configuration</a></li>
<li class="sidebar-list-item-1"><a href="/posts/overview/">Overview</a></li>
</ul>
<ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/modules/">Modules</a></li>
<li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
<li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
</ul>
<ul style="list-style-type: none;">
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/glossary/">Glossary</a></li>
<li style="font-size: 0.9em; margin: 0 0 0 12px;"><a href="/posts/source/">Source Code</a></li>
<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/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>
</ul>
</div>
@@ -97,22 +108,28 @@
<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
<code>config.yml</code>. If the <code>~/.wtf/</code> directory doesn&rsquo;t exist, WTF will create that directory
on start-up, and then display instructions for creating a new
configuration file.</p>
<h2 id="config-yml">Config.yml</h2>
<p>In other words, WTF expects to have a YAML config file at: <code>~/.wtf/config.yml</code>.</p>
<h2 id="example-config-files">Example Config Files</h2>
<h2 id="example-configuration-files">Example Configuration 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
<p>A couple of example config files are provided in the <code>_sample_configs/</code>
directory of the Git repository.</p>
<p>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>
should see the app launch and display the <a href="/posts/modules/security/">Security</a>,
<a href="/posts/modules/clocks/">Clocks</a> and <a href="/posts/modules/status/">Status</a> widgets onscreen.</p>
<h2 id="custom-configuration-files">Custom Configuration Files</h2>
<p>To try out different configurations (or run multiple instances of WTF),
you can pass the path to a config file via command line arguments on
start-up.</p>
<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>
@@ -120,14 +137,6 @@ 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">