Documentation

Everything you need to get OpenLook running — from the first snippet to a production self-hosted deployment.

Quickstart

The fastest path from zero to watching your first replay. Total time: about two minutes.

1. Create a workspace and copy your project key (starts with ol_pk_).
2. Add the tracker snippet or install the npm package below.
3. Open your site, click around — the session appears in the dashboard in real time.

Installation

Script tag

<!-- before </head> -->
<script>
  window.openlook=window.openlook||function(){(openlook.q=openlook.q||[]).push(arguments)};
  openlook('init', 'ol_pk_9f3a1c');
</script>
<script async src="https://cdn.openlook.dev/v2/openlook.js"></script>

npm

# any framework
npm install @openlook/tracker

# or use the guided init
npx @openlook/init

import OpenLook from '@openlook/tracker';

OpenLook.init('ol_pk_9f3a1c', {
  maskAllInputs: true,
  performance: true,       // web vitals
  networkCapture: true,     // fetch/xhr bodies
});

Identifying users

Tie a session to a real user so support can pull up the exact replay from a ticket:

OpenLook.identify('user_8412', {
  email: 'jane@acme.com',
  plan: 'growth',
});

Self-hosting

The Community edition ships the full platform under MIT. One compose file gets you ingest, storage, the replay service and the dashboard:

# requires docker + 4GB RAM
curl -fsSL https://get.openlook.dev | sh

cd openlook
docker compose up -d

# dashboard on http://localhost:8080

Production notes: put the ingest behind TLS, mount a persistent volume for ClickHouse, and set OL_RETENTION_DAYS to control disk usage.

Data regions

Cloud workspaces can be pinned to us-east or eu-central at creation time. All session data stays in-region; only account metadata is replicated. Self-hosted deployments have no external dependencies and no telemetry.

JavaScript API

Privacy controls

• maskAllInputs — replace input values with asterisks (default: true)
• maskTextSelector — CSS selector whose text is masked
• data-ol-mask — attribute to mask any element
• data-ol-ignore — attribute to exclude a subtree entirely
• respectDNT — honor Do-Not-Track (default: true)