1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
2018-05-14 21:04:37 -07:00

142 lines
4.9 KiB
HTML

<!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 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">
<!-- 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/"><h1 class="brand"></h1></a>
<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 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>
</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>
</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>
</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>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>