mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
560 lines
19 KiB
HTML
560 lines
19 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<title>WTF - the terminal dashboard</title>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
|
|
<meta name="generator" content="Hugo 0.38.2" />
|
|
<title>Configuration :: WTF - the terminal dashboard</title>
|
|
<link rel="shortcut icon" href="/images/favicon.png" type="image/x-icon" />
|
|
<link href="/css/font-awesome.min.css" rel="stylesheet">
|
|
<link href="/css/nucleus.css" rel="stylesheet">
|
|
<link href="/theme-flex/style.css" rel="stylesheet">
|
|
|
|
<link rel="stylesheet" href="/css/bootstrap.min.css">
|
|
<script src="/js/jquery-2.x.min.js"></script>
|
|
<script type="text/javascript">
|
|
var baseurl = "\/";
|
|
</script>
|
|
<meta name="description" content="">
|
|
|
|
|
|
|
|
|
|
</head>
|
|
<body data-url="/posts/configuration/">
|
|
|
|
<header>
|
|
<div class="logo">
|
|
|
|
|
|
|
|
<a class="baselink" href="/">WTF - the terminal dashboard</a>
|
|
|
|
|
|
</div>
|
|
<div class="burger"><a href="javascript:void(0);" style="font-size:15px;">☰</a></div>
|
|
<nav class="shortcuts">
|
|
<li class="" role="">
|
|
<a href="https://github.com/senorprogrammer/wtf" rel="noopener">
|
|
<i class='fa fa-github'></i> <label>WTF on Github</label>
|
|
</a>
|
|
</li>
|
|
<li class="" role="">
|
|
<a href="https://github.com/senorprogrammer/wtf/releases" rel="noopener">
|
|
<i class='fa fa-cloud-download'></i> <label>Download WTF</label>
|
|
</a>
|
|
</li>
|
|
<li class="" role="">
|
|
<a href="https://github.com/senorprogrammer/wtf/blob/master/README.md" rel="noopener">
|
|
<i class='fa fa-bullhorn'></i> <label>Credits</label>
|
|
</a>
|
|
</li>
|
|
</nav>
|
|
</header>
|
|
<article>
|
|
<aside>
|
|
<ul class="menu">
|
|
<li data-nav-id="/" class="dd-item">
|
|
<a href="/">
|
|
<i class="fa fa-fw fa-home"></i>
|
|
</a>
|
|
</li>
|
|
<li data-nav-id="/posts/" class="dd-item parent haschildren
|
|
">
|
|
<div>
|
|
<a href="/posts/">Posts</a>
|
|
<i class="fa fa-angle-down fa-lg category-icon"></i><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
<ul>
|
|
<li data-nav-id="/posts/modules/twitter/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/twitter/">
|
|
Twitter
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/zendesk/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/zendesk/">
|
|
Zendesk
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/travisci/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/travisci/">
|
|
TravisCI
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/todoist/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/todoist/">
|
|
Todoist
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/gerrit/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/gerrit/">
|
|
Gerrit
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/logger/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/logger/">
|
|
Logger
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/cryptocurrencies/blockfolio/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/cryptocurrencies/blockfolio/">
|
|
Blockfolio
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/ipapi/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/ipapi/">
|
|
IP-API
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/circleci/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/circleci/">
|
|
CircleCI
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/gspreadsheet/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/gspreadsheet/">
|
|
Google Spreadsheets
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/jenkins/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/jenkins/">
|
|
Modules: Jenkins
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/gitlab/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/gitlab/">
|
|
GitLab
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/cryptocurrencies/bittrex/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/cryptocurrencies/bittrex/">
|
|
Bittrex
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/cryptocurrencies/cryptolive/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/cryptocurrencies/cryptolive/">
|
|
CryptoLive
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/prettyweather/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/prettyweather/">
|
|
Pretty Weather
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/ipinfo/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/ipinfo/">
|
|
IPInfo
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/power/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/power/">
|
|
Power
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/configuration/iterm2/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/configuration/iterm2/">
|
|
Configuration: iTerm2
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/overview/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/overview/">
|
|
Overview
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/installation/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/installation/">
|
|
Installation
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/cmdrunner/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/cmdrunner/">
|
|
CmdRunner
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/configuration/attributes/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/configuration/attributes/">
|
|
Configuration: Attributes
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/todo/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/todo/">
|
|
Todo
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/jira/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/jira/">
|
|
Jira
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/trello/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/trello/">
|
|
Trello
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/gcal/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/gcal/">
|
|
Google Calendar
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/github/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/github/">
|
|
GitHub
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/git/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/git/">
|
|
Git
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/weather/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/weather/">
|
|
Weather
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/textfile/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/textfile/">
|
|
Textfile
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/newrelic/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/newrelic/">
|
|
New Relic
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/opsgenie/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/opsgenie/">
|
|
OpsGenie
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/security/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/security/">
|
|
Security
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/bamboohr/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/bamboohr/">
|
|
BambooHR
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/clocks/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/clocks/">
|
|
Clocks
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/modules/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/modules/">
|
|
Modules
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/glossary/" class="dd-item">
|
|
<div>
|
|
<a href="/posts/glossary/">
|
|
Glossary
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
<li data-nav-id="/posts/configuration/" class="dd-item active">
|
|
<div>
|
|
<a href="/posts/configuration/">
|
|
Configuration
|
|
</a><i class="fa fa-circle-thin read-icon"></i>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
<section>
|
|
</section>
|
|
</aside>
|
|
<section class="page">
|
|
|
|
<div class="nav-select">
|
|
<center>Navigation :
|
|
<select onchange="javascript:location.href = this.value;">
|
|
|
|
<option value="/posts/" >
|
|
Posts</option>
|
|
<option value="/posts/modules/twitter/" >- Twitter</option>
|
|
<option value="/posts/modules/zendesk/" >- Zendesk</option>
|
|
<option value="/posts/modules/travisci/" >- TravisCI</option>
|
|
<option value="/posts/modules/todoist/" >- Todoist</option>
|
|
<option value="/posts/modules/gerrit/" >- Gerrit</option>
|
|
<option value="/posts/modules/logger/" >- Logger</option>
|
|
<option value="/posts/modules/cryptocurrencies/blockfolio/" >- Blockfolio</option>
|
|
<option value="/posts/modules/ipapi/" >- IP-API</option>
|
|
<option value="/posts/modules/circleci/" >- CircleCI</option>
|
|
<option value="/posts/modules/gspreadsheet/" >- Google Spreadsheets</option>
|
|
<option value="/posts/modules/jenkins/" >- Modules: Jenkins</option>
|
|
<option value="/posts/modules/gitlab/" >- GitLab</option>
|
|
<option value="/posts/modules/cryptocurrencies/bittrex/" >- Bittrex</option>
|
|
<option value="/posts/modules/cryptocurrencies/cryptolive/" >- CryptoLive</option>
|
|
<option value="/posts/modules/prettyweather/" >- Pretty Weather</option>
|
|
<option value="/posts/modules/ipinfo/" >- IPInfo</option>
|
|
<option value="/posts/modules/power/" >- Power</option>
|
|
<option value="/posts/configuration/iterm2/" >- Configuration: iTerm2</option>
|
|
<option value="/posts/overview/" >- Overview</option>
|
|
<option value="/posts/installation/" >- Installation</option>
|
|
<option value="/posts/modules/cmdrunner/" >- CmdRunner</option>
|
|
<option value="/posts/configuration/attributes/" >- Configuration: Attributes</option>
|
|
<option value="/posts/modules/todo/" >- Todo</option>
|
|
<option value="/posts/modules/jira/" >- Jira</option>
|
|
<option value="/posts/modules/trello/" >- Trello</option>
|
|
<option value="/posts/modules/gcal/" >- Google Calendar</option>
|
|
<option value="/posts/modules/github/" >- GitHub</option>
|
|
<option value="/posts/modules/git/" >- Git</option>
|
|
<option value="/posts/modules/weather/" >- Weather</option>
|
|
<option value="/posts/modules/textfile/" >- Textfile</option>
|
|
<option value="/posts/modules/newrelic/" >- New Relic</option>
|
|
<option value="/posts/modules/opsgenie/" >- OpsGenie</option>
|
|
<option value="/posts/modules/security/" >- Security</option>
|
|
<option value="/posts/modules/bamboohr/" >- BambooHR</option>
|
|
<option value="/posts/modules/clocks/" >- Clocks</option>
|
|
<option value="/posts/modules/" >- Modules</option>
|
|
<option value="/posts/glossary/" >- Glossary</option>
|
|
<option value="/posts/configuration/" selected>- Configuration</option>
|
|
|
|
|
|
|
|
|
|
</select>
|
|
</center>
|
|
</div>
|
|
<div>
|
|
<div class="searchbox">
|
|
<input data-search-input id="search-by" type="text" placeholder="Search...">
|
|
</div>
|
|
<script type="text/javascript" src="/js/lunr.min.js"></script>
|
|
<script type="text/javascript" src="/js/auto-complete.js"></script>
|
|
<link href="/css/auto-complete.css" rel="stylesheet">
|
|
<script type="text/javascript">
|
|
|
|
var baseurl = "\/";
|
|
|
|
</script>
|
|
<script type="text/javascript" src="/js/search.js"></script>
|
|
</div>
|
|
|
|
|
|
<h1>Configuration</h1>
|
|
|
|
|
|
|
|
|
|
|
|
<h2 id="index">Index</h2>
|
|
|
|
<ul>
|
|
<li><a href="#configuration-files">Configuration Files</a></li>
|
|
<li><a href="#environment-env-variables">Environment (ENV) Variables</a></li>
|
|
<li><a href="#grid-layout">Grid Layout</a></li>
|
|
</ul>
|
|
|
|
<h2 id="configuration-files">Configuration Files</h2>
|
|
|
|
<p>By default WTF looks in a <code>~/.config/wtf/</code> directory for a YAML file called
|
|
<code>config.yml</code>. If the <code>~/.config/wtf/</code> directory doesn’t exist, WTF will create that directory
|
|
on start-up, and then display instructions for creating a new
|
|
configuration file.</p>
|
|
|
|
<p>In other words, WTF expects to have a YAML config file at: <code>~/.config/wtf/config.yml</code>.</p>
|
|
|
|
<h4 id="example-configuration-files">Example Configuration Files</h4>
|
|
|
|
<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>~/.config/wtf/</code> as <code>config.yml</code> and relaunch WTF. You
|
|
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>
|
|
|
|
<h4 id="custom-configuration-files">Custom Configuration Files</h4>
|
|
|
|
<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’s not
|
|
<code>~/.config/wtf/config.yml</code>), pass in the path to configuration file as a
|
|
parameter on launch:</p>
|
|
<div class="highlight"><pre style="color:#272822;background-color:#fafafa;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash"> $> wtf --config<span style="color:#f92672">=</span>path/to/custom/config.yml</code></pre></div>
|
|
<h4 id="configuration-attributes">Configuration Attributes</h4>
|
|
|
|
<p>A number of top-level attributes can be set to customize your WTF
|
|
install. See <a href="/posts/configuration/attributes/">Attributes</a> for details.</p>
|
|
|
|
<h2 id="environment-env-variables">Environment (ENV) Variables</h2>
|
|
|
|
<p>Some modules require the presence of environment variables to function
|
|
properly. Usually these are API keys or other sensitive data that one
|
|
wouldn’t want to have laying about in the config files.</p>
|
|
|
|
<p>For modules that require them, the name of the required environment
|
|
variable(s) can be found in that module’s “Required ENV Variables”
|
|
section of the documentation. See <a href="/posts/modules/opsgenie/">OpsGenie</a> for an example.</p>
|
|
|
|
<h2 id="grid-layout">Grid Layout</h2>
|
|
|
|
<p>WTF uses the <code>Grid</code> layout system from <a href="https://github.com/rivo/tview/blob/master/grid.go">tview</a> to position widgets
|
|
onscreen. It’s not immediately obvious how this works, so here’s an
|
|
explanation:</p>
|
|
|
|
<p>Think of your terminal screen as a matrix of letter positions, say <code>100</code> chrs wide and <code>58</code> chrs tall.</p>
|
|
|
|
<p>Columns breaks up the width of the screen into chunks, each chunk a specified number of characters wide. use</p>
|
|
|
|
<p><code>[10, 10, 10, 10, 10, 10, 10, 10, 10, 10]</code></p>
|
|
|
|
<p>Ten columns that are ten characters wide</p>
|
|
|
|
<p>Rows break up the height of the screen into chunks, each chunk a specified number of characters tall. If we wanted to have five rows:</p>
|
|
|
|
<p><code>[10, 10, 10, 10, 18]</code></p>
|
|
|
|
<p>The co-ordinate system starts at top-left and defines how wide and tall a widget is. If we wanted to put a 2-col, 2-row widget in the bottom of the screen, we’d position it at:</p>
|
|
|
|
<pre><code> top: 4 // top starts in the 4th row
|
|
left: 9 // left starts in the 9th column
|
|
height: 2 // span down rows 4 & 5 (18 characters in size, total)
|
|
width: 2 // span across cols 9 & 10 (20 characters in size, total)
|
|
</code></pre>
|
|
|
|
|
|
|
|
|
|
<div class="chevrons">
|
|
<div id="navigation">
|
|
<a class="nav nav-prev" href="/posts/glossary/" title="Glossary"> <i class="fa fa-chevron-left"></i><label>Glossary</label></a>
|
|
<a class="nav nav-next" href="/posts/modules/twitter/" title="Twitter" style="margin-right: 0px;"><label>Twitter</label><i class="fa fa-chevron-right"></i></a></div>
|
|
</div>
|
|
|
|
</section>
|
|
</article>
|
|
|
|
<footer>
|
|
|
|
<div class="footline">
|
|
|
|
|
|
|
|
|
|
|
|
<div class="date">
|
|
<i class='fa fa-calendar'></i> Last update on 15/04/2018
|
|
</div>
|
|
|
|
|
|
<div class="github-link">
|
|
<a href="https://github.com/vjeantet/hugo-theme-docdock/edit/master/exampleSite/content/posts/configuration.md" target="blank"><i class="fa fa-code-fork"></i>
|
|
Improve this page</a>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div>
|
|
|
|
|
|
|
|
Create a content/_footer.md file to customize the footer content
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</footer>
|
|
|
|
<script src="/js/clipboard.min.js"></script>
|
|
|
|
<link href="/css/featherlight.min.css" rel="stylesheet">
|
|
<script src="/js/featherlight.min.js"></script>
|
|
|
|
|
|
|
|
<script src="/theme-flex/script.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html> |