A Chef cookbook to manage taskwarrior and friends.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
attributes
recipes
templates/default
test
.gitignore
.kitchen.yml
Berksfile
CHANGELOG.md
Gemfile
LICENSE
README.md
Rakefile
metadata.rb

README.md

taskwarrior Cookbook

Installs and configures taskwarrior client and server software.

Requirements

All the requirements are installed for you if you use Berkshelf. Altough it is good practice to add the following to the role run list.

cookbooks

  • apt - To install the lastest packages.
  • git - To clone the code both for client and server source installs.
  • cmake - Build dependency for task and taskserver.
  • build-essential - Build dependency for task and taskserver.
  • perl - Build dependency for taskserver.
  • python - Build dependency for taskserver.
  • runit - To manage the taskserver daemon.

Plaforms

  • Ubuntu
  • Debian

Attributes

taskwarrior::default

Key Type Description Default
['taskwarrior']['method'] String Choose to install from the repository of from the lastest on the git repository package
["taskwarrior"]["source"]["git_repository"] String The git repository to clone taskwarrior from. git://tasktools.org/task.git
["taskwarrior"]["source"]["git_revision"] String The git revision to build from, HEAD is lastest HEAD

taskwarrior::server

Key Type Description Default
["taskwarrior"]["server"]["git_repository"] String The git repository to clone taskserver from. git://tasktools.org/taskd.git
["taskwarrior"]["server"]["git_revision"] String The git revision to build from, HEAD is lastest HEAD
["taskwarrior"]["server"]["home"] String The main directory for taskd /var/lib/taskd
["taskwarrior"]["server"]["data_dir"] String Taskd data directory default["taskwarrior"]["server"]["home"]}/data
["taskwarrior"]["server"]["keys_dir"] String Fully qualified path for the keys default["taskwarrior"]["server"]["home"]}/keys
["taskwarrior"]["server"]["confirmation"] String Determines whether certain commands are confirmed on
["taskwarrior"]["server"]["extensions"] String Fully qualified path of the taskd extension scripts. Currently there are none.
["taskwarrior"]["server"]["ip_log"] String Logs the IP addresses of incoming requests. on
["taskwarrior"]["server"]["log_dir"] String Log directory for taskd. /var/log/taskd
["taskwarrior"]["server"]["log_file"] String Main log file. default["taskwarrior"]["server"]["log_dir"]}/keys
["taskwarrior"]["server"]["queue_size"] Integer Size of the connection backlog. 10
["taskwarrior"]["server"]["request_limit"] Integer Size limit of incoming requests, in bytes. 1048576
["taskwarrior"]["server"]["link"] String The address of the taskd server followed by a colon and the por number. localhost:6544
["taskwarrior"]["server"]["organization"] String The name of your organization to generate the certificates. Empty
["taskwarrior"]["server"]["clients"] String Regex string to allow client to connect to the server. Check the taskd log for more examples. ^task [2-9]

Usage

taskwarrior::default

Installs the taskwarrior client that can work standalone, just add it to your run_list. You can choose to install from the repositories, or to build from source. Just set the ["taskwarrior"]["install_method"] to "source", like so.

{
  "name":"my_node",
  "run_list": [
    "recipe[taskwarrior]"
  ]
  "override_attrubutes": {
    "taskwarrior": {
      "install_method": "source"
    }
  }
}

taskwarrior::server

Builds and installs the taskwarrior service daemon (taskd) and sets up supervising with runit. Check the taskwarrior wiki pages for operation, setup amd ciphers

Add the following to you users data bag.

{
  "id": "bob",
  "taskwarrior": {
    "organization": "Public",
    "groups": ["groupA", "groupB"]
  }
}

This will generate client keys and the taskd user and its Uuid for bob. The key distrubution at the moment is done by hand so you need to get them from the key directory.

Contributing

The testing is done mostly with test-kitchen before everything, set it up. Also foodcritic is used for linting.

  • Fork the repository on Github
  • Create a named feature branch (like add_component_x)
  • Write your change
  • Make it pass foodcritic.
  • Write tests for your change (if applicable)
  • Run the tests, ensuring they all pass
  • Submit a Pull Request using Github

License and Authors

Authors: