mirror of
https://github.com/Gimanh/taskview-community.git
synced 2026-09-11 13:29:17 +00:00
Gimanh
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: TaskView Documentation
|
||||
description: Official documentation for TaskView - a source-available, self-hosted project and task management platform. Installation guides, feature docs, configuration reference, and more.
|
||||
navigation: false
|
||||
---
|
||||
|
||||
Welcome to the TaskView documentation. TaskView is a self-hosted task management platform for teams and individuals who want full control over their data and workflows.
|
||||
|
||||
## Getting started
|
||||
|
||||
::card-group
|
||||
::card{title="What is TaskView" icon="i-lucide-info" to="/docs/getting-started"}
|
||||
Learn what TaskView is, who it's for, and what features it offers.
|
||||
::
|
||||
::card{title="Installation" icon="i-lucide-download" to="/docs/getting-started/installation"}
|
||||
Deploy TaskView with Docker Compose in 5 minutes.
|
||||
::
|
||||
::card{title="Quick Start" icon="i-lucide-rocket" to="/docs/getting-started/usage"}
|
||||
Create your first project, add lists, and start managing tasks.
|
||||
::
|
||||
::
|
||||
|
||||
## Explore
|
||||
|
||||
::card-group
|
||||
::card{title="Features" icon="i-lucide-layout-grid" to="/docs/features/projects-and-lists"}
|
||||
Projects, tasks, Kanban boards, dependency graphs, and dashboard.
|
||||
::
|
||||
::card{title="Integrations" icon="i-lucide-git-pull-request" to="/docs/integrations/setup"}
|
||||
Connect GitHub and GitLab repositories to sync issues as tasks.
|
||||
::
|
||||
::card{title="Configuration" icon="i-lucide-settings" to="/docs/configuration/environment-variables"}
|
||||
Environment variables, authentication, and server setup.
|
||||
::
|
||||
::card{title="Collaboration" icon="i-lucide-users" to="/docs/collaboration/members"}
|
||||
Team members, roles, and 28 granular permissions.
|
||||
::
|
||||
::card{title="FAQ" icon="i-lucide-circle-help" to="/docs/faq"}
|
||||
Common questions about installation, features, and security.
|
||||
::
|
||||
::card{title="Guides" icon="i-lucide-book-open" to="/docs/guides/deploy-vps-nginx"}
|
||||
Step-by-step guides for production deployment and use cases.
|
||||
::
|
||||
::
|
||||
@@ -0,0 +1,2 @@
|
||||
title: Getting Started
|
||||
icon: false
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: What is TaskView
|
||||
description: TaskView is an open-source, self-hosted project and task management platform. Features Kanban boards, dependency graphs, team collaboration, RBAC, GitHub/GitLab sync, and full data ownership. Free alternative to other PM for teams who need privacy and control.
|
||||
navigation:
|
||||
icon: i-lucide-house
|
||||
---
|
||||
|
||||
TaskView is a self-hosted task management platform for teams and individuals who want full control over their data and workflows.
|
||||
|
||||
You deploy it on your own server (or run it locally), and everything - tasks, projects, files, user data - stays on your infrastructure. There are no third-party clouds involved, no subscriptions, and no vendor lock-in.
|
||||
|
||||
## Who is it for
|
||||
|
||||
- **Teams with security requirements** - companies that can't send project data to external SaaS platforms
|
||||
- **Self-hosters** - people who prefer running their own tools, like Gitea instead of GitHub or Mattermost instead of Slack
|
||||
- **Small teams and startups** - anyone who wants a capable project manager without paying per seat
|
||||
|
||||
## What you get
|
||||
|
||||
- **Projects and lists** - organize work into projects, each with its own lists, tags, statuses, and team members
|
||||
- **Tasks and subtasks** - create tasks with priorities, deadlines, notes
|
||||
- **Kanban boards** - drag-and-drop tasks with custom statuses per project
|
||||
- **Dependency graphs** - link tasks and visualize dependencies on an interactive graph
|
||||
- **Team collaboration** - invite members, assign roles with granular permissions, control who sees what
|
||||
- **GitHub and GitLab sync** - connect repositories and import issues as tasks, kept in sync via webhooks
|
||||
- **Financial tracking** - attach income and expense amounts to tasks for basic budget tracking
|
||||
- **Task history** - full audit trail with the ability to restore deleted or changed tasks (only props in tasks, not other entities)
|
||||
- **Mobile apps** - Android and iOS apps that sync with your server
|
||||
- **Dashboard** - widgets for today's tasks, upcoming deadlines, recent activity, and completed work
|
||||
|
||||
## Tech stack
|
||||
|
||||
TaskView is a monorepo with three main parts:
|
||||
|
||||
| Component | Technology |
|
||||
|-----------|------------|
|
||||
| API server | Node.js, Express, Drizzle ORM, SQL, TypeScript |
|
||||
| Web app | Vue 3, Nuxt UI, TailwindCSS, Pinia, TypeScript |
|
||||
| Database | PostgreSQL 17 |
|
||||
| Mobile | Capacitor 8 (iOS & Android) |
|
||||
|
||||
Everything runs in Docker containers, so deployment is straightforward regardless of your server setup.
|
||||
|
||||
## What's next
|
||||
|
||||
Head to the [Installation](/docs/getting-started/installation) page to get TaskView running on your machine in a few minutes.
|
||||
@@ -0,0 +1,221 @@
|
||||
---
|
||||
title: Installation
|
||||
description: Install and deploy TaskView using Docker Compose. Step-by-step setup guide for a self-hosted task management server with PostgreSQL, Node.js API, and Vue web app. Deploy on any server in 5 minutes.
|
||||
navigation:
|
||||
icon: i-lucide-download
|
||||
---
|
||||
|
||||
TaskView runs as a set of Docker containers - a database, an API server, a web app, and a one-time migration runner. The whole setup takes about 5 minutes.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A server or local machine with [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed
|
||||
- Ports `8888` (web) and `1725` (API) available - you can change these in the compose file
|
||||
|
||||
## Step 1: Create a project directory
|
||||
|
||||
```bash
|
||||
mkdir taskview && cd taskview
|
||||
```
|
||||
|
||||
## Step 2: Create environment files
|
||||
|
||||
You need two env files - one for PostgreSQL, one for the TaskView API.
|
||||
|
||||
**`.env.postgresql`** - database credentials:
|
||||
|
||||
```env
|
||||
POSTGRES_USER=taskview_db_user
|
||||
POSTGRES_PASSWORD=your_secure_password
|
||||
POSTGRES_DB=taskviewdb
|
||||
```
|
||||
|
||||
**`.env.taskview`** - application config (**example, do not forget add your data**):
|
||||
|
||||
```env
|
||||
DB_HOST="db"
|
||||
DB_USER="taskview_db_user"
|
||||
DB_PASSWORD="your_secure_password"
|
||||
DB_NAME="taskviewdb"
|
||||
DB_PORT=5432
|
||||
APP_PORT=1401
|
||||
JWT_ALG="HS256"
|
||||
JWT_SIGN="secret"
|
||||
ACCESS_LIFE_TIME="3d"
|
||||
REFRESH_LIFE_TIME="9d"
|
||||
|
||||
SMTP_HOST=smtp
|
||||
SMTP_PORT=587
|
||||
SMTP_USERNAME=
|
||||
SMTP_PASSWORD=
|
||||
SMTP_ENCRYPTION=tls
|
||||
SMTP_FROM_NAME=TaskView
|
||||
SMTP_FROM_EMAIL=
|
||||
|
||||
# Your domain
|
||||
APP_URL="https://app.taskview.tech"
|
||||
|
||||
GOOGLE_CLIENT_ID=""
|
||||
GOOGLE_CLIENT_SECRET=""
|
||||
#You domain
|
||||
GOOGLE_CALLBACK_URL="https://api.taskview.tech/module/auth/provider/google/callback"
|
||||
GITHUB_CLIENT_ID=""
|
||||
GITHUB_CLIENT_SECRET=""
|
||||
GITHUB_CALLBACK_URL="https://api.taskview.tech/module/auth/provider/github/callback"
|
||||
APPLE_CLIENT_ID=""
|
||||
APPLE_TEAM_ID=""
|
||||
APPLE_KEY_ID=""
|
||||
APPLE_KEY_LOCATION="/usr/src/app/AuthKey.p8"
|
||||
# Your domain
|
||||
APPLE_CALLBACK_URL="https://api.taskview.tech/module/auth/provider/apple/callback"
|
||||
|
||||
#integrations
|
||||
GITHUB_INTEGRATION_CLIENT_ID=
|
||||
GITHUB_INTEGRATION_CLIENT_SECRET=
|
||||
GITHUB_INTEGRATION_CALLBACK_URL=https://api.taskview.tech/module/integrations/oauth/github/callback
|
||||
|
||||
GITLAB_INTEGRATION_CLIENT_ID=
|
||||
GITLAB_INTEGRATION_CLIENT_SECRET=
|
||||
GITLAB_INTEGRATION_CALLBACK_URL=https://api.taskview.tech/module/integrations/oauth/github/callback
|
||||
|
||||
ENCRYPTION_KEY=
|
||||
|
||||
#!!! ADD YOUR DOMAIN SEPARATED BY ","
|
||||
CORS_ALLOWED_ORIGINS="http://localhost:5173,http://127.0.0.1:5173,http://localhost:3000,http://localhost:8888,http://127.0.0.1:3000,http://127.0.0.1:8888"
|
||||
```
|
||||
|
||||
::callout{icon="i-lucide-shield" color="warning"}
|
||||
Replace `your_secure_password` and `JWT_SIGN` with real secrets. Never use the example values in production.
|
||||
::
|
||||
|
||||
## Step 3: Create docker-compose.yml
|
||||
|
||||
```yaml
|
||||
networks:
|
||||
backend:
|
||||
services:
|
||||
db:
|
||||
image: postgres:17
|
||||
restart: unless-stopped
|
||||
env_file:
|
||||
- ./.env.postgresql
|
||||
volumes:
|
||||
- pgdata:/var/lib/postgresql/data
|
||||
ports:
|
||||
- "5433:5432"
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -U taskview_db_user -d taskviewdb"]
|
||||
interval: 5s
|
||||
timeout: 5s
|
||||
retries: 5
|
||||
networks: [backend]
|
||||
migration:
|
||||
image: gimanhead/taskview-ce-db-migration:latest
|
||||
restart: "no"
|
||||
depends_on:
|
||||
db:
|
||||
condition: service_healthy
|
||||
env_file:
|
||||
- ./.env.taskview
|
||||
networks: [backend]
|
||||
|
||||
taskview-api-server:
|
||||
image: gimanhead/taskview-ce-api-server:latest
|
||||
restart: "unless-stopped"
|
||||
sysctls:
|
||||
- net.ipv6.conf.all.disable_ipv6=1
|
||||
- net.ipv6.conf.default.disable_ipv6=1
|
||||
ports:
|
||||
- "1725:1401"
|
||||
depends_on:
|
||||
db:
|
||||
condition: service_healthy
|
||||
migration:
|
||||
condition: service_completed_successfully
|
||||
env_file:
|
||||
- ./.env.taskview
|
||||
volumes:
|
||||
- ./logs:/usr/src/app/logs
|
||||
#- /local/AuthKey.p8:/usr/src/app/AuthKey.p8
|
||||
networks: [backend]
|
||||
|
||||
taskview-webapp:
|
||||
image: gimanhead/taskview-ce-webapp:latest
|
||||
restart: unless-stopped
|
||||
ports:
|
||||
- "8888:80"
|
||||
volumes:
|
||||
pgdata:
|
||||
|
||||
```
|
||||
|
||||
## Step 4: Start everything
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Docker will pull the images, start the database, run migrations, and launch the API and web app.
|
||||
|
||||
## Step 5: Open TaskView
|
||||
|
||||
Go to [http://localhost:8888](http://localhost:8888) in your browser. You'll see the login screen.
|
||||
|
||||
The database migration creates a default user so you can log in right away:
|
||||
|
||||
- **Login:** `user`
|
||||
- **Password:** `user1!#Q`
|
||||
|
||||
Use these credentials to verify that everything is working - check that the UI loads, you can create a project, add tasks, etc.
|
||||
|
||||
::callout{icon="i-lucide-alert-triangle" color="error"}
|
||||
**Important:** The default user is for initial setup only. Once you've confirmed the system works, delete the default user and create your own account with a secure password.
|
||||
::
|
||||
|
||||
### Replacing the default user
|
||||
|
||||
1. Log in with the default credentials
|
||||
2. Register a new account with your real email and a strong password
|
||||
3. Delete the default `admin` account
|
||||
|
||||
If you prefer to create the first user directly in the database, generate a password hash:
|
||||
|
||||
```ts
|
||||
import { hashSync } from 'bcryptjs'
|
||||
|
||||
const passwordHash = hashSync('your-secure-password', 12)
|
||||
console.log(passwordHash)
|
||||
```
|
||||
|
||||
Or as a one-liner:
|
||||
|
||||
```bash
|
||||
node -e "console.log(require('bcryptjs').hashSync('your-secure-password', 12))"
|
||||
```
|
||||
|
||||
Then insert the user into the database with the generated hash.
|
||||
|
||||
## Updating
|
||||
|
||||
To update TaskView to a new version:
|
||||
|
||||
```bash
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
The migration container will automatically apply any new database changes on startup.
|
||||
|
||||
## Production tips
|
||||
|
||||
- **Use a reverse proxy** (Nginx, Caddy, Traefik) to terminate SSL and serve everything over HTTPS
|
||||
- **Update `APP_URL` and `API_URL`** in `.env.taskview` to match your production domain
|
||||
- **Back up the database** - the `pgdata` volume contains all your data
|
||||
- **Set `restart: unless-stopped`** on all services so they survive server reboots
|
||||
- **SMTP setup** - add SMTP variables to `.env.taskview` if you want email features (password recovery, invitations). See [Configuration](/docs/configuration/environment-variables) for details.
|
||||
|
||||
## What's next
|
||||
|
||||
- [Create your first project](/docs/features/projects-and-lists) - set up a project with lists and tasks
|
||||
- [Invite your team](/docs/collaboration/members) - add members and assign roles
|
||||
- [Connect GitHub or GitLab](/docs/integrations/setup) - sync issues as tasks
|
||||
@@ -0,0 +1,81 @@
|
||||
---
|
||||
title: Quick Start
|
||||
description: Get started with TaskView in 5 minutes - create projects, add task lists, organize work with Kanban boards and dependency graphs. Quick start guide for self-hosted project and task management.
|
||||
navigation:
|
||||
icon: i-lucide-rocket
|
||||
---
|
||||
|
||||
You've installed TaskView and created an account. Here's how to get productive in 5 minutes.
|
||||
|
||||
## Create a project
|
||||
|
||||
|
||||
|
||||
Click the **+** button in the sidebar to create your first project. Give it a name, and you're done.
|
||||
|
||||
A project is a top-level container for all your work - it has its own lists, tags, statuses, team members, and permissions.
|
||||
|
||||
## Add lists
|
||||
|
||||
Inside a project, create lists to organize tasks into groups. Think of lists as folders - "Backend", "Frontend", "Design", "Bugs", whatever makes sense for your workflow.
|
||||
|
||||
Enter list name in the header and press enter. You can ignore lists creation and create tasks in the created project directly.
|
||||
|
||||
## Create tasks
|
||||
|
||||
|
||||
|
||||
Click inside a list and start adding tasks. Each task can have:
|
||||
|
||||
- **Priority** - how urgent it is
|
||||
- **Deadline** - when it's due (with optional time)
|
||||
- **Notes** - rich text description with formatting
|
||||
- **Tags** - color-coded labels for categorization
|
||||
- **Subtasks** - break work into smaller pieces, as deep as you need
|
||||
- **Assignees** - who's responsible (multiple people allowed)
|
||||
- **Financial amount** - attach an income or expense for budget tracking
|
||||
- **Task history** - every change to a task's own properties (title, description, priority, deadline, status, etc.) is tracked and can be restored. Note: changes to tags, assignees, and other related entities are not part of the history - only fields stored directly in the task record.
|
||||
|
||||
## Switch views
|
||||
|
||||
TaskView gives you three ways to look at your work:
|
||||
|
||||
### List view
|
||||
|
||||
|
||||
The default view. Tasks grouped by list, with all details visible. Best for day-to-day task management.
|
||||
|
||||
### Kanban board
|
||||
|
||||
|
||||
Visual columns representing statuses. Drag tasks between columns to update their status. Great for tracking workflow stages like "Backlog → To Do → In Progress → Done".
|
||||
|
||||
You can customize the columns - each project has its own set of statuses.
|
||||
|
||||
### Dependency graph
|
||||
|
||||
|
||||
|
||||
An interactive network graph showing how tasks connect to each other. Link tasks to define dependencies, then zoom out to see the big picture. Useful for planning complex work where order matters.
|
||||
|
||||
## Use the dashboard
|
||||
|
||||
|
||||
The main screen (home page) shows a dashboard with widgets:
|
||||
|
||||
- **Today's tasks** - what's due today
|
||||
- **Upcoming deadlines** - what's coming soon
|
||||
- **Recent activity** - latest changes across all projects
|
||||
- **Completed tasks** - what's been done
|
||||
|
||||
This gives you a quick overview without opening any specific project.
|
||||
|
||||
## Search
|
||||
|
||||
Use the global search (click the search icon or press `Ctrl+K` / `Cmd+K`) to find any task across all your projects. Filter by tags, priorities, statuses, or assignees (available only in the selected project).
|
||||
|
||||
## What's next
|
||||
|
||||
- [Learn about Kanban boards](/docs/features/kanban) - customize columns and workflow
|
||||
- [Set up task dependencies](/docs/features/graph) - link related tasks on the graph
|
||||
- [Invite your team](/docs/collaboration/members) - collaborate with others
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 457 KiB |
@@ -0,0 +1,2 @@
|
||||
title: Features
|
||||
icon: false
|
||||
@@ -0,0 +1,65 @@
|
||||
---
|
||||
title: Projects and Lists
|
||||
description: Organize work with projects, task lists, and color-coded tags in TaskView. Each project has independent members, roles, statuses, permissions, and archiving. Flexible workspace management for teams.
|
||||
navigation:
|
||||
icon: i-lucide-folder
|
||||
---
|
||||
|
||||
Everything in TaskView starts with a project. A project is a workspace that contains lists, tasks, team members, tags, statuses, and permissions - all scoped to that project.
|
||||
|
||||
## Projects
|
||||
|
||||
### Creating a project
|
||||
|
||||
Click the **Enter project name** input in the sidebar. Enter a name, and hit save. That's it - you can start adding lists and tasks right away.
|
||||
|
||||
|
||||
|
||||
### Project settings
|
||||
|
||||
|
||||
Click the **more button** a project in the sidebar to access:
|
||||
|
||||
- **Rename** - change the project name or color
|
||||
- **Archive** - hide the project without deleting it (you can restore it later)
|
||||
- **Delete** - permanently remove the project and all its data
|
||||
- **Integrations** - connect GitHub or GitLab repositories
|
||||
- **Collaboration** - manage team members and permissions
|
||||
|
||||
### Archiving
|
||||
|
||||
If you're done with a project but want to keep the data around, archive it instead of deleting it. Archived projects disappear from the sidebar but can be restored at any time.
|
||||
|
||||
## Lists
|
||||
|
||||
Lists live inside projects. They're a way to group related tasks - by feature, by team, by phase, or however you prefer.
|
||||
|
||||
### Creating a list
|
||||
|
||||
Click the **Enter list name** input in the header. Give the list a name and it appears as a section within the project.
|
||||
|
||||
### Deleting a list
|
||||
|
||||
Click a list **More button** and choose **Delete**. This removes the list and all tasks inside it. There's no undo for this, so make sure you really want to do it.
|
||||
|
||||
## Tags
|
||||
|
||||
Each project has its own set of tags. Tags are color-coded labels you attach to tasks for quick visual identification.
|
||||
|
||||
### Managing tags
|
||||
|
||||
Go to a project and open the task **Detailed form** by clicking to the task and scroll to the tag management panel. You can:
|
||||
|
||||
- Create tags with a name and color
|
||||
- Edit existing tags
|
||||
- Delete tags (they'll be removed from all tasks that use them)
|
||||
|
||||
### Tagging tasks
|
||||
|
||||
Open a task and click the tags area. Select one or more tags from the list. You can filter tasks by tag in the list view.
|
||||
|
||||
## Best practices
|
||||
|
||||
- **One project per real-world project** - don't try to fit everything into a single project. Each project gets its own permissions, tags, and statuses.
|
||||
- **Keep list names short** - "Backend", "Bugs", "Sprint 14" work better than long descriptions.
|
||||
- **Use tags for cross-cutting concerns** - things like "urgent", "blocked", "needs-review" that apply across multiple lists.
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
title: Tasks
|
||||
description: Create and manage tasks in TaskView - subtasks, deadlines, priorities, assignees, tags, rich-text notes, financial tracking, and full change history with restore. Self-hosted task tracking with no limits.
|
||||
navigation:
|
||||
icon: i-lucide-check-square
|
||||
---
|
||||
|
||||
Tasks are the core of TaskView. Every piece of work - a bug to fix, a feature to build, a meeting to prepare - is a task.
|
||||
|
||||
## Creating tasks
|
||||
|
||||
Click inside any list to add a task. Type a title and press Enter. The task is created immediately - you can add details later.
|
||||
|
||||
## Task details
|
||||
|
||||
|
||||
Click on a task to open the detail panel. Here you can set:
|
||||
|
||||
### Priority
|
||||
How urgent this task is. Priorities help you and your team focus on what matters most. Tasks can be sorted by priority in the list view.
|
||||
|
||||
### Deadline
|
||||
When the task is due. You can set just a date, or a date with a specific time. Quick shortcuts are available for common choices like "Today", "This week", and "This month".
|
||||
|
||||
The dashboard will show upcoming deadlines so nothing slips through.
|
||||
|
||||
### Notes
|
||||
A rich text editor for longer descriptions, steps, links, or anything else. Supports formatting, headings, lists, and code blocks.
|
||||
|
||||
### Assignees
|
||||
Who's working on this. You can assign multiple people to a single task. Each assignee can have a different role (responsible, participant) depending on your project setup.
|
||||
|
||||
### Tags
|
||||
Color-coded labels for categorization. A task can have multiple tags. Tags are defined per project.
|
||||
|
||||
### Status
|
||||
The workflow state of the task - tied to your Kanban columns. Status can only be changed from the Kanban board by dragging the task between columns. There is readonly status selector in the task detail panel.
|
||||
|
||||
### Financial amount
|
||||
Attach a monetary amount to a task and mark it as income or expense. Useful for freelancers or teams that need basic budget tracking alongside task management.
|
||||
|
||||
## Subtasks
|
||||
|
||||
Any task can have subtasks.
|
||||
|
||||
To create a subtask, open a task and click the **Add subtasks** in the subtasks section. Subtasks don't have priorities or other detailed properties - they're meant to break a task into small, easy-to-complete steps.
|
||||
|
||||
Completing a parent task doesn't automatically complete its subtasks. You can use this to track whether all the pieces of a larger task are actually done.
|
||||
|
||||
## Task completion
|
||||
|
||||
Click the checkbox next to a task to mark it complete. Completed tasks are hidden from the list by default. To see them, click the **eye** button in the toolbar - completed tasks will appear dimmed alongside active ones. They also show up in the dashboard's "Completed" widget.
|
||||
|
||||
To reopen a completed task, just click the checkbox again.
|
||||
|
||||
## Task history
|
||||
|
||||
TaskView keeps a history of changes for every task. If something was accidentally changed you can restore it.
|
||||
|
||||
Open a task, go to the history section, and you'll see a log of what changed and when. Click **Restore** on any previous version to bring it back.
|
||||
|
||||
## Deleting tasks
|
||||
|
||||
Delete a task from the context menu or the detail panel. Deleted tasks go through the history system, so you **can not** recover them.
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Kanban Board
|
||||
description: Kanban board in TaskView - drag-and-drop task cards, customizable status columns per project, and visual workflow management. Self-hosted alternative to Trello with full data control.
|
||||
navigation:
|
||||
icon: i-lucide-columns-3
|
||||
---
|
||||
|
||||
The Kanban board gives you a visual overview of your project's workflow. Tasks are displayed as cards in columns, where each column represents a status (like "To Do", "In Progress", "Done").
|
||||
|
||||
## Opening the Kanban view
|
||||
|
||||
|
||||
|
||||
Select a project in the sidebar, then click the **Kanban** button in the context menu. You'll see all your tasks arranged in columns.
|
||||
|
||||
## Columns are statuses
|
||||
|
||||
Each column on the Kanban board is a **status**. Every project has its own set of statuses, so you can customize the workflow for each project independently.
|
||||
|
||||
By default, new projects have Backlog, TODO, In Progress, Done.
|
||||
|
||||
### Adding a column
|
||||
|
||||
Click the **Add column** button on the board to add a new status column. Give it a name - "Backlog", "In Progress", "Review", "Done", or whatever fits your workflow.
|
||||
|
||||
### Editing a column
|
||||
|
||||
Click the column header to rename it or change its properties.
|
||||
|
||||
### Deleting a column
|
||||
|
||||
Remove a column from the column settings. Tasks in that column will need to be moved to another status first.
|
||||
|
||||
### Reordering columns
|
||||
|
||||
**Column reordering is not supported yet** - columns are displayed in the order they were created. Keep this in mind when adding new columns and create them in the order you want. This will be fixed in a future version.
|
||||
|
||||
## Moving tasks
|
||||
|
||||
Drag a task card from one column to another to change its status. The task's position within the column is also saved, so you can prioritize by dragging tasks up and down within the same column.
|
||||
|
||||
When you move a task on the Kanban board, the status change is reflected everywhere - in the list view, in the task detail panel, and in any filters.
|
||||
|
||||
## What you see on a card
|
||||
|
||||
Each Kanban card shows:
|
||||
|
||||
- Task title
|
||||
- Priority indicator
|
||||
- Deadline (if set)
|
||||
- Assigned users (avatars)
|
||||
- Tags (color badges)
|
||||
|
||||
Click a card to open the full task detail panel, where you can edit everything.
|
||||
|
||||
## Tips
|
||||
|
||||
- **Start simple** - three columns ("To Do", "In Progress", "Done") are enough for most projects. Add more columns only when you actually need them.
|
||||
- **Limit work in progress** - if "In Progress" has 20 cards, nothing is really in progress. Keep the number manageable.
|
||||
- **Use the list view for bulk edits** - Kanban is great for visual tracking, but the list view is faster when you need to update many tasks at once.
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: Dependency Graph
|
||||
description: Visualize task dependencies with an interactive network graph in TaskView. Connect tasks, identify blockers and bottlenecks, plan work order, and manage complex project workflows visually.
|
||||
navigation:
|
||||
icon: i-lucide-git-branch
|
||||
---
|
||||
|
||||
The dependency graph shows how tasks in a project relate to each other. If task B can't start until task A is done, you create a dependency - and the graph makes that relationship visible.
|
||||
|
||||
## Opening the graph
|
||||
|
||||
|
||||
|
||||
Select a project in the sidebar, then click the **Graph** button. You'll see all your tasks as standalone nodes. By default, tasks have no dependencies - you connect them yourself by dragging edges between nodes to build the sequence you need.
|
||||
|
||||
## Creating dependencies
|
||||
|
||||
To link two tasks:
|
||||
|
||||
1. Open the graph view
|
||||
2. Drag from one task node to another to create a connection
|
||||
3. The arrow indicates the direction - "this task depends on that task"
|
||||
|
||||
You can also create dependencies from the task detail panel by selecting related tasks.
|
||||
|
||||
## Reading the graph
|
||||
|
||||
- **Nodes** are tasks. Their appearance reflects the task's current state (complete, in progress, overdue).
|
||||
- **Edges** are dependencies. An arrow from task A to task B means "B depends on A" - A should be done before B starts.
|
||||
- **Clusters** of heavily connected tasks show you where the complex work is.
|
||||
- **Isolated nodes** are tasks with no dependencies - they can be done anytime.
|
||||
|
||||
## Navigating
|
||||
|
||||
- **Zoom** in and out with the scroll wheel or pinch gesture
|
||||
- **Pan** by dragging the background
|
||||
- **Click** a node to select it and see the task details
|
||||
- **Minimap** in the corner shows your position in the full graph
|
||||
|
||||
## Removing dependencies
|
||||
|
||||
Click on an edge (the line between two tasks) and delete it. This only removes the dependency relationship - it doesn't affect the tasks themselves.
|
||||
|
||||
## When to use the graph
|
||||
|
||||
The graph is most useful when:
|
||||
|
||||
- You're planning a complex feature with many interconnected tasks
|
||||
- You need to figure out what to work on first (follow the arrows upstream)
|
||||
- You want to spot bottleneck tasks that block many other tasks
|
||||
- You're onboarding someone and want to show them how the work fits together
|
||||
|
||||
For simple projects with independent tasks, the list or Kanban view is usually enough.
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
title: Dashboard
|
||||
description: TaskView dashboard - smart widgets for today's tasks, upcoming deadlines, recent activity, completed work, and daily planning overview across all your projects.
|
||||
navigation:
|
||||
icon: i-lucide-layout-dashboard
|
||||
---
|
||||
|
||||
The dashboard is the first thing you see when you open TaskView. It pulls together the most important information from all your projects into one screen.
|
||||
|
||||
## Widgets
|
||||
|
||||
|
||||
|
||||
### Today's tasks
|
||||
Tasks due today across all projects. This is your daily focus list - what needs attention right now.
|
||||
|
||||
### Upcoming deadlines
|
||||
Tasks due in the coming days. Helps you plan ahead and avoid last-minute surprises.
|
||||
|
||||
### Recent activity
|
||||
A feed of recent changes - new tasks, completed tasks, updates. Useful for staying in the loop on what your team is doing.
|
||||
|
||||
### Completed tasks
|
||||
What's been finished recently. A satisfying way to see progress and confirm that work is actually getting done.
|
||||
|
||||
## How it works
|
||||
|
||||
The dashboard aggregates data across all projects you have access to. If you're a member of five projects, you'll see tasks from all five.
|
||||
|
||||
Tasks appear on the dashboard based on their deadlines and activity timestamps. There's no separate configuration - the dashboard just reflects the state of your tasks.
|
||||
|
||||
## Tips
|
||||
|
||||
- **Check the dashboard first thing** - it gives you a clear picture of what to focus on today
|
||||
- **Use deadlines consistently** - the dashboard is only as useful as the data behind it. If your tasks don't have deadlines, the "Today" and "Upcoming" widgets won't be helpful.
|
||||
- **Don't ignore overdue tasks** - if something is overdue, either do it, move the deadline, or remove it. A growing list of overdue items makes the dashboard noisy.
|
||||
@@ -0,0 +1,2 @@
|
||||
title: Integrations
|
||||
icon: false
|
||||
@@ -0,0 +1,145 @@
|
||||
---
|
||||
title: GitHub & GitLab Setup
|
||||
description: Connect GitHub and GitLab repositories to TaskView. Import and sync issues as tasks with OAuth authorization, webhook-based real-time updates, and AES-256 encrypted token storage. Supports GitHub Enterprise and self-hosted GitLab.
|
||||
navigation:
|
||||
icon: i-lucide-git-pull-request
|
||||
---
|
||||
|
||||
TaskView integrations allow you to connect GitHub or GitLab repositories to your projects. After connecting, issues from the repository are synced as tasks in TaskView and kept up to date via webhooks.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- TaskView API running
|
||||
- PostgreSQL database with migrations applied
|
||||
- `.env.taskview` file configured
|
||||
|
||||
---
|
||||
|
||||
## 1. Database Migration
|
||||
|
||||
The migration creates the required tables (`tasks.integrations` and `tasks.integration_task_map`) automatically. The migration container handles this on startup - no manual steps needed. Just make sure you've run `docker compose up` and the migration container completed successfully.
|
||||
|
||||
---
|
||||
|
||||
## 2. Generate Encryption Key
|
||||
|
||||
Tokens are encrypted with AES-256-GCM. You need a 32-byte hex key (64 characters):
|
||||
|
||||
```bash
|
||||
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
|
||||
```
|
||||
|
||||
Add it to `.env.taskview`:
|
||||
|
||||
```
|
||||
ENCRYPTION_KEY=<your-64-char-hex-key>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Create GitHub OAuth App
|
||||
|
||||
1. Go to [GitHub Developer Settings](https://github.com/settings/developers)
|
||||
2. Click **"New OAuth App"**
|
||||
3. Fill in:
|
||||
- **Application name**: `TaskView Integrations` (or any name)
|
||||
- **Homepage URL**: `http://localhost:3000` (your frontend URL)
|
||||
- **Authorization callback URL**: `http://localhost:1401/module/integrations/oauth/github/callback`
|
||||
4. Click **"Register application"**
|
||||
5. Copy **Client ID** and generate a **Client Secret**
|
||||
|
||||
Add to `.env.taskview`:
|
||||
|
||||
```
|
||||
GITHUB_INTEGRATION_CLIENT_ID=<your-client-id>
|
||||
GITHUB_INTEGRATION_CLIENT_SECRET=<your-client-secret>
|
||||
GITHUB_INTEGRATION_CALLBACK_URL=http://localhost:1401/module/integrations/oauth/github/callback
|
||||
```
|
||||
|
||||
> **Note**: This is a separate OAuth App from the one used for login (`GITHUB_CLIENT_ID`). The integrations app requests `repo` scope, while the login app only requests `user:email`.
|
||||
|
||||
---
|
||||
|
||||
## 4. Create GitLab OAuth App (optional)
|
||||
|
||||
1. Go to [GitLab Applications](https://gitlab.com/-/user_settings/applications)
|
||||
2. Click **"New application"**
|
||||
3. Fill in:
|
||||
- **Name**: `TaskView Integrations`
|
||||
- **Redirect URI**: `http://localhost:1401/module/integrations/oauth/gitlab/callback`
|
||||
- **Scopes**: check `api`
|
||||
4. Click **"Save application"**
|
||||
5. Copy **Application ID** and **Secret**
|
||||
|
||||
Add to `.env.taskview`:
|
||||
|
||||
```
|
||||
GITLAB_INTEGRATION_CLIENT_ID=<your-application-id>
|
||||
GITLAB_INTEGRATION_CLIENT_SECRET=<your-secret>
|
||||
GITLAB_INTEGRATION_CALLBACK_URL=http://localhost:1401/module/integrations/oauth/gitlab/callback
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. Full `.env.taskview` Example
|
||||
|
||||
```env
|
||||
# ... existing vars ...
|
||||
|
||||
# Encryption (required for integrations)
|
||||
ENCRYPTION_KEY=a1b2c3d4e5f6... # 64 hex characters
|
||||
|
||||
# GitHub Integration OAuth
|
||||
GITHUB_INTEGRATION_CLIENT_ID=Iv1.abc123
|
||||
GITHUB_INTEGRATION_CLIENT_SECRET=secret_abc123
|
||||
GITHUB_INTEGRATION_CALLBACK_URL=http://localhost:1401/module/integrations/oauth/github/callback
|
||||
|
||||
# GitLab Integration OAuth (optional)
|
||||
GITLAB_INTEGRATION_CLIENT_ID=app_id_123
|
||||
GITLAB_INTEGRATION_CLIENT_SECRET=secret_123
|
||||
GITLAB_INTEGRATION_CALLBACK_URL=http://localhost:1401/module/integrations/oauth/gitlab/callback
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. Usage
|
||||
|
||||
1. Open a project in TaskView
|
||||
2. Right-click the project in the sidebar → **"Integrations"**
|
||||
3. Click **"Add Integration"**
|
||||
4. Choose **GitHub** or **GitLab** - you'll be redirected to authorize
|
||||
5. After authorization, select a repository from the list
|
||||
6. Done - the integration is active
|
||||
|
||||
You can toggle integrations on/off or delete them from the integrations page.
|
||||
|
||||
---
|
||||
|
||||
## Production Notes
|
||||
|
||||
- **Callback URLs**: Update to your production domain (e.g., `https://api.yourdomain.com/module/integrations/oauth/github/callback`)
|
||||
- **ENCRYPTION_KEY**: Store securely, never commit to git. If changed, existing encrypted tokens become unreadable
|
||||
- **Separate OAuth Apps**: Create new GitHub/GitLab OAuth Apps for production with production callback URLs
|
||||
- **CORS**: Ensure your production frontend domain is in `CORS_ALLOWED_ORIGINS`
|
||||
|
||||
---
|
||||
|
||||
## API Endpoints
|
||||
|
||||
Watch in the source code.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**"GitHub integration OAuth is not configured"**
|
||||
→ `GITHUB_INTEGRATION_CLIENT_ID` or `GITHUB_INTEGRATION_CALLBACK_URL` is missing in `.env`
|
||||
|
||||
**"ENCRYPTION_KEY must be a 64-character hex string"**
|
||||
→ Generate a key: `node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"`
|
||||
|
||||
**OAuth redirects to wrong URL after callback**
|
||||
→ Check that `APP_URL` in `.env` matches your frontend URL (e.g., `http://localhost:3000`)
|
||||
|
||||
**Empty repo list after OAuth**
|
||||
→ The token may have expired or the integration record wasn't created. Check server logs and re-authorize.
|
||||
@@ -0,0 +1,2 @@
|
||||
title: Configuration
|
||||
icon: false
|
||||
@@ -0,0 +1,148 @@
|
||||
---
|
||||
title: Environment Variables
|
||||
description: Complete reference for TaskView environment variables - database connection, JWT authentication, OAuth providers, SMTP email, GitHub/GitLab integration, encryption, and CORS configuration for your self-hosted Docker deployment.
|
||||
navigation:
|
||||
icon: i-lucide-settings
|
||||
---
|
||||
|
||||
TaskView is configured through environment variables set in the `.env.taskview` file (or passed directly to the Docker container). This page documents every available variable.
|
||||
|
||||
## Database
|
||||
|
||||
These must match your PostgreSQL setup.
|
||||
|
||||
| Variable | Required | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `DB_HOST` | Yes | - | Database hostname. Use `db` when running in Docker Compose. |
|
||||
| `DB_USER` | Yes | - | Database username |
|
||||
| `DB_PASSWORD` | Yes | - | Database password |
|
||||
| `DB_NAME` | Yes | - | Database name |
|
||||
| `DB_PORT` | No | `5432` | Database port |
|
||||
|
||||
## Application
|
||||
|
||||
| Variable | Required | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `APP_PORT` | No | `1401` | Port the API server listens on |
|
||||
| `APP_URL` | Yes | https://app.taskview.tech | Full URL of the web app (e.g. `https://tasks.company.com`). Used for OAuth redirects and email links. |
|
||||
|
||||
## Authentication
|
||||
|
||||
| Variable | Required | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `JWT_SIGN` | Yes | - | Secret key for signing JWT tokens. Use a long random string. |
|
||||
| `ACCESS_LIFE_TIME` | No | `1d` | How long access tokens are valid. Examples: `1h`, `1d`, `7d` |
|
||||
| `REFRESH_LIFE_TIME` | No | `2d` | How long refresh tokens are valid |
|
||||
| `JWT_ALG` | No | `HS256` | JWT signing algorithm |
|
||||
|
||||
::callout{icon="i-lucide-shield" color="warning"}
|
||||
Generate a strong JWT secret: `node -e "console.log(require('crypto').randomBytes(64).toString('hex'))"`
|
||||
::
|
||||
|
||||
## SMTP (Email)
|
||||
|
||||
Required for password recovery, email confirmation, and invitation notifications. Without SMTP, these features won't work, but everything else functions normally.
|
||||
|
||||
| Variable | Required | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `SMTP_HOST` | No | - | SMTP server hostname |
|
||||
| `SMTP_PORT` | No | `465` | SMTP port |
|
||||
| `SMTP_USERNAME` | No | - | SMTP login |
|
||||
| `SMTP_PASSWORD` | No | - | SMTP password |
|
||||
| `SMTP_ENCRYPTION` | No | `ssl` | `ssl` or `tls` |
|
||||
| `SMTP_FROM_NAME` | No | `TaskView` | Sender name in emails |
|
||||
| `SMTP_FROM_EMAIL` | No | - | Sender email address |
|
||||
|
||||
## Encryption
|
||||
|
||||
Required for GitHub/GitLab integrations. OAuth tokens are encrypted at rest using AES-256-GCM.
|
||||
|
||||
| Variable | Required | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `ENCRYPTION_KEY` | No | - | 32-byte hex string (64 characters). Required for integrations. |
|
||||
|
||||
Generate a key:
|
||||
```bash
|
||||
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
|
||||
```
|
||||
|
||||
::callout{icon="i-lucide-alert-triangle" color="error"}
|
||||
If you change or lose the encryption key, all stored integration tokens become unreadable. You'll need to reconnect your GitHub/GitLab integrations.
|
||||
::
|
||||
|
||||
## GitHub Integration
|
||||
|
||||
For connecting GitHub repositories. See [GitHub & GitLab Setup](/docs/integrations/setup) for a step-by-step guide.
|
||||
|
||||
| Variable | Required | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `GITHUB_INTEGRATION_CLIENT_ID` | No | - | OAuth App client ID |
|
||||
| `GITHUB_INTEGRATION_CLIENT_SECRET` | No | - | OAuth App client secret |
|
||||
| `GITHUB_INTEGRATION_CALLBACK_URL` | No | - | OAuth callback URL |
|
||||
| `GITHUB_BASE_URL` | No | `https://github.com` | Override for GitHub Enterprise |
|
||||
| `GITHUB_API_URL` | No | `https://api.github.com` | Override for GitHub Enterprise API |
|
||||
|
||||
## GitLab Integration
|
||||
|
||||
For connecting GitLab repositories.
|
||||
|
||||
| Variable | Required | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `GITLAB_INTEGRATION_CLIENT_ID` | No | - | OAuth App client ID |
|
||||
| `GITLAB_INTEGRATION_CLIENT_SECRET` | No | - | OAuth App client secret |
|
||||
| `GITLAB_INTEGRATION_CALLBACK_URL` | No | - | OAuth callback URL |
|
||||
| `GITLAB_BASE_URL` | No | `https://gitlab.com` | Override for self-hosted GitLab |
|
||||
| `GITLAB_API_URL` | No | `https://gitlab.com/api/v4` | Override for self-hosted GitLab API |
|
||||
|
||||
## Full example
|
||||
|
||||
Here's a complete `.env.taskview` file for a production deployment:
|
||||
|
||||
```env
|
||||
DB_HOST="db"
|
||||
DB_USER="taskview_db_user"
|
||||
DB_PASSWORD="password"
|
||||
DB_NAME="taskview"
|
||||
DB_PORT=5432
|
||||
APP_PORT=1401
|
||||
JWT_ALG="HS256"
|
||||
JWT_SIGN="secret"
|
||||
ACCESS_LIFE_TIME="3d"
|
||||
REFRESH_LIFE_TIME="9d"
|
||||
|
||||
SMTP_HOST=smtp
|
||||
SMTP_PORT=587
|
||||
SMTP_USERNAME=
|
||||
SMTP_PASSWORD=
|
||||
SMTP_ENCRYPTION=tls
|
||||
SMTP_FROM_NAME=TaskView
|
||||
SMTP_FROM_EMAIL=
|
||||
|
||||
# Your domain
|
||||
APP_URL="https://app.taskview.tech"
|
||||
|
||||
GOOGLE_CLIENT_ID=""
|
||||
GOOGLE_CLIENT_SECRET=""
|
||||
#You domain
|
||||
GOOGLE_CALLBACK_URL="https://api.taskview.tech/module/auth/provider/google/callback"
|
||||
GITHUB_CLIENT_ID=""
|
||||
GITHUB_CLIENT_SECRET=""
|
||||
GITHUB_CALLBACK_URL="https://api.taskview.tech/module/auth/provider/github/callback"
|
||||
APPLE_CLIENT_ID=""
|
||||
APPLE_TEAM_ID=""
|
||||
APPLE_KEY_ID=""
|
||||
APPLE_KEY_LOCATION="/usr/src/app/AuthKey.p8"
|
||||
# Your domain
|
||||
APPLE_CALLBACK_URL="https://api.taskview.tech/module/auth/provider/apple/callback"
|
||||
|
||||
#integrations
|
||||
GITHUB_INTEGRATION_CLIENT_ID=
|
||||
GITHUB_INTEGRATION_CLIENT_SECRET=
|
||||
GITHUB_INTEGRATION_CALLBACK_URL=https://api.taskview.tech/module/integrations/oauth/github/callback
|
||||
|
||||
GITLAB_INTEGRATION_CLIENT_ID=
|
||||
GITLAB_INTEGRATION_CLIENT_SECRET=
|
||||
GITLAB_INTEGRATION_CALLBACK_URL=https://api.taskview.tech/module/integrations/oauth/github/callback
|
||||
|
||||
ENCRYPTION_KEY=
|
||||
```
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
title: Authentication
|
||||
description: Configure authentication in TaskView - email/password, email/code, OAuth with GitHub, Google, and Apple Sign In. JWT session management, password recovery, and account deletion for your self-hosted instance.
|
||||
navigation:
|
||||
icon: i-lucide-lock
|
||||
---
|
||||
|
||||
TaskView supports multiple ways to sign in - email/password, email/code, GitHub, Google, and Apple. You can enable whichever methods make sense for your team.
|
||||
|
||||
## Email and password
|
||||
|
||||
This is the default method and works out of the box. Users register with an email and password, and log in the same way (email conformation is required).
|
||||
|
||||
If you have SMTP configured, users will receive a confirmation email after registration.
|
||||
Without SMTP, email confirmation is skipped and accounts should be activated manually.
|
||||
|
||||
### Password recovery
|
||||
|
||||
Requires SMTP. Users click "Forgot password" on the login screen, enter their email, and receive a reset link. Without SMTP configured, password recovery is not available - you'll need to reset passwords manually in the database.
|
||||
|
||||
## OAuth providers
|
||||
|
||||
TaskView can use external providers for login. This is separate from the integration OAuth (which is for connecting GitHub/GitLab repositories).
|
||||
|
||||
### GitHub login
|
||||
|
||||
Users click "Sign in with GitHub" and authorize the app. TaskView only requests the `user:email` scope - it reads the email to match or create an account.
|
||||
|
||||
To enable, you need a GitHub OAuth App (separate from the integrations one):
|
||||
|
||||
1. Go to [GitHub Developer Settings](https://github.com/settings/developers)
|
||||
2. Create a **New OAuth App**
|
||||
3. Set the callback URL to `{API_URL}/module/auth/provider/github/callback`
|
||||
|
||||
### Google login
|
||||
|
||||
Works the same way. Create credentials in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials), set the callback to `{API_URL}/module/auth/provider/google/callback`.
|
||||
|
||||
### Apple login
|
||||
|
||||
Available for users on Apple devices. Requires an Apple Developer account and Sign in with Apple configuration.
|
||||
|
||||
## Sessions
|
||||
|
||||
TaskView uses JWT tokens for session management:
|
||||
|
||||
- **Access token** - short-lived (default: 1 day), used for API requests
|
||||
- **Refresh token** - longer-lived (default: 2 days), used to get a new access token
|
||||
|
||||
When the access token expires, the app automatically uses the refresh token to get a new one. Users stay logged in as long as the refresh token is valid.
|
||||
|
||||
You can adjust token lifetimes with the `ACCESS_LIFE_TIME` and `REFRESH_LIFE_TIME` environment variables.
|
||||
|
||||
## Account deletion
|
||||
|
||||
Users can delete their own account from the account settings page. This is a two-step process - they request a deletion code (sent by email if SMTP is configured), then confirm. Account deletion removes all personal data (You cannot undo this action. You can only restore the data from a backup, if you have one.).
|
||||
@@ -0,0 +1,2 @@
|
||||
title: Collaboration
|
||||
icon: false
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
title: Team Members
|
||||
description: Invite team members to TaskView projects by email, assign tasks, manage access, and control visibility. Built-in collaboration tools with project ownership and role assignment for self-hosted project management.
|
||||
navigation:
|
||||
icon: i-lucide-users
|
||||
---
|
||||
|
||||
TaskView is built for teams. You can invite people to your projects, assign them tasks, and control what they can see and do through roles and permissions.
|
||||
|
||||
## Inviting members
|
||||
|
||||
1. Open a project and go to the **Collaboration** tab
|
||||
2. Enter the person's email address in the input field
|
||||
3. Click **Add**
|
||||
|
||||
The person needs to have a TaskView account with that email. If they don't have one yet, they'll need to register first (using the same email you invited them with).
|
||||
|
||||
Once added, they'll see the project in their sidebar and can start working immediately.
|
||||
|
||||
## Removing members
|
||||
|
||||
In the Collaboration tab, find the user and click the remove button. They'll lose access to the project instantly - all their tasks remain, but they can no longer view or edit anything in the project.
|
||||
|
||||
## Project owner
|
||||
|
||||
The person who creates a project is its **owner**. The owner has all permissions by default and can't be removed from the project. Ownership can't be transferred.
|
||||
|
||||
## What members can do
|
||||
|
||||
By default, new members don't have any permissions beyond viewing the project. You need to assign them a **role** that grants specific permissions. See [Roles and Permissions](/docs/collaboration/roles-and-permissions) for details.
|
||||
|
||||
## Tips
|
||||
|
||||
- **Add people before assigning tasks** - you can only assign tasks to project members
|
||||
- **Use roles** - instead of giving each person individual permissions, create a few roles ("Developer", "Manager", "Viewer") and assign people to them
|
||||
- **Keep the member list clean** - remove people who are no longer working on the project. They'll still keep their own account, just won't have access to this project anymore.
|
||||
@@ -0,0 +1,106 @@
|
||||
---
|
||||
title: Roles and Permissions
|
||||
description: Role-based access control (RBAC) in TaskView - 28 granular permissions for tasks, lists, Kanban boards, dependency graphs, team members, and GitHub/GitLab integrations. Per-project roles with server-side enforcement.
|
||||
navigation:
|
||||
icon: i-lucide-shield
|
||||
---
|
||||
|
||||
TaskView uses a role-based access control (RBAC) system. You create roles, assign permissions to those roles, and then assign roles to team members. This way you define once what a "Developer" or "Viewer" can do, and simply assign that role to new people.
|
||||
|
||||
## How it works
|
||||
|
||||
|
||||
|
||||
Each **project** has its own set of roles and permissions. A role in one project doesn't affect access in another.
|
||||
|
||||
The chain is simple:
|
||||
|
||||
**Permission** → assigned to → **Role** → assigned to → **User**
|
||||
|
||||
A user can have one or more roles per project. Their permissions are the sum of what that role allows.
|
||||
|
||||
## Creating roles
|
||||
|
||||
1. Go to the **Collaboration** tab in a project
|
||||
2. Open the **Roles** section
|
||||
3. Click **Add Role** and give it a name (like "Developer", "Designer", "Viewer")
|
||||
|
||||
## Assigning permissions to a role
|
||||
|
||||
After creating a role, toggle the permissions you want to grant. Permissions are grouped by area:
|
||||
|
||||
### Project permissions
|
||||
|
||||
| Permission | Key | What it allows |
|
||||
|---|---|---|
|
||||
| Delete project | `goal_can_delete` | Permanently delete the entire project |
|
||||
| Edit project | `goal_can_edit` | Rename the project, change color |
|
||||
| Manage users | `goal_can_manage_users` | Add/remove team members, assign roles |
|
||||
| Add lists | `goal_can_add_task_list` | Create new task lists in the project |
|
||||
| View lists | `goal_can_watch_content` | See the list of task lists (not the tasks inside) |
|
||||
|
||||
### List permissions
|
||||
|
||||
| Permission | Key | What it allows |
|
||||
|---|---|---|
|
||||
| Delete list | `component_can_delete` | Remove a task list and its contents |
|
||||
| Edit list | `component_can_edit` | Rename a task list |
|
||||
| View tasks | `component_can_watch_content` | See tasks inside a list - their title, status, deadlines, and times |
|
||||
| Add tasks | `component_can_add_tasks` | Create new tasks in a list |
|
||||
|
||||
### Task permissions
|
||||
|
||||
| Permission | Key | What it allows |
|
||||
|---|---|---|
|
||||
| Delete task | `task_can_delete` | Permanently remove a task |
|
||||
| Edit description | `task_can_edit_description` | Change the task title |
|
||||
| Edit status | `task_can_edit_status` | Toggle the completion checkbox |
|
||||
| Edit note | `task_can_edit_note` | Modify the rich-text note |
|
||||
| View note | `task_can_watch_note` | See the note editor |
|
||||
| Edit deadline | `task_can_edit_deadline` | Set or change start/end dates and times |
|
||||
| View details | `task_can_watch_details` | Open the task detail panel (works only in UI) |
|
||||
| View subtasks | `task_can_watch_subtasks` | See the subtasks section |
|
||||
| Add subtasks | `task_can_add_subtasks` | Create subtasks |
|
||||
| Edit tags | `task_can_edit_tags` | Add or remove tags on a task |
|
||||
| View tags | `task_can_watch_tags` | See which tags are attached |
|
||||
| View priority | `task_can_watch_priority` | See the task priority |
|
||||
| Edit priority | `task_can_edit_priority` | Change the task priority |
|
||||
| View history | `task_can_access_history` | See the change history of a task |
|
||||
| Restore history | `task_can_recovery_history` | Restore a task to a previous state |
|
||||
| Assign users | `task_can_assign_users` | Add or remove assignees |
|
||||
| View assignees | `task_can_watch_assigned_users` | See who is assigned to a task |
|
||||
|
||||
### Kanban permissions
|
||||
|
||||
| Permission | Key | What it allows |
|
||||
|---|---|---|
|
||||
| View Kanban | `kanban_can_view` | See the Kanban board |
|
||||
| Manage Kanban | `kanban_can_manage` | Create, edit, delete status columns and move tasks |
|
||||
|
||||
### Graph permissions
|
||||
|
||||
| Permission | Key | What it allows |
|
||||
|---|---|---|
|
||||
| View graph | `graph_can_view` | See the dependency graph |
|
||||
| Manage graph | `graph_can_manage` | Create and remove task dependencies |
|
||||
|
||||
### Integration permissions
|
||||
|
||||
| Permission | Key | What it allows |
|
||||
|---|---|---|
|
||||
| View integrations | `integrations_can_view` | See connected GitHub/GitLab integrations |
|
||||
| Manage integrations | `integrations_can_manage` | Add, remove, toggle, and sync integrations |
|
||||
|
||||
## Assigning roles to users
|
||||
|
||||
In the Collaboration tab, find the user and select a role from the dropdown. The permissions take effect immediately.
|
||||
|
||||
## The project owner
|
||||
|
||||
The project owner automatically has all permissions. You don't need to assign a role to the owner - they can always do everything.
|
||||
|
||||
## Tips
|
||||
|
||||
- **Start with 2-3 roles** - "Admin" (everything), "Member" (create and edit), "Viewer" (read only). Add more specific roles only if you need them.
|
||||
- **Review permissions when something feels wrong** - if someone can't edit a task or see the Kanban board, it's almost always a missing permission on their role.
|
||||
- **Permissions are enforced on both client and server** - even if someone inspects the UI or calls the API directly, the server checks permissions before allowing any action.
|
||||
@@ -0,0 +1,2 @@
|
||||
title: FAQ
|
||||
icon: false
|
||||
@@ -0,0 +1,129 @@
|
||||
---
|
||||
title: Frequently Asked Questions
|
||||
description: Common questions about TaskView - self-hosted open-source task and project management. Installation, features, security, Docker deployment, team collaboration, and more.
|
||||
navigation:
|
||||
icon: i-lucide-circle-help
|
||||
---
|
||||
|
||||
Answers to the most common questions about TaskView.
|
||||
|
||||
## General
|
||||
|
||||
### What is TaskView?
|
||||
|
||||
TaskView is an source-available, self-hosted project and task management platform. It provides Kanban boards, dependency graphs, team collaboration with role-based access control, GitHub/GitLab integration, and a dashboard - all running on your own infrastructure.
|
||||
|
||||
### Is TaskView free?
|
||||
|
||||
Yes. TaskView Community Edition is free (see LICENSE) and source-available under the [license](https://github.com/Gimanh/taskview-community/blob/main/LICENSE.md).
|
||||
|
||||
### What is the difference between TaskView and SaaS tools like Trello or Asana?
|
||||
|
||||
TaskView is **self-hosted** - you run it on your own server. Your data never leaves your infrastructure. There are no subscriptions, no vendor lock-in, and no third-party access to your project data. You get full control over backups, updates, and security.
|
||||
|
||||
### Who is TaskView for?
|
||||
|
||||
TaskView is designed for teams and individuals who need task management with full data ownership. It works well for small teams, startups, freelancers, security-conscious organizations, and anyone who prefers self-hosted tools.
|
||||
|
||||
## Installation and Deployment
|
||||
|
||||
### How do I install TaskView?
|
||||
|
||||
TaskView runs as a set of Docker containers. You need Docker and Docker Compose installed, then create two environment files and a `docker-compose.yml`. The whole setup takes about 5 minutes. See the [Installation guide](/docs/getting-started/installation) for step-by-step instructions.
|
||||
|
||||
### What are the system requirements?
|
||||
|
||||
You need a server or local machine with Docker and Docker Compose. TaskView runs on any platform that supports Docker - Linux, macOS, or Windows. Minimum recommended: 1 CPU core, 1 GB RAM, 10 GB disk space.
|
||||
|
||||
### Can I run TaskView on a VPS?
|
||||
|
||||
Yes. TaskView works on any VPS provider (Hetzner, DigitalOcean, AWS EC2, Linode, etc.). Deploy with Docker Compose and put a reverse proxy (Nginx, Caddy, or Traefik) in front for SSL termination. See the [deployment guide](/docs/guides/deploy-vps-nginx) for a detailed walkthrough.
|
||||
|
||||
### How do I update TaskView?
|
||||
|
||||
Run `docker compose pull` followed by `docker compose up -d`. The migration container automatically applies any database changes on startup.
|
||||
|
||||
### Does TaskView support HTTPS?
|
||||
|
||||
TaskView itself serves HTTP. For HTTPS, use a reverse proxy like Nginx or Caddy in front of the TaskView containers to terminate SSL. This is the recommended production setup.
|
||||
|
||||
## Features
|
||||
|
||||
### Does TaskView have Kanban boards?
|
||||
|
||||
Yes. Each project has a Kanban board with customizable status columns. Drag and drop task cards between columns to update their status. See [Kanban Board](/docs/features/kanban) for details.
|
||||
|
||||
### Can I track task dependencies?
|
||||
|
||||
Yes. TaskView has an interactive dependency graph where you can link tasks and visualize the relationships. This helps identify bottlenecks and plan the order of work. See [Dependency Graph](/docs/features/graph).
|
||||
|
||||
### Does TaskView support subtasks?
|
||||
|
||||
Yes. Any task can have subtasks for breaking work into smaller steps. Subtasks are lightweight - they have a title and a completion state.
|
||||
|
||||
### Can I attach files to tasks?
|
||||
|
||||
Currently, TaskView does not support file attachments. You can add links and descriptions in the task notes using the rich text editor.
|
||||
|
||||
### Does TaskView have time tracking?
|
||||
|
||||
TaskView does not include built-in time tracking. It focuses on task management, Kanban workflows, and team collaboration.
|
||||
|
||||
### Does TaskView support financial tracking?
|
||||
|
||||
Yes. You can attach a monetary amount to any task and mark it as income or expense. This is useful for freelancers and teams that need basic budget tracking alongside task management.
|
||||
|
||||
## Team and Collaboration
|
||||
|
||||
### How do I invite team members?
|
||||
|
||||
Open a project, go to the Collaboration tab, and enter the person's email address. They need to have a TaskView account with that email. See [Team Members](/docs/collaboration/members).
|
||||
|
||||
### Does TaskView have role-based access control?
|
||||
|
||||
Yes. TaskView has a granular RBAC system with 28 permissions covering tasks, lists, Kanban, graphs, members, and integrations. You create roles, assign permissions, and assign roles to users. See [Roles and Permissions](/docs/collaboration/roles-and-permissions).
|
||||
|
||||
### Can different team members have different permissions?
|
||||
|
||||
Yes. Permissions are per-project. You can create roles like "Developer", "Manager", and "Viewer" with different permission sets, and assign them to team members independently in each project.
|
||||
|
||||
## Integrations
|
||||
|
||||
### Can I connect GitHub repositories?
|
||||
|
||||
Yes. TaskView can sync issues from GitHub repositories as tasks. You connect via OAuth, select a repository, and issues are imported and kept in sync via webhooks. See [GitHub & GitLab Setup](/docs/integrations/setup).
|
||||
|
||||
### Can I connect GitLab repositories?
|
||||
|
||||
Yes. GitLab integration works the same way as GitHub - OAuth authorization, repository selection, and webhook-based sync. Both cloud and self-hosted GitLab instances are supported.
|
||||
|
||||
### Does TaskView have an API?
|
||||
|
||||
Yes. TaskView has a [REST API](https://www.npmjs.com/package/taskview-api) that powers both the web app and mobile apps. The API uses JWT authentication and is fully documented in the source code.
|
||||
|
||||
## Security and Data
|
||||
|
||||
### Where is my data stored?
|
||||
|
||||
All data is stored in a PostgreSQL database on your server. The `pgdata` Docker volume contains the database files. No data is sent to external services.
|
||||
|
||||
### How do I back up my data?
|
||||
|
||||
Back up the PostgreSQL `pgdata` Docker volume. You can use standard PostgreSQL backup tools like `pg_dump` or volume-level backups depending on your infrastructure.
|
||||
|
||||
### Are OAuth tokens stored securely?
|
||||
|
||||
Yes. GitHub and GitLab integration tokens are encrypted at rest using AES-256-GCM with a key you provide via the `ENCRYPTION_KEY` environment variable.
|
||||
|
||||
## Mobile
|
||||
|
||||
### Does TaskView have mobile apps?
|
||||
|
||||
Yes. TaskView has Android and iOS apps built with Capacitor. They connect to your self-hosted server and sync your tasks, projects, and notifications.
|
||||
|
||||
- [iOS (App Store)](https://apps.apple.com/lk/app/taskview-todo-list-tasks/id6499107867)
|
||||
- [Android (Google Play)](https://play.google.com/store/apps/details?id=com.handscreamgnl.taskview.app)
|
||||
|
||||
### Can I use TaskView in a mobile browser?
|
||||
|
||||
Yes. The [web interface](https://app.taskview.tech) is responsive and works in mobile browsers, though the native apps provide a better experience.
|
||||
@@ -0,0 +1,2 @@
|
||||
title: Guides
|
||||
icon: false
|
||||
@@ -0,0 +1,189 @@
|
||||
---
|
||||
title: Deploy TaskView on a VPS with Nginx
|
||||
description: Step-by-step guide to deploy TaskView on a VPS with Nginx reverse proxy, SSL certificates via Let's Encrypt, and Docker Compose. Production-ready self-hosted setup.
|
||||
navigation:
|
||||
icon: i-lucide-server
|
||||
---
|
||||
|
||||
This guide walks you through deploying TaskView on a VPS with Nginx as a reverse proxy and free SSL certificates from Let's Encrypt.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A VPS with Ubuntu 22.04+ (Debian, CentOS, or any Linux distro with Docker support works too)
|
||||
- A domain name pointing to your server's IP address (e.g., `tasks.yourcompany.com` and `api.tasks.yourcompany.com`)
|
||||
- SSH access to the server
|
||||
|
||||
## Step 1: Install Docker
|
||||
|
||||
Connect to your server and install Docker:
|
||||
|
||||
```bash
|
||||
# Update packages
|
||||
sudo apt update && sudo apt upgrade -y
|
||||
|
||||
# Install Docker
|
||||
curl -fsSL https://get.docker.com | sh
|
||||
|
||||
# Add your user to the docker group
|
||||
sudo usermod -aG docker $USER
|
||||
|
||||
# Log out and back in for the group change to take effect
|
||||
```
|
||||
|
||||
Verify the installation:
|
||||
|
||||
```bash
|
||||
docker --version
|
||||
docker compose version
|
||||
```
|
||||
|
||||
## Step 2: Set up TaskView
|
||||
|
||||
Follow the standard [Installation guide](/docs/getting-started/installation) to create your project directory, environment files, and `docker-compose.yml`.
|
||||
|
||||
Update your `.env.taskview` with production values:
|
||||
|
||||
```env
|
||||
APP_URL="https://tasks.yourcompany.com"
|
||||
```
|
||||
|
||||
Update `CORS_ALLOWED_ORIGINS` to include your production domain:
|
||||
|
||||
```env
|
||||
CORS_ALLOWED_ORIGINS="https://tasks.yourcompany.com"
|
||||
```
|
||||
|
||||
Start the containers:
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## Step 3: Install Nginx
|
||||
|
||||
```bash
|
||||
sudo apt install nginx -y
|
||||
```
|
||||
|
||||
## Step 4: Install Certbot and get SSL certificates
|
||||
|
||||
Install Certbot with the Nginx plugin to get free SSL certificates from Let's Encrypt:
|
||||
|
||||
```bash
|
||||
sudo apt install certbot python3-certbot-nginx -y
|
||||
```
|
||||
|
||||
## Step 5: Configure Nginx with HTTPS
|
||||
|
||||
Create a configuration file:
|
||||
|
||||
```bash
|
||||
sudo nano /etc/nginx/sites-available/taskview
|
||||
```
|
||||
|
||||
```nginx
|
||||
# TaskView Web App - redirect HTTP to HTTPS
|
||||
server {
|
||||
listen 80;
|
||||
server_name tasks.yourcompany.com;
|
||||
return 301 https://$host$request_uri;
|
||||
}
|
||||
|
||||
server {
|
||||
listen 443 ssl;
|
||||
server_name tasks.yourcompany.com;
|
||||
|
||||
ssl_certificate /etc/letsencrypt/live/tasks.yourcompany.com/fullchain.pem;
|
||||
ssl_certificate_key /etc/letsencrypt/live/tasks.yourcompany.com/privkey.pem;
|
||||
include /etc/letsencrypt/options-ssl-nginx.conf;
|
||||
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;
|
||||
|
||||
location / {
|
||||
proxy_pass http://127.0.0.1:8888;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
}
|
||||
|
||||
# TaskView API - redirect HTTP to HTTPS
|
||||
server {
|
||||
listen 80;
|
||||
server_name api.tasks.yourcompany.com;
|
||||
return 301 https://$host$request_uri;
|
||||
}
|
||||
|
||||
server {
|
||||
listen 443 ssl;
|
||||
server_name api.tasks.yourcompany.com;
|
||||
|
||||
ssl_certificate /etc/letsencrypt/live/api.tasks.yourcompany.com/fullchain.pem;
|
||||
ssl_certificate_key /etc/letsencrypt/live/api.tasks.yourcompany.com/privkey.pem;
|
||||
include /etc/letsencrypt/options-ssl-nginx.conf;
|
||||
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;
|
||||
|
||||
client_max_body_size 50M;
|
||||
|
||||
location / {
|
||||
proxy_pass http://127.0.0.1:1725;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Enable the site:
|
||||
|
||||
```bash
|
||||
sudo ln -s /etc/nginx/sites-available/taskview /etc/nginx/sites-enabled/
|
||||
```
|
||||
|
||||
Get SSL certificates from Let's Encrypt using Certbot. Certbot will verify domain ownership and download the certificates referenced in the Nginx config:
|
||||
|
||||
```bash
|
||||
sudo certbot --nginx -d tasks.yourcompany.com -d api.tasks.yourcompany.com
|
||||
```
|
||||
|
||||
Test the configuration and restart Nginx:
|
||||
|
||||
```bash
|
||||
sudo nginx -t
|
||||
sudo systemctl restart nginx
|
||||
```
|
||||
|
||||
Certbot sets up automatic certificate renewal. Verify it works:
|
||||
|
||||
```bash
|
||||
sudo certbot renew --dry-run
|
||||
```
|
||||
|
||||
## Step 6: Verify
|
||||
|
||||
Open `https://tasks.yourcompany.com` in your browser. You should see the TaskView login screen served over HTTPS.
|
||||
|
||||
## Automatic updates
|
||||
|
||||
Create a simple script to update TaskView:
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
cd /path/to/taskview
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
You can schedule this with cron if you want automatic updates, or run it manually when a new version is released.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**502 Bad Gateway**
|
||||
The TaskView containers aren't running. Check with `docker compose ps` and `docker compose logs`.
|
||||
|
||||
**SSL certificate errors**
|
||||
Make sure your domain's DNS A record points to your server's IP. Certbot needs to verify domain ownership.
|
||||
|
||||
**Can't connect to the API**
|
||||
Check that `CORS_ALLOWED_ORIGINS` in `.env.taskview` includes your production frontend URL with the `https://` prefix.
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
title: TaskView for Freelancers
|
||||
description: How freelancers can use TaskView for project management, client work tracking, budget and income tracking, and task organization. Free self-hosted alternative to paid tools.
|
||||
navigation:
|
||||
icon: i-lucide-briefcase
|
||||
---
|
||||
|
||||
TaskView works well for freelancers who juggle multiple clients and need a simple way to track tasks, deadlines, and money - without paying for a SaaS subscription.
|
||||
|
||||
::callout{icon="i-lucide-scale" color="warning"}
|
||||
TaskView is source-available software. Before using it, please review the [license](https://github.com/Gimanh/taskview-community/blob/main/LICENSE.md) to make sure your use case is covered. Freelancers may use TaskView for their own task management (Internal Use), but providing access to clients or third parties is not permitted under the community license.
|
||||
::
|
||||
|
||||
## Why TaskView for freelancing
|
||||
|
||||
- **No per-seat costs** - it's free and self-hosted
|
||||
- **Financial tracking built in** - attach income/expense amounts to tasks
|
||||
- **One project per client** - keep work separated with independent permissions
|
||||
- **Full data ownership** - your client data stays on your server
|
||||
- **Deadline tracking** - the dashboard shows what's due today and what's coming up
|
||||
|
||||
## Setting up for client work
|
||||
|
||||
### One project per client
|
||||
|
||||
Create a separate project for each client. This gives you:
|
||||
|
||||
- Independent task lists (e.g., "Website", "Marketing", "Maintenance")
|
||||
- Client-specific tags ("urgent", "waiting-for-feedback", "billable")
|
||||
- Separate Kanban workflows per project
|
||||
- Clean separation when archiving completed client work
|
||||
|
||||
### Track income per task
|
||||
|
||||
Use the **financial amount** field on tasks to log what each piece of work is worth:
|
||||
|
||||
1. Open a task
|
||||
2. Set the financial amount
|
||||
3. Mark it as **income**
|
||||
|
||||
This gives you a per-project view of expected and completed revenue. While TaskView isn't accounting software, it's enough to see at a glance how much a project is worth.
|
||||
|
||||
### Use deadlines consistently
|
||||
|
||||
Set deadlines on every task that has a due date. The dashboard widgets - "Today's tasks" and "Upcoming deadlines" - become your daily planner across all clients.
|
||||
|
||||
### Kanban for workflow stages
|
||||
|
||||
Set up Kanban columns that match your freelance workflow:
|
||||
|
||||
- **Backlog** - ideas and future work
|
||||
- **To Do** - committed work for this week/sprint
|
||||
- **In Progress** - actively working on
|
||||
- **Waiting for Feedback** - sent to client, waiting for response
|
||||
- **Done** - completed and delivered
|
||||
|
||||
### Tags for cross-project filtering
|
||||
|
||||
Create consistent tags across projects:
|
||||
|
||||
- `billable` / `non-billable`
|
||||
- `urgent`
|
||||
- `recurring`
|
||||
- `blocked`
|
||||
|
||||
## Backing up your work
|
||||
|
||||
Since TaskView is self-hosted, you're responsible for backups. Set up a regular PostgreSQL backup (daily `pg_dump` to a separate location) so you never lose client data.
|
||||
@@ -0,0 +1,192 @@
|
||||
# Outgoing Webhooks
|
||||
|
||||
## Overview
|
||||
|
||||
TaskView fires HTTP POST requests to external services when things happen with tasks.
|
||||
User registers a webhook URL, picks which events to listen to, gets a secret for signature verification.
|
||||
|
||||
No auth tokens, no OAuth, no API keys for consumers — just signed payloads.
|
||||
|
||||
## How it works
|
||||
|
||||
### Registration
|
||||
|
||||
User with `WEBHOOKS_CAN_MANAGE` permission goes to project settings (or a new "Webhooks" tab in the integrations panel).
|
||||
Fills in:
|
||||
- **URL** — where to send events (`https://ops.company.com/hooks/taskview`)
|
||||
- **Events** — checkboxes: `task.created`, `task.updated`, `task.completed`, `task.deleted`
|
||||
- **Description** (optional) — "Slack notifications", "PagerDuty alerts", etc.
|
||||
|
||||
On save, the server generates a **webhook secret** (random 32-byte hex, like we already do for GitHub/GitLab webhooks).
|
||||
The secret is shown to the user once. Stored encrypted in DB (same `encrypt()` we use for integration tokens).
|
||||
|
||||
### Payload
|
||||
|
||||
When an event fires, TaskView POSTs JSON to the registered URL:
|
||||
|
||||
```
|
||||
POST https://ops.company.com/hooks/taskview
|
||||
Content-Type: application/json
|
||||
X-TaskView-Event: task.completed
|
||||
X-TaskView-Signature: sha256=abc123...
|
||||
X-TaskView-Delivery: <uuid>
|
||||
|
||||
{
|
||||
"event": "task.completed",
|
||||
"timestamp": "2026-03-09T14:30:00Z",
|
||||
"deliveryId": "550e8400-e29b-41d4-a716-446655440000",
|
||||
"projectId": 42,
|
||||
"task": {
|
||||
"id": 123,
|
||||
"description": "Fix login bug",
|
||||
"complete": true,
|
||||
"goalListId": 5,
|
||||
"priorityId": 2,
|
||||
"statusId": 3,
|
||||
"assignedUsers": [1, 7],
|
||||
"tags": [10, 11]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Signature verification
|
||||
|
||||
The consumer verifies the request is really from TaskView using the shared secret:
|
||||
|
||||
```python
|
||||
import hmac, hashlib
|
||||
|
||||
def verify(payload_body, signature_header, secret):
|
||||
expected = 'sha256=' + hmac.new(
|
||||
secret.encode(), payload_body, hashlib.sha256
|
||||
).hexdigest()
|
||||
return hmac.compare_digest(expected, signature_header)
|
||||
```
|
||||
|
||||
Same approach GitHub uses. No OAuth needed — if the signature matches, it's from TaskView.
|
||||
This is simpler than API keys because the consumer doesn't need to store credentials for calling TaskView back.
|
||||
|
||||
### Why not API keys / OAuth?
|
||||
|
||||
Outgoing webhooks are **push-only**. TaskView pushes data to the consumer.
|
||||
The consumer doesn't call TaskView API — it just receives events.
|
||||
|
||||
If we later want consumers to call TaskView back (e.g. update a task from Slack), that's a separate feature (incoming API + API keys).
|
||||
Don't mix the two — outgoing webhooks are simple and should stay simple.
|
||||
|
||||
## Database
|
||||
|
||||
New table `tasks.webhooks`:
|
||||
|
||||
```sql
|
||||
CREATE TABLE tasks.webhooks (
|
||||
id SERIAL PRIMARY KEY,
|
||||
project_id INTEGER NOT NULL REFERENCES tasks.goals(id) ON DELETE CASCADE,
|
||||
url TEXT NOT NULL,
|
||||
description TEXT,
|
||||
secret_encrypted TEXT NOT NULL,
|
||||
events TEXT[] NOT NULL DEFAULT '{}',
|
||||
is_active BOOLEAN NOT NULL DEFAULT true,
|
||||
created_at TIMESTAMP NOT NULL DEFAULT NOW(),
|
||||
last_triggered_at TIMESTAMP,
|
||||
last_status_code INTEGER
|
||||
);
|
||||
```
|
||||
|
||||
`last_triggered_at` and `last_status_code` — so user can see if webhooks are actually working from the UI.
|
||||
|
||||
## Server-side architecture
|
||||
|
||||
### Where to fire events
|
||||
|
||||
`TasksManager` is where all task mutations go through. After a successful mutation, call the webhook dispatcher:
|
||||
|
||||
```
|
||||
TasksManager.addTaskNew() → dispatch('task.created', task)
|
||||
TasksManager.updateTask() → dispatch('task.updated', task)
|
||||
TasksManager.deleteTask() → dispatch('task.deleted', { id: taskId })
|
||||
TasksManager.completeTask() → dispatch('task.completed', task)
|
||||
```
|
||||
|
||||
### Dispatcher
|
||||
|
||||
```
|
||||
WebhookDispatcher.dispatch(event, payload, projectId):
|
||||
1. Fetch active webhooks for projectId where events[] contains event
|
||||
2. For each webhook:
|
||||
- Build JSON payload
|
||||
- Sign with HMAC-SHA256 using decrypted secret
|
||||
- POST async (fire-and-forget with .catch())
|
||||
- Update last_triggered_at and last_status_code
|
||||
```
|
||||
|
||||
**Important**: fire-and-forget. Never await webhook delivery in the request path.
|
||||
If the external service is down, the task still gets created instantly.
|
||||
|
||||
### Retries
|
||||
|
||||
Simple retry: 3 attempts with delays of 5s, 30s, 5min.
|
||||
Use `setTimeout` — no need for a job queue at this scale.
|
||||
If all 3 fail, log it and move on. User can see `last_status_code` in the UI.
|
||||
|
||||
No dead letter queue, no persistent retry storage. Keep it simple.
|
||||
If someone needs guaranteed delivery, they should use a proper message broker on their end.
|
||||
|
||||
## Permissions
|
||||
|
||||
Two new permissions (same pattern as integrations):
|
||||
|
||||
- `WEBHOOKS_CAN_MANAGE` — create, edit, delete, toggle webhooks
|
||||
- `WEBHOOKS_CAN_VIEW` — see registered webhooks and their status
|
||||
|
||||
Owner gets both automatically (like all other permissions).
|
||||
|
||||
## UI
|
||||
|
||||
Add a "Webhooks" tab in the integrations panel (or a separate section).
|
||||
|
||||
List view shows:
|
||||
- URL (truncated)
|
||||
- Description
|
||||
- Events (badges)
|
||||
- Status: green dot if last_status_code is 2xx, red if 4xx/5xx, gray if never triggered
|
||||
- Toggle switch (active/inactive)
|
||||
- Delete button
|
||||
|
||||
Add form:
|
||||
- URL input
|
||||
- Event checkboxes
|
||||
- Description input
|
||||
- On save: show the secret once in a modal ("copy this, you won't see it again")
|
||||
|
||||
## Events to support (Phase 1)
|
||||
|
||||
| Event | When |
|
||||
|-------|------|
|
||||
| `task.created` | New task added |
|
||||
| `task.updated` | Task title, note, deadline, priority, status, list changed |
|
||||
| `task.completed` | Task marked as complete or reopened |
|
||||
| `task.deleted` | Task deleted |
|
||||
|
||||
Phase 2 (later): `list.created`, `list.deleted`, `member.added`, `member.removed`
|
||||
|
||||
## What this does NOT cover
|
||||
|
||||
- **Incoming API** — external services calling TaskView to create/update tasks. That's a separate feature with API keys and rate limiting.
|
||||
- **Custom fields** — separate RFC, much bigger scope.
|
||||
- **Plugin UI** — separate RFC, needs sandboxing and component API.
|
||||
- **Real-time / WebSocket** — separate feature, different use case.
|
||||
|
||||
## Example integrations
|
||||
|
||||
### Slack notification
|
||||
Register webhook for `task.created`. Consumer receives payload, formats a Slack message, posts to Slack API.
|
||||
5 lines of code in any language.
|
||||
|
||||
### Zapier
|
||||
Register webhook URL from Zapier's "Catch Hook" trigger. Zapier handles the rest — send to Google Sheets, email, whatever.
|
||||
Zero code.
|
||||
|
||||
### Custom monitoring
|
||||
Register webhook for `task.completed`. Consumer checks if task has "incident" tag, updates status page.
|
||||
Small Python/Node script.
|
||||
Reference in New Issue
Block a user