Quick start
Go from nothing to your first visit in about five minutes: install the script, check it with the doctor, and see your first numbers and sources.
:::note
Using trckable Cloud? Start with Get started on Cloud: there is no
server to run, and the host is cloud.trckable.com. This page is for a server
you run yourself.
:::
1. Run the server
The fastest path is Docker. One container, one volume, no database.
docker run -d --name trckable \
-p 8080:8080 \
-v trckable-data:/data \
-e TRCKABLE_BASE_URL=https://stats.example.com \
ghcr.io/trckable/trckable:latestOn the first start it prints a setup URL with a one-time token:
trckable is not set up yet — open this link to create your account
url=https://stats.example.com/setup#token=tkb_setup_...That link works exactly once. Open it, pick an email and a password, and you have an owner account.
Other ways to run it (any host, from source, systemd, behind a reverse proxy) are in Self-hosting.
2. Add your site
In the dashboard, Add site and type the domain. You get a site id and an install snippet.
Several sites to set up? Step 2 of the first-run screen has + Add another site: each site gets a chip with a dot that shows whether it is waiting or receiving, and the first visit on any of them moves you on. Skip for now leaves the setup and opens All sites; trckable remembers it, and the install card is still there when you come back.
3. Put the script on the page
<script
defer
data-site="tkb_a1b2c3d4"
data-domain="example.com"
src="https://stats.example.com/js/tkb_a1b2c3d4.js">
</script>That URL is your site's own script: it carries the features that site's modules turn on, and nothing else.
If your site is a React or Next.js app, the npm package is the more accurate install, because the tracker is bundled into your own code and nothing to block is ever requested:
npm i trckableimport { Analytics } from 'trckable/react'
<Analytics site="tkb_a1b2c3d4" host="https://stats.example.com" />Both are covered properly in Install.
4. Check it
The dashboard shows an install card, waiting for the first visit, until it has seen one. Open your site in another tab; the card says when the visit arrives. After that, Settings → Verify checks from the outside that the snippet is on your homepage.
When the first visit arrives, two short actions wait on the screen: Import your history (what the importer reads and the command that runs it, see Migrating) and Weekly email, a switch. A new site starts with the weekly report and Tracking stopped on when the server can send email; see Alerts.
From a terminal:
npx trckable doctor --host https://stats.example.com --site tkb_a1b2c3d4 --url https://example.comdoctor looks from the outside: whether the server answers over HTTPS, serves
your site's script and accepts a browser's events, and whether the snippet is on
the page.
5. Decide about cookies
This is the one decision worth making on day one, because it changes what the script stores.
- Cookieless mode — nothing is stored in the browser at all. In countries with an analytics exemption (France, Italy, the Netherlands, Spain, the UK) that can let you skip the banner; Germany and Austria still ask for consent. New-versus-returning is only right within a day. More
- A cookie, and ask first — either trckable's own cookie bar, or the consent manager you already run, which trckable reads. A visitor who declines is not counted at all.
- A cookie, no asking — fine in some places, not in others. trckable will not pretend otherwise.
Settings → Data & privacy, and the page writes the privacy paragraph for whichever you pick.
Next
trckable documentation
Documentation for trckable: install the script, read the dashboard, connect revenue, self-host with Docker and use the API. Free, open-source web analytics.
Get started on Cloud
From sign-up to your first visit on trckable Cloud, which runs trckable for you. The host is cloud.trckable.com.