Installation

This guide will help you install and set up TaskTrove on your system.

TaskTrove is a powerful, self-hosted task management application designed for individuals and teams who want advanced productivity features without compromising on data ownership.

Pro setup

Installing the Pro edition? Follow the dedicated steps in Pro Setup.

Installation Methods

Option 1: Docker

The fastest way to get TaskTrove running:

Pro User!

Use the same command but replace the image with ghcr.io/dohsimpson/tasktrove-pro.

docker run -p 3000:3000 -v ./data:/app/data -d --restart=always --name tasktrove ghcr.io/dohsimpson/tasktrove

That's it! TaskTrove will be running on port 3000.

Option 2: Docker Compose

Pro User!

Pass additional arguments -f docker-compose-pro.yml to docker-compose up command below. Make sure to update the AUTH_SECRET value in docker-compose-pro.yml (see instruction in the Authentication section).

For a more permanent setup:

# Download the setup files
git clone https://github.com/dohsimpson/TaskTrove
cd TaskTrove/selfhost

# Start TaskTrove
docker-compose up -d

TaskTrove will be running on port 3000.

Accessing TaskTrove

Once installed, open your web browser and navigate to:

http://localhost:3000

First Time Setup

When accessing TaskTrove after a fresh install, you will be prompted to set up the data files. This initial setup process creates the necessary directories and configuration files for your task management system.

Authentication

Pro User!

Use the same command but replace the image with ghcr.io/dohsimpson/tasktrove-pro.

By default, TaskTrove requires no login. If you want to add password protection, you need to set the AUTH_SECRET environment variable.

# Docker
docker run -p 3000:3000 -v ./data:/app/data \
  -e AUTH_SECRET="random-long-encryption-key" \
  -d --restart=always --name tasktrove \
  ghcr.io/dohsimpson/tasktrove

Pro User!

Use docker-compose-pro.yml instead of docker-compose.yml.

Or in docker-compose.yml, uncomment the AUTH_SECRET environment variable.

To generate a random encryption key, you can use openssl rand -hex 32 or visit https://generate-secret.vercel.app/32.

With AUTH_SECRET set, you'll be prompted to create an account on first visit and log in on subsequent visits. Without it, the app works immediately with no login screen.

Next Steps

Now that TaskTrove is installed, you can start creating tasks and organizing your projects. Check out the User Guide to learn about key features and workflows.