Quickstart
Run temetro on your own computer in about five minutes.
This guide gets a complete temetro installation — the app, the server, and the database — running on one computer. You don't need to be a programmer; you just need to be comfortable copying a few commands into a terminal.
Before you begin
You need two things installed:
- Docker Desktop — runs temetro's three parts (app, server, database) in one step. Install it and make sure it is running.
- Git — downloads the temetro code.
Install and run
Download temetro
Open a terminal (on a Mac: the Terminal app) and run:
git clone https://github.com/temetro/temetro.git
cd temetro/backendStart everything
docker compose pull # download temetro's prebuilt images
docker compose up # start the app, server, and databaseThat's it — no configuration needed. temetro generates the secret keys it needs on first start and remembers them, so sign-ins stay secure across restarts.
docker compose pull downloads the official prebuilt images from Docker Hub —
the fastest way to start. Prefer to build from the source code instead? Run
docker compose up --build in place of the two commands above.
Want to customize something (your own secret key, email/SMTP, or a different
database port)? Copy the template with cp .env.example .env and edit it before
starting. For example, if port 5432 is already in use, set POSTGRES_PORT=5433.
Anything you don't set is handled for you.
The first start takes a few minutes while Docker downloads everything. When the log output settles down, temetro is running:
| Address | What it is |
|---|---|
| http://localhost:3000 | The temetro app — this is what you use |
| http://localhost:4000 | The API server (used by the app) |
Create your account and clinic
- Open http://localhost:3000 in your browser.
- Click Sign up and create your account.
- You'll be guided through onboarding: give your clinic a name, and you're in.
You are now the owner of your clinic. From here you can add patients, invite staff, and explore the app — the Using temetro guides walk through every screen.
Stopping and restarting
- To stop temetro, press Ctrl+C in the terminal (or run
docker compose downfrom thebackendfolder). - To start it again later, run
docker compose upfrom thebackendfolder. Your data is kept between restarts.
Updating temetro
When a new version is released, update in place from the backend folder:
docker compose pull # download the latest images
docker compose up -d # restart on the new versionYour data is kept, and any database changes are applied automatically on start. temetro also tells you when an update is available — a notice appears in the app, and Settings → About & updates shows the version you're on, the latest release, and the exact update command. Updating is always optional. See Updating for the full details.