Posts on WTF http://wtfutil.com/posts/ Recent content in Posts on WTF Hugo -- gohugo.io en-us Mon, 07 May 2018 20:17:37 -0700 Bamboohr http://wtfutil.com/posts/modules/bamboohr/ Mon, 07 May 2018 20:17:37 -0700 http://wtfutil.com/posts/modules/bamboohr/ Description Connects to the BambooHR API and displays who will be Away today. Location wtf/bamboohr Required ENV Variables WTF_BAMBOO_HR_TOKEN Your BambooHR API token. WTF_BAMBOO_HR_SUBDOMAIN Your BambooHR API subdomain name. Keyboard Commands None. Configuration bamboohr: enabled: true position: top: 0 left: 1 height: 2 width: 1 refreshInterval: 900 Definitions enabled Whether or not this module is executed and its data displayed onscreen. Values: true, false. position Defines where in the grid this module’s widget will be displayed. Clocks http://wtfutil.com/posts/modules/clocks/ Mon, 07 May 2018 19:47:31 -0700 http://wtfutil.com/posts/modules/clocks/ Description Displays a configurable list of world clocks, the local time, and date. Location 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" UTC: "Etc/UTC" Vancouver: "America/Vancouver" Toronto: "America/Toronto" position: top: 4 left: 0 height: 1 width: 1 refreshInterval: 15 # Valid options are: alphabetical, chronological sort: "alphabetical" Definitions colors. Modules http://wtfutil.com/posts/modules/ Mon, 07 May 2018 18:04:58 -0700 http://wtfutil.com/posts/modules/ 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. Glossary http://wtfutil.com/posts/glossary/ Tue, 17 Apr 2018 12:34:51 -0700 http://wtfutil.com/posts/glossary/ 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. Configuration http://wtfutil.com/posts/configuration/ Sun, 15 Apr 2018 21:17:16 -0700 http://wtfutil.com/posts/configuration/ By default WTF looks in a ~/.wtf/ directory for a YAML file called config.yml. If the ~/.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: ~/.wtf/config.yml. Example Configuration Files A couple of example config files are provided in the _sample_configs/ directory of the Git repository.