Upgrade an existing installation

When upgrading Timesketch you might need to migrate the database to use the latest database schema. This will be made clear within any release notifications.

If a databse migration is required, then the following guide is how you do so:

Backup you database (!)

First you should backup your current database in case something goes wrong in the upgrade process. For PostgreSQL you do the following (Ref: https://www.postgresql.org/docs/9.1/static/backup.html):

general postgres

$ sudo -u postgres pg_dump timesketch > ~/timesketch-db.sql
$ sudo -u postgres pg_dumpall > ~/timesketch-db-all.sql

docker postgres

$ sudo docker exec -t postgres pg_dump -U timesketch timesketch > ~/timesketch-db.sql
$ sudo docker exec -t postgres pg_dumpall -U timesketch > ~/timesketch-db-all.sql

Change to your Timesketch installation directory

(e.g. /opt/timesketch)

$ cd /<PATH TO TIMESKETCH INSTALLATION>

Upgrade the database schema

Have you backed up your database..? good. Let's upgrade the schema. First connect to the timesketch-web container:

$ docker compose exec timesketch-web /bin/bash

While connected to the container:

root@<CONTAINER_ID>$ git clone https://github.com/google/timesketch.git
root@<CONTAINER_ID>$ cd timesketch/timesketch
root@<CONTAINER_ID>$ tsctl db current

If this command returns a value, then you can go ahead and upgrade the database.

In case you don't get any response back from the db current command you'll need to first find out revisions and fix a spot to upgrade from.

root@<CONTAINER_ID>$ tsctl db history

Find the last revision number you have upgraded the database too, and then issue

root@<CONTAINER_ID>$ tsctl db stamp <REVISION_ID>

And now you are ready to upgrade.

root@<CONTAINER_ID>$ tsctl db upgrade

Upgrade timesketch

If upgrading the database then exit from the container (CTRL-D). The current version of timesketch is defined within the config.env file located within the parent directory of the timesketch installation. Simply amend the TIMESKETCH_VERSION= to the one required and upgrading to.

In order to pull new versions of the docker images and upgrade Timesketch:

$ docker compose --env-file /opt/timesketch/config.env -f /opt/timesketch/docker-compose.yml pull
$ docker compose --env-file /opt/timesketch/config.env -f /opt/timesketch/docker-compose.yml down
$ docker compose --env-file /opt/timesketch/config.env -f /opt/timesketch/docker-compose.yml up -d