Getting started
A local installation with private persistent storage.
Reviewed October 8, 2026. Application version 00.14.01. Security and ChatGPT behavior requires deploying the matching source release; this site is not the task API.
Requirements
Use Docker Engine with the Compose plugin. The supported container runs Python 3.13; the regression workflow also tests Python 3.12. Clone this repository and select the reviewed release or branch. The integration documented here is a source capability, not a claim that an existing deployment has been upgraded.
git clone https://github.com/paulkakell/timeboardapp.git
cd timeboardapp
git switch --detach v00.14.01
cp .env.example .env
# Linux: match the PUID/PGID configured in .env.
sudo install -d -m 700 -o 1000 -g 1000 data
docker compose up -d --build
docker compose exec timeboardapp cat /data/initial-admin-password.txtOpen http://localhost:8888, sign in as admin, and change the generated password in your profile. The first-run password is stored in an owner-only file, not the application logs. After confirming the new password works, remove the initial credential file.
docker compose exec timeboardapp rm /data/initial-admin-password.txtWhat persists
The data directory holds settings, SQLite data, logs, validation reports, and backups. Keep it private. Do not commit it or an .env file. Normal non-admin accounts require an email address; only administrators can create accounts.
Local recovery
An operator with container access can run the command below. It intentionally prints a newly generated password to that operator's terminal. Login attempts no longer create or promote an administrator.
docker compose exec timeboardapp python -m app.cli reset-adminConnect ChatGPT
Native MCP is included in 00.14.01 but stays disabled until you enable it. First configure a public HTTPS application origin, then follow the MCP and OAuth setup guide. The normal task board and existing GPT Actions work without enabling MCP. No OpenAI API key is required for the MCP server.
Development
python -m venv .venv
. .venv/bin/activate
pip install --require-hashes -r requirements.txt -r requirements-dev.txt
# Set TIMEBOARDAPP_SETTINGS to a writable file with a local database.path.
python -m pytest -q
python scripts/sync_docs.py --checkSee deployment and migration before updating an existing installation.
