From 6e0603234e7b8e26efe21ee65d5e09c27db85abc Mon Sep 17 00:00:00 2001 From: Paul Beckingham Date: Tue, 29 Oct 2013 22:43:55 -0400 Subject: [PATCH] Documentation - Added references to new configuration settings. --- NEWS | 4 +++- README_TASKD | 6 ++++-- doc/man/taskrc.5.in | 26 ++++++++++++++++++++++++-- 3 files changed, 31 insertions(+), 5 deletions(-) diff --git a/NEWS b/NEWS index c0cc09b3a..c0caa0b0c 100644 --- a/NEWS +++ b/NEWS @@ -23,7 +23,9 @@ New configuration options in taskwarrior 2.3.0 - 'taskd.server' specifies host:port of the task server. - 'taskd.credentials' specifies user credentials for the task server. - - 'taskd.certificate' specifies the task server certificate. + - 'taskd.certificate' specifies the task server certificate for authentication. + - 'taskd.key' specifies the task server key for encryption. + - 'taskd.trust' overrides certificate checking. - 'debug.tls' shows TLS log information, for debugging. - The configuration file supports JSON encoding of unicode characters \uNNNN. diff --git a/README_TASKD b/README_TASKD index be32a4cb2..74432a2ca 100644 --- a/README_TASKD +++ b/README_TASKD @@ -29,15 +29,17 @@ need the following items: Where Task Server is running (Default: localhost:6544) Name of organization (default: Public) User name added to server - Key UUID generated by server + UUID generated by server Full path to client.cert.pem generated by server + Full path to client.key.pem generated by server Set these configuration variables in your Taskwarrior configuration, substituting from above: $ task config taskd.server - $ task config taskd.credentials // + $ task config taskd.credentials // $ task config taskd.certificate + $ task config taskd.key Here is an example: diff --git a/doc/man/taskrc.5.in b/doc/man/taskrc.5.in index 749fa411e..ba915fa97 100644 --- a/doc/man/taskrc.5.in +++ b/doc/man/taskrc.5.in @@ -1354,8 +1354,30 @@ User identification for the task server, which includes a private key. .TP .B taskd.certificate= .RS -Specifies the path to the client certificate used for encrypted communication -with the task server. +Specifies the path to the client certificate used for identification with the +task server. +.RE + +.TP +.B taskd.key= +.RS +Specifies the path to the client key used for encrypted communication with the +task server. +.RE + +.TP +.B taskd.ca= +.RS +Specifies the path to the CA certificate in the event that your task server is +using a self-signed certificate. Optional. +.RE + +.TP +.B taskd.trust=yes|no +.RS +If you do not specify a CA certificate when your task server is usㄟng a self- +signed certificate, you can override the certificate validation by setting this +value to 'yes'. Default is not to trust a server certificate. .RE .SH "CREDITS & COPYRIGHTS"