Posts

Connects to the New Relic API and displays the last n deploys of the monitored application: deploy ID, deploy time, and who deployed it. Source Code wtf/newrelic/ Keyboard Commands None. Configuration newrelic: apiKey: "3276d7155dd9ee27b8b14f8743a408a9" applicationId: 10549735 deployCount: 6 enabled: true position: top: 4 left: 3 height: 1 width: 2 refreshInterval: 900 Attributes apiKey Value: Your New Relic API token. applicationId The integer ID of the New Relic application you wish to report on. »

Connects to the OpsGenie API and displays all your scheduled rotations and who’s currently on call. Source Code wtf/opsgenie/ Keyboard Commands None. Configuration opsgenie: apiKey: "3276d7155dd9ee27b8b14f8743a408a9" displayEmpty: false enabled: true position: top: 2 left: 1 height: 2 width: 1 refreshInterval: 21600 Attributes apiKey < br /> Value: Your OpsGenie API token. displayEmpty Whether schedules with no assigned person on-call should be displayed. Values: true, false. enabled Whether or not this module is executed and if its data displayed onscreen. »

Displays some general information about the state of the machine’s wifi connection, firewall, DNS settings, and logged-in users. Wifi Network The name of the current network Whether or not the network uses encryption and if so, what flavour Firewall Whether or not the firewall is enabled Whether or not Stealth Mode is enabled DNS Which DNS resolvers (servers) the machine is configured to use Users Which users are logged into the machine. »

Connects to the BambooHR API and displays who will be Away today. Source Code wtf/bamboohr/ Keyboard Commands None. Configuration bamboohr: apiKey: "3276d7155dd9ee27b8b14f8743a408a9" enabled: true position: top: 0 left: 1 height: 2 width: 1 refreshInterval: 900 subdomain: "testco" Attributes apiKey Value: Your BambooHR API token. enabled Whether or not this module is executed and if its data displayed onscreen. Values: true, false. position Defines where in the grid this module’s widget will be displayed. »

Displays a configurable list of world clocks, the local time, and date. Source Code wtf/clocks/ Required ENV Variables None. Keyboard Commands None. Configuration clocks: colors: rows: even: "lightblue" odd: "white" enabled: true locations: # From https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Avignon: "Europe/Paris" Barcelona: "Europe/Madrid" Dubai: "Asia/Dubai" New York: "America/New York" Toronto: "America/Toronto" UTC: "Etc/UTC" Vancouver: "America/Vancouver" position: top: 4 left: 0 height: 1 width: 1 refreshInterval: 15 # Valid options are: alphabetical, chronological sort: "alphabetical" Attributes colors. »

The heart of WTF is the modules. A module is a discreet unit of functionality that extracts data from some source and packages that data for display. For example, the New Relic module uses New Relic’s API to retrieve a list of the latest deploys and packages that information as a list for display in the “New Relic” widget. The Clocks module takes a list of timezones and packages that information as a list of city/time pairs for display in the “Clocks” widget. »

Module A discreet unit of data collection and display. A data interface concept. A package inside the app. Examples: New Relic, Git, Weather. Widget The onscreen representation of a Module. The widget is responsible for being the interface between the app and the data collection. Widgets are defined by a required widget.go file in a Module. »

Index Configuration Files Environment (ENV) Variables Grid Layout Configuration Files By default WTF looks in a ~/.config/wtf/ directory for a YAML file called config.yml. If the ~/.config/wtf/ directory doesn’t exist, WTF will create that directory on start-up, and then display instructions for creating a new configuration file. In other words, WTF expects to have a YAML config file at: ~/.config/wtf/config.yml. Example Configuration Files A couple of example config files are provided in the _sample_configs/ directory of the Git repository. »