mgoral/twweb repository overview

This repository contains images for TWWeb - TaskWarrior's Web Interface. The source code is available at https://gitlab.com/mgoral/twweb⁠.

You can run it like this:

# docker run -p 5456:5456 mgoral/twweb 

After that you should be able to open TWWeb in your browser on address localhost:5456. Image preserves all data and configuration inside /data directory, so it's preferable to mount it as a volume:

# docker run -v data:/data -p 5456:5456 mgoral/twweb

Docker image will pre-populate /data with TWWeb's settings as long as configuration file is not found. Other settings (uwsgi configuration and taskrc) won't be pre-populated when /data is mounted as a host directory.

You can change settings before the first run with the following environment variables (listed together with their default values):

• TWWEB_SETTINGS [/data/twweb.cfg]: path to TWWeb's configuration file.
• TWW_CFG_SECRET [empty]: TWWeb's secret key used for encryption. If this is empty, image will generate a random secret on first run. Leave it empty in most cases.
• TWW_CFG_PIN [twweb]: PIN used for registration of the first user. You probably should change it
• TWW_CFG_DB_ENGINE [sqlite]
• TWW_CFG_DB_HOST [/data/twweb.db]
• TWW_CFG_TW_TASKRC [/data/taskrc]

Example:

# docker run -v data:/data -p 5456:5456 \
               -e TWW_CFG_SECRET=extraSecret1122 \
               -e TWW_CFG_PIN=supersecret \
               twweb

You can also build and run the image via a docker-compose.