2015-10-31 12:06:16 +00:00
|
|
|
# Taskwarrior Server (taskd) Docker
|
|
|
|
|
|
2016-07-06 12:25:07 +00:00
|
|
|
(c) 2015-2016 Óscar García Amor
|
2015-10-31 12:06:16 +00:00
|
|
|
Redistribution, modifications and pull requests are welcomed under the terms
|
|
|
|
|
of MIT license.
|
|
|
|
|
|
|
|
|
|
[Taskwarrior](https://www.taskwarrior.org) is Free and Open Source Software
|
|
|
|
|
that manages your TODO list from your command line. It is flexible, fast,
|
|
|
|
|
efficient, and unobtrusive. It does its job then gets out of your way.
|
|
|
|
|
|
|
|
|
|
This docker packages **taskd**, Taskwarrior sync server, under [Alpine
|
|
|
|
|
Linux](https://alpinelinux.org/), a lightweight Linux distribution.
|
|
|
|
|
|
2015-10-31 12:18:01 +00:00
|
|
|
Visit [Docker Hub](https://hub.docker.com/r/ogarcia/taskd/) to see all
|
|
|
|
|
available tags.
|
|
|
|
|
|
2015-10-31 12:06:16 +00:00
|
|
|
## Run
|
|
|
|
|
|
|
|
|
|
To run this container exposing taskd default port and making the data volume
|
|
|
|
|
permanent in `/srv/taskd`, simply run.
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
docker run -d \
|
|
|
|
|
--name=taskd \
|
|
|
|
|
-p 53589:53589 \
|
|
|
|
|
-v /srv/taskd:/var/taskd \
|
|
|
|
|
ogarcia/taskd
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This makes a set of self signed certificates and minimal configuration to
|
|
|
|
|
run server.
|
|
|
|
|
|
|
|
|
|
## Manual setup
|
|
|
|
|
|
|
|
|
|
The `run.sh` script that launch **taskd** server always look for config file
|
|
|
|
|
in data volume `/var/taskd`. If found it, simply run the server, but if
|
|
|
|
|
config file is absent `run.sh` will build a new default config and its
|
|
|
|
|
certificates.
|
|
|
|
|
|
|
|
|
|
If you make the data volume permanent you'll can access to its contents and
|
|
|
|
|
make modifications that you need. The significant files are.
|
|
|
|
|
|
|
|
|
|
* `config` taskd config itself.
|
|
|
|
|
* `log` directory of log.
|
|
|
|
|
* `org` taskd data.
|
|
|
|
|
* `pki` directory that contains certs and certs generation helpers.
|
|
|
|
|
|
|
|
|
|
You can do any changes to this, but remember that if you delete `config`
|
|
|
|
|
file, the `run.sh` script will rebuild everything.
|
|
|
|
|
|
|
|
|
|
Please refer to [Taskwarrior Docs](https://taskwarrior.org/docs/) to know
|
|
|
|
|
how do modifications, add users, etc.
|
|
|
|
|
|
|
|
|
|
## Shell run
|
|
|
|
|
|
|
|
|
|
In some cases, you could need to run `taskd` command. You can run this
|
|
|
|
|
docker in interactive mode, simply do.
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
docker run -ti --rm \
|
|
|
|
|
-v /srv/taskd:/var/taskd \
|
|
|
|
|
ogarcia/taskd /bin/sh
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This mounts the permanent data volume `/srv/taskd` into **taskd** data
|
|
|
|
|
directory and gives you a interactive shell to work.
|
|
|
|
|
|
|
|
|
|
Please note that the `--rm` modifier destroy the docker after shell exit.
|
