twweb 0.6.1

Screenshots

Quick test

You can quickly check if TWWeb suits your needs by running a development server locally on your computer.

$ tox -e dev

After running this command TWWeb will be accessible on localhost:5000. You can change the port on which development server listens this way:

$ tox -e dev -- --port=3333

Installation with Docker

TWWeb provides a Docker image. You can quickly build a container and run an image like that:

# docker build . -t twweb
# docker run -p 5456:5456 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 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.

Manual Installation

To install TWWeb you’ll need a web server able to run Python applications. You’ll also need a database, but sqlite should be fine as TWWeb doesn’t store a lot. Obviously you’ll also need a working Taskwarrior.

We’ll install all required components inside a virtualenv. Before you start, you should select and create a directory in which TWWeb will be placed. For now we’ll assume /var/www/example.com/twweb, where “example.com” part is typically replaced with a name of your domain.

$ sudo mkdir -p /var/www/example.com/twweb
$ sudo chown $USER:www-data /var/www/example.com/twweb
$ chmod 775 /var/www/example.com/twweb
$ cd /var/www/example.com/twweb

Above commands create and set appropriate permissions for TWWeb’s directory. When following this installation method, TWWeb itself will need write permissions in this directory so that’s why we change the group permission to rwx.

$ sudo apt install task

$ mkdir -m 775 task && chown $USER:www-data task
$ echo "data.location=`pwd`/task" > taskrc

$ virtualenv -p python3 venv
$ venv/bin/pip install twweb uwsgi
$ inst=`find venv -name twweb -type d`

SECRET_KEY = 'this should be secret and complex'
PIN = 'additional password used for first register'

DB_ENGINE = 'sqlite'
DB_HOST = '/var/www/example.com/twweb/twweb.db'

TW_TASKRC = '/var/www/example.com/twweb/taskrc'

$ export TWWEB_SETTINGS=`pwd`/twweb.cfg

location /update {
  include uwsgi_params;
  uwsgi_pass unix:/run/uwsgi/twweb.socket
}