From 2c4c220ea7a9a75260d4e30e447768c13a8474af Mon Sep 17 00:00:00 2001 From: Chris Cummer Date: Sun, 15 Apr 2018 21:50:00 -0700 Subject: [PATCH] Minimal Configuration documentation --- _site/content/posts/configuration.md | 31 +++++- docs/.DS_Store | Bin 6148 -> 6148 bytes docs/404.html | 4 +- docs/categories/index.html | 4 +- docs/img/screenshot.png | Bin 0 -> 522842 bytes docs/img/screenshot_sm.png | Bin 0 -> 194317 bytes docs/index.html | 47 ++++++++- docs/index.xml | 11 +++ docs/posts/configuration/index.html | 141 +++++++++++++++++++++++++++ docs/posts/index.html | 101 +++++++++++++++++++ docs/posts/index.xml | 25 +++++ docs/sitemap.xml | 12 +++ docs/tags/index.html | 4 +- 13 files changed, 370 insertions(+), 10 deletions(-) create mode 100644 docs/img/screenshot.png create mode 100644 docs/img/screenshot_sm.png create mode 100644 docs/posts/configuration/index.html create mode 100644 docs/posts/index.html create mode 100644 docs/posts/index.xml diff --git a/_site/content/posts/configuration.md b/_site/content/posts/configuration.md index 5f52bac3..b98573ed 100644 --- a/_site/content/posts/configuration.md +++ b/_site/content/posts/configuration.md @@ -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. diff --git a/docs/.DS_Store b/docs/.DS_Store index 31b7cdb6c9ee96087bdfa8c24be8c73710efdfcf..940e942902c4c95c53cc11d73aa9ce43019c31f2 100644 GIT binary patch delta 82 zcmZoMXfc=|#>AjHu~3+iaq??MX+b6i2w((KKrFzp`8%Tk+hzf#`HY*{Iruq%iZ?Sd aeP^D`FQUi^Qj`EvKiPywd2@`&3T6OrBo5~Q delta 322 zcmZoMXfc=|#>B`mu~3YagMono$Pkfb0y01VL^Col2rv{EB<18M0eL5r3MLjVuLnsm zGh{O4GNdP!BTMFF7MB6A-A%sx~8^nCeZyrzzFml z81O@B7&U96j`YTKMz+ZYA}pJ^ft~<{(8j{=%#-;=6j?!@SD0)lBD~o{WDhd{ diff --git a/docs/categories/index.html b/docs/categories/index.html index bccca7cc..ba306f7e 100644 --- a/docs/categories/index.html +++ b/docs/categories/index.html @@ -41,9 +41,9 @@