Skip to content

Installing

The quickest way is Docker. From the repository folder:

Окно терминала
docker compose up -d

The interface opens at http://localhost:3000, the data is kept in the tsmc-data volume. CI publishes the image as ghcr.io/dispbd/tsmc; while the repository is private, it needs docker login ghcr.io. On the first visit TSMC offers to create an administrator. Building the image from source, docker compose, backups and upgrades are in Docker.

Node.js 24 or newer and pnpm are needed:

Окно терминала
pnpm install
pnpm build # the web interface and the CLI
pnpm start # http://127.0.0.1:3000, data in data/tsmc.db
  • To open the server to the network, put a reverse proxy with HTTPS in front of it and set TSMC_SECURE_COOKIES=1 and TSMC_TRUST_PROXY=1 — see Operations.
  • All server settings: Environment variables.
  • Roles and access: Users and access.