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

Minor doc tweaks

This commit is contained in:
Chris Cummer 2018-05-17 09:27:46 -07:00
parent ba402358e6
commit b6dff0c877
23 changed files with 11 additions and 23 deletions

View File

@ -37,11 +37,16 @@ parameter on launch:
$> wtf --config=path/to/custom/config.yml
```
#### Configuration Attributes
A number of top-level attributes can be set to customize your WTF
install. See <a href="/posts/configuration/attributes/">Attributes</a> for detials.
## Environment (ENV) Variables
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.
wouldn't want to have laying about in the config files.
For modules that require them, the name of the required environment
variable(s) can be found in that module's "Required ENV Variables"

View File

@ -15,7 +15,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -58,7 +58,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -57,7 +57,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>
@ -137,6 +136,11 @@ start-up.</p>
<code>~/.wtf/config.yml</code>), pass in the path to configuration file as a
parameter on launch:</p>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash"> $&gt; wtf --config<span class="o">=</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 detials.</p>
<h2 id="environment-env-variables">Environment (ENV) Variables</h2>
<p>Some modules require the presence of environment variables to function

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -58,7 +58,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -56,7 +56,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>

View File

@ -58,7 +58,6 @@
<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>
<li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
<li class="sidebar-list-item-2"><a href="/posts/configuration/envvars/">Environment Variables</a></li>
<li class="sidebar-list-item-1"><a href="/posts/howto/" class="disabled">How to Use</a></li>
</ul>