Get started
To use Ottertrail, you install an instance, create a project, and add the tracker to your site.
Set up with a coding agent
Section titled “Set up with a coding agent”If you use a coding agent, copy this prompt into it. Replace the two values in angle brackets first:
- Instance URL: the address where you open your Ottertrail dashboard, such as
https://analytics.example.com. - Public key: the key that starts with
pk_. It is in the project’s settings in the dashboard, beside the install snippet.
The prompt tells the agent to read the secret key from the OTTERTRAIL_SECRET_KEY environment variable. The secret key starts with sk_, and it is in the project’s settings too. Set the variable where your servers and your build run. Keep the key out of your repository.
Agents can also read these docs as plain text: /llms.txt lists every page, and /llms-full.txt holds them all in one file.
The agent skill
Section titled “The agent skill”Some coding agents load instructions as a skill. The Ottertrail skill gives the same steps in that format. It is in the skills/ottertrail/ folder of the documentation’s repository. You can install it when that repository is public.
Set up by hand
Section titled “Set up by hand”- Install Ottertrail on a Linux server with Docker Compose.
- Do the first start: create the owner account and download the location data.
- Create a project and add the tracker: allow your site’s hostnames, and add the tracker snippet to your site. The tracker reference lists every option.
- Optional: name signed-in users, report errors, upload source maps, and send telemetry from your servers.