Documentation

- Added references to new configuration settings.
This commit is contained in:
Paul Beckingham 2013-10-29 22:43:55 -04:00
parent 6c985b76c3
commit 6e0603234e
3 changed files with 31 additions and 5 deletions

4
NEWS
View file

@ -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.

View file

@ -29,15 +29,17 @@ need the following items:
<server:port> Where Task Server is running (Default: localhost:6544)
<org> Name of organization (default: Public)
<user> User name added to server
<key> Key UUID generated by server
<password> UUID generated by server
<cert> Full path to client.cert.pem generated by server
<key> Full path to client.key.pem generated by server
Set these configuration variables in your Taskwarrior configuration,
substituting from above:
$ task config taskd.server <server:port>
$ task config taskd.credentials <org>/<user>/<key>
$ task config taskd.credentials <org>/<user>/<password>
$ task config taskd.certificate <cert>
$ task config taskd.key <key>
Here is an example:

View file

@ -1354,8 +1354,30 @@ User identification for the task server, which includes a private key.
.TP
.B taskd.certificate=<path>
.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=<path>
.RS
Specifies the path to the client key used for encrypted communication with the
task server.
.RE
.TP
.B taskd.ca=<path>
.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"