# OpenReplay Docs

> Comprehensive documentation for OpenReplay, an open-source, self-hosted session replay, co-browsing and product analytics platform for debugging and understanding web and mobile applications. This extended reference lists all major documentation pages with in-depth descriptions covering deployment, SDKs, session replay, product analytics, AI features, plugins, integrations, API, configuration, and troubleshooting.

## About OpenReplay

OpenReplay is a session replay, co-browsing and product analytics stack that records user sessions in web, iOS, Android, and React Native apps so engineering and product teams can reproduce bugs, debug errors, analyze user behavior, and co-browse with users in real time. Unlike closed-source alternatives, OpenReplay can be deployed entirely on your own infrastructure under Elastic License 2.0, keeping session data inside your security perimeter. A managed cloud offering is also available at openreplay.com. Capabilities span session recording, DevTools-grade network/console/state capture, product analytics (funnels, heatmaps, journeys, dashboards, web analytics, monitors), co-browsing and live assist, a Chrome-based bug-capture extension called Spot, and AI features that explain errors and summarize sessions.

## Getting Started

- [Home](https://docs.openreplay.com/en/home/): Top-level documentation landing page with cards linking to every major section — deployment, SDK setup, session replay, product analytics, integrations, troubleshooting, and API reference. Use this page as the navigational index when orienting a new user or AI agent to the OpenReplay docs surface.
- [Getting Started](https://docs.openreplay.com/en/getting-started/): End-to-end onboarding guide walking through the full setup path: choosing between Cloud and self-hosted, deploying an instance (AWS/Azure/GCP/K8s/Docker), adding the tracker SDK to a React/Vue/Angular/Svelte app, identifying users, and enabling key plugins. Covers the first ~30 minutes of using OpenReplay and points into deeper docs for each step.
- [Installation How-Tos](https://docs.openreplay.com/en/installation/): Task-oriented index of install and instrumentation how-tos, grouped by intent: tracker setup, user identification, custom events, data privacy/sanitization, sourcemap upload, error tracking, and framework-specific integration. Serves as a lookup page when you already know what outcome you want.

## Deployment (Self-Hosted)

- [Deployment Overview](https://docs.openreplay.com/en/deployment/): Index of all supported deployment targets with infrastructure prerequisites and architectural notes. Supported: AWS EC2, Microsoft Azure, Google Cloud Platform, DigitalOcean, Scaleway, OVHCloud, Ubuntu bare metal, Kubernetes (Helm), and Docker. Baseline infra requirement is 2 vCPU / 8 GB RAM / 50 GB storage per instance.
- [Deploy to AWS](https://docs.openreplay.com/en/deployment/deploy-aws/): EC2 deployment walkthrough covering instance sizing, SSL/TLS certificate setup via Let's Encrypt, load balancer configuration, and security group rules. Explicitly calls out the 2 vCPU / 8 GB RAM / 50 GB storage minimum and points to `openreplay-cli` for post-deploy admin tasks.
- [Deploy to Azure](https://docs.openreplay.com/en/deployment/deploy-azure/): Azure virtual machine deployment instructions with network security group, storage, and certificate guidance for a single-VM OpenReplay instance.
- [Deploy to GCP](https://docs.openreplay.com/en/deployment/deploy-gcp/): Compute Engine instance setup, firewall rules, and domain/SSL configuration for running OpenReplay on Google Cloud Platform.
- [Deploy to DigitalOcean](https://docs.openreplay.com/en/deployment/deploy-digitalocean/): Droplet-based deployment guide with recommended droplet size, DNS and SSL configuration.
- [Deploy to Scaleway](https://docs.openreplay.com/en/deployment/deploy-scaleway/): Instance deployment on Scaleway cloud with configuration tailored to Scaleway's networking model.
- [Deploy to OVHcloud](https://docs.openreplay.com/en/deployment/deploy-ovhcloud/): OVHcloud deployment guide for EU-based hosting with compliance and locality considerations.
- [Deploy to Ubuntu](https://docs.openreplay.com/en/deployment/deploy-ubuntu/): Direct install on a Ubuntu host (bare metal or existing VM), suitable for on-prem or non-cloud environments.
- [Deploy to Kubernetes](https://docs.openreplay.com/en/deployment/deploy-kubernetes/): Kubernetes cluster install using the official Helm chart, including StatefulSet, Service, and Ingress configuration plus TLS termination.
- [Deploy with Docker](https://docs.openreplay.com/en/deployment/deploy-docker/): Single-host Docker Compose setup, aimed at local evaluation, internal staging, or lightweight production deployments.
- [Deploy from Source](https://docs.openreplay.com/en/deployment/deploy-source/): Build OpenReplay from its GitHub source for teams that need to audit, patch, or customize the platform before running it.
- [Upgrade Guide](https://docs.openreplay.com/en/deployment/upgrade/): Version-to-version upgrade procedure including pre-upgrade backups, Helm/Docker update steps, and database migration expectations.
- [Upload Sourcemaps](https://docs.openreplay.com/en/deployment/upload-sourcemaps/): How to upload JavaScript sourcemaps so session replays show human-readable stack traces instead of minified bundle lines. Covers build-time upload via CLI and runtime access configuration.
- [Tracker Compatibility](https://docs.openreplay.com/en/deployment/compatibility/): Browser and framework compatibility matrix listing minimum versions for Chrome (41+), Firefox (17+), Edge (12+), Safari (9+), IE (11+), and Opera (28+), plus notes on each JS framework.
- [Deprecated Versions](https://docs.openreplay.com/en/deployment/deprecated-versions/): Reference list of older OpenReplay versions that are no longer supported, with links to still-available version-pinned docs (v1.17 through v1.25).
- [Roles and Access](https://docs.openreplay.com/en/deployment/roles-and-access/): Team role model (Owner, Admin, Member) and page-level / feature-level access control permissions for self-hosted deployments.
- [Invite Team Members](https://docs.openreplay.com/en/deployment/invite-team-members/): Adding users to an OpenReplay instance, assigning roles, and managing team membership.
- [Setup OpenReplay](https://docs.openreplay.com/en/deployment/setup-or/): Post-install configuration walkthrough after the instance is running — creating the first project, getting a project key, and adding the first tracker.
- [OpenReplay Admin](https://docs.openreplay.com/en/deployment/openreplay-admin/): Day-two admin tasks including user management, project management, and system-level settings exposed by the admin UI.

## JavaScript SDK

- [JavaScript SDK Overview](https://docs.openreplay.com/en/sdk/): Overview of the tracker SDK including session initialization, Canvas/WebGL recording, cross-domain iframe tracking, and the relationship between the SDK and optional plugins for state, network, and performance capture.
- [SDK Installation](https://docs.openreplay.com/en/sdk/installation/): Install the tracker via npm/yarn/pnpm or via a drop-in `<script>` snippet, configure the project key, and call `start()` to begin recording.
- [SDK Constructor Options](https://docs.openreplay.com/en/sdk/constructor/): Complete reference for every tracker constructor parameter, grouped into categories: general-purpose (projectKey, ingestPoint, sessionToken, captureMethod), stylesheets (capturing CSS and emotion-js), privacy (obscureTextEmails, obscureTextNumbers, defaultInputMode), console (capture levels, throttling), exceptions (stack-trace capture), performance (FPS/CPU/memory), network (payload capture and sanitization), canvas (recording rate and scale), and security (`__DISABLE_SECURE_MODE` for localhost testing).
- [SDK Methods](https://docs.openreplay.com/en/sdk/methods/): Index of every tracker instance method — start, stop, event, setUserID, setMetadata, getSessionID, getSessionURL, and others — with argument and return-value details.
- [SDK Method: start()](https://docs.openreplay.com/en/sdk/methods/start/): Begin session recording; supports options for userID, metadata, and force-starting.
- [SDK Method: stop()](https://docs.openreplay.com/en/sdk/methods/stop/): Halt recording and flush the current session.
- [SDK Method: event()](https://docs.openreplay.com/en/sdk/methods/event/): Emit a custom functional event tied to the current session for funnel and trend analysis.
- [SDK Method: issue()](https://docs.openreplay.com/en/sdk/methods/issue/): Mark a technical issue on the current session for error-focused workflows.
- [SDK Method: incident()](https://docs.openreplay.com/en/sdk/methods/incident/): Report an incident tied to the session, escalating beyond a standard issue.
- [SDK Method: handleError()](https://docs.openreplay.com/en/sdk/methods/handle-error/): Explicitly capture a caught error into the session timeline.
- [SDK Method: setUserID()](https://docs.openreplay.com/en/sdk/methods/set-user-id/): Associate the current session with a known user identifier so sessions are searchable by user.
- [SDK Method: setUserAnonymousID()](https://docs.openreplay.com/en/sdk/methods/set-user-anonymous-id/): Assign a stable anonymous ID when the user has not logged in.
- [SDK Method: setMetadata()](https://docs.openreplay.com/en/sdk/methods/set-metadata/): Attach up to 10 custom key-value pairs per project to the session for filtering in Omnisearch.
- [SDK Method: getSessionID()](https://docs.openreplay.com/en/sdk/methods/get-session-id/): Read the current session's unique identifier, useful for correlating with backend logs.
- [SDK Method: getSessionURL()](https://docs.openreplay.com/en/sdk/methods/get-session-url/): Return the shareable URL of the current replay, useful for attaching to bug reports.
- [SDK Method: getSessionToken()](https://docs.openreplay.com/en/sdk/methods/get-session-token/): Obtain the session token for secure backend integrations.
- [SDK Method: isActive()](https://docs.openreplay.com/en/sdk/methods/is-active/): Check whether recording is currently in progress.
- [SDK Method: coldStart()](https://docs.openreplay.com/en/sdk/methods/cold-start/): Initialize the tracker without immediately starting a session, deferring `start()` until later.
- [SDK Method: forceFlushBatch()](https://docs.openreplay.com/en/sdk/methods/force-flush-batch/): Force an immediate upload of buffered events rather than waiting for the batch interval.
- [SDK Method: startOfflineRecording()](https://docs.openreplay.com/en/sdk/methods/start-offline-recording/): Begin recording when the device is offline; events are stored locally until connectivity returns.
- [SDK Method: uploadOfflineRecording()](https://docs.openreplay.com/en/sdk/methods/upload-offline-recording/): Flush a previously-captured offline recording to the server once online.
- [SDK Method: trackWs()](https://docs.openreplay.com/en/sdk/methods/track-ws/): Opt-in WebSocket channel tracking that surfaces socket traffic in the replay DevTools.
- [Using OpenReplay: React](https://docs.openreplay.com/en/sdk/using-or/react/): React-specific integration pattern including where to mount `tracker.start()`, handling React Router navigation, and guidance for functional vs. class components.
- [Using OpenReplay: Next.js](https://docs.openreplay.com/en/sdk/using-or/next/): Next.js setup including `_app.tsx` integration, avoiding SSR-only execution, and the `Navigator is not defined` error fix for server components.
- [Using OpenReplay: Angular](https://docs.openreplay.com/en/sdk/using-or/angular/): Angular integration via `APP_INITIALIZER`, module registration, and router event handling for SPA navigation.
- [Using OpenReplay: Vue](https://docs.openreplay.com/en/sdk/using-or/vue/): Vue integration pattern covering `main.ts`/`main.js` setup and Vue Router compatibility.
- [Using OpenReplay: Nuxt](https://docs.openreplay.com/en/sdk/using-or/nuxt/): Nuxt-specific setup handling universal rendering and client-only plugin registration.
- [Using OpenReplay: Svelte](https://docs.openreplay.com/en/sdk/using-or/svelte/): Svelte and SvelteKit integration with setup snippets for the app entry point.
- [Using OpenReplay: Gatsby](https://docs.openreplay.com/en/sdk/using-or/gatsby/): Gatsby integration with guidance on `gatsby-browser.js` hooks and avoiding SSR-only code paths.
- [Using OpenReplay: Remix](https://docs.openreplay.com/en/sdk/using-or/remix/): Remix integration pattern for client-side tracker mounting under Remix's loader/action model.
- [Using OpenReplay: Electron](https://docs.openreplay.com/en/sdk/using-or/electron/): Desktop Electron app integration including renderer-process setup and handling Electron's security model.
- [Using OpenReplay: JavaScript Snippet](https://docs.openreplay.com/en/sdk/using-or/snippet/): Drop-in `<script>` snippet install placed inside `<head>` for apps without npm tooling or vanilla-JS projects.
- [Data Sanitization](https://docs.openreplay.com/en/sdk/sanitize-data/): Redact sensitive DOM content (emails, inputs, custom selectors) and network payloads at capture time before data leaves the browser. Covers CSS-selector masks, input default modes, and network body sanitization.
- [Network Options](https://docs.openreplay.com/en/sdk/network-options/): Configure which network requests are captured, how much of the request/response body is stored, and which headers/URL patterns are sanitized.
- [Private Mode](https://docs.openreplay.com/en/sdk/private-mode/): Enable private mode to mask all user input and DOM text by default, for high-sensitivity environments like healthcare, banking, or legal.
- [SDK Analytics](https://docs.openreplay.com/en/sdk/analytics/): Analytics-specific tracker surface area including event emission and people/user property tracking.
- [SDK Analytics — Events](https://docs.openreplay.com/en/sdk/analytics/events/): Emit analytics events and attach event properties for funnel and trend analysis.
- [SDK Analytics — People](https://docs.openreplay.com/en/sdk/analytics/people/): Attach user-level properties to identify cohorts and filter analytics views.

## Session Replay

- [Session Replay Overview](https://docs.openreplay.com/en/session-replay/): Core session replay capability — how sessions are recorded and played back with DOM fidelity, alongside DevTools panels for network, console, state, and performance.
- [Identify User](https://docs.openreplay.com/en/session-replay/identify-user/): Associate sessions with logged-in users via `tracker.setUserID()` or tracker init options, with examples for NPM, JS snippet, and iOS SDK. Lets you search sessions by email or internal user ID.
- [Metadata](https://docs.openreplay.com/en/session-replay/metadata/): Attach up to 10 custom key-value pairs per project to sessions (plan, tenantId, experiment ID) and filter recordings by metadata in Omnisearch. Supports all SDKs.
- [Omnisearch](https://docs.openreplay.com/en/session-replay/omnisearch/): Unified search across sessions by user ID, events, metadata, errors, and URL patterns — the primary way to find relevant replays quickly.
- [Highlights](https://docs.openreplay.com/en/session-replay/highlights/): Clip and save meaningful portions of a session as reusable highlights; used to share specific UX moments with product and design teams.
- [Canvas and WebGL Recording](https://docs.openreplay.com/en/session-replay/canvas/): Capture `<canvas>` and WebGL content so replays preserve complex visuals, games, charts, and animations. Configurable recording rate and scale.
- [Cross-domain iFrames](https://docs.openreplay.com/en/session-replay/crossdomain-iframe/): Track user activity across embedded iframes on different domains, a common pattern for checkout flows and embedded widgets.
- [WebSockets](https://docs.openreplay.com/en/session-replay/websockets/): Record WebSocket messages and display them in the replay's network/DevTools panel alongside HTTP traffic.
- [Error Reporting](https://docs.openreplay.com/en/session-replay/error-reporting/): Surface frontend and backend errors inside the session timeline so developers can correlate errors to exact user actions.
- [Generate E2E Test from Session](https://docs.openreplay.com/en/session-replay/generate-e2e-test/): Convert a recorded user journey into an automated E2E test script for Cypress, Playwright, or Puppeteer — useful for turning real bug reproductions into regression tests.

## Product Analytics

- [Product Analytics Overview](https://docs.openreplay.com/en/product-analytics/): Overview of the product analytics suite — trends, funnels, journeys, heatmaps, dashboards, web analytics, and monitors — all driven by session events captured by the tracker.
- [Trends](https://docs.openreplay.com/en/product-analytics/trends/): Track key metrics (events, errors, performance) over time to monitor how user behavior evolves. Supports grouping by user, page, or event property.
- [Funnels](https://docs.openreplay.com/en/product-analytics/funnels/): Multi-step conversion funnel analysis with drop-off percentages between each step; click any drop-off to jump to actual sessions of users who abandoned.
- [Heatmaps](https://docs.openreplay.com/en/product-analytics/heatmaps/): Click, scroll, and dwell heatmaps showing engagement hotspots on any page, generated from real session data (not sampled).
- [Journeys](https://docs.openreplay.com/en/product-analytics/journeys/): Sankey-style user-flow visualization showing how users navigate between pages, with the ability to filter by segment or entry point.
- [Dashboards](https://docs.openreplay.com/en/product-analytics/dashboards/): Custom dashboard builder composing trends, funnels, and monitors into team-specific views for product, engineering, and exec audiences.
- [Web Analytics](https://docs.openreplay.com/en/product-analytics/web-analytics/): Traffic-level analytics (visitors, pageviews, referrers, devices, geographies) derived from session data — removes the need for a separate GA/Plausible.
- [Monitors](https://docs.openreplay.com/en/product-analytics/monitors/): Anomaly and threshold monitors on errors, performance regressions, or funnel drops with alerts routed to Slack, MS Teams, email, or webhooks.
- [Custom Events](https://docs.openreplay.com/en/product-analytics/custom-events/): Send functional events via `tracker.event()` and technical events via `tracker.issue()` from NPM, JS snippet, or iOS SDK, then use them in funnels, trends, and alerts.
- [Data Management](https://docs.openreplay.com/en/product-analytics/data-management/): UI surface for managing custom events, user properties, and analytics taxonomy — lets product teams rename and organize events without code changes.

## AI Features

- [AI Overview](https://docs.openreplay.com/en/ai/): Landing page for OpenReplay's AI-assisted debugging and triage capabilities: Explain AI, Similar Sessions, and Summary AI. All three reduce manual investigation time by operating on captured session data.
- [Explain AI](https://docs.openreplay.com/en/ai/explain-ai/): Inside a session's DevTools, Explain AI analyzes network requests and console errors and produces a plain-language explanation of what went wrong, aimed at engineers debugging a specific incident.
- [Similar Sessions](https://docs.openreplay.com/en/ai/similar-sessions/): Uses AI embedding models to find session replays whose behavioral signature resembles the one currently being watched. One click from a session surfaces related cases for pattern-finding and bug triage.
- [Summary AI](https://docs.openreplay.com/en/ai/summary-ai/): Generates a short written summary of each session — key interactions, errors, user intent — so analysts can skim sessions without watching full recordings.

## Spot (Bug Capture Extension)

- [Spot](https://docs.openreplay.com/en/spot/): OpenReplay Spot is a Chrome extension for fast bug reporting. Users record the broken flow directly in the browser; Spot captures the video, console logs, network requests and responses, user agent, and automatically flags GraphQL errors (marks them with a 400-equivalent status). Recordings can be shared as private or public links, and the extension works across Chromium browsers (Chrome, Edge, Brave, Arc). Included in all OpenReplay pricing tiers.

## Mobile SDKs

- [iOS SDK (Beta)](https://docs.openreplay.com/en/ios-sdk/): Native iOS session recording SDK with Swift integration and an init → recording → events → upload lifecycle.
- [iOS SDK: Init](https://docs.openreplay.com/en/ios-sdk/init/): Initialize the iOS tracker with project key and options.
- [iOS SDK: Analytics](https://docs.openreplay.com/en/ios-sdk/analytics/): Emit analytics events from iOS apps.
- [iOS SDK: Inputs](https://docs.openreplay.com/en/ios-sdk/inputs/): Capture and mask input-field data in iOS screens.
- [iOS SDK: Methods](https://docs.openreplay.com/en/ios-sdk/methods/): Full iOS tracker method reference.
- [iOS SDK: Methods — start()](https://docs.openreplay.com/en/ios-sdk/methods/start/): Begin iOS session recording.
- [iOS SDK: Methods — stop()](https://docs.openreplay.com/en/ios-sdk/methods/stop/): Halt iOS recording.
- [iOS SDK: Methods — event()](https://docs.openreplay.com/en/ios-sdk/methods/event/): Emit a custom iOS event.
- [iOS SDK: Methods — setMetadata()](https://docs.openreplay.com/en/ios-sdk/methods/set-metadata/): Attach metadata on iOS sessions.
- [iOS SDK: Methods — setUserID()](https://docs.openreplay.com/en/ios-sdk/methods/set-user-id/): Identify the current iOS user.
- [iOS SDK: Methods — userAnonymousID()](https://docs.openreplay.com/en/ios-sdk/methods/user-anonymous-id/): Assign a stable anonymous ID on iOS.
- [iOS SDK: Modules](https://docs.openreplay.com/en/ios-sdk/modules/): Enable optional modules (network, analytics, crash) per iOS app.
- [iOS SDK: Network](https://docs.openreplay.com/en/ios-sdk/network/): Capture iOS network requests via URLSession hooks.
- [iOS SDK: Sanitization](https://docs.openreplay.com/en/ios-sdk/sanitization/): Mask sensitive iOS view content and network payloads.
- [Android SDK (Beta)](https://docs.openreplay.com/en/android-sdk/): Native Android session recording SDK with Kotlin/Java integration.
- [Android SDK: Init](https://docs.openreplay.com/en/android-sdk/init/): Initialize the Android tracker.
- [Android SDK: Analytics](https://docs.openreplay.com/en/android-sdk/analytics/): Emit Android analytics events.
- [Android SDK: Inputs](https://docs.openreplay.com/en/android-sdk/inputs/): Capture and mask Android input data.
- [Android SDK: Methods](https://docs.openreplay.com/en/android-sdk/methods/): Full Android tracker method reference.
- [Android SDK: Methods — start()](https://docs.openreplay.com/en/android-sdk/methods/start/): Begin Android session recording.
- [Android SDK: Methods — event()](https://docs.openreplay.com/en/android-sdk/methods/event/): Emit a custom Android event.
- [Android SDK: Methods — setMetadata()](https://docs.openreplay.com/en/android-sdk/methods/set-metadata/): Attach metadata on Android sessions.
- [Android SDK: Methods — setUserID()](https://docs.openreplay.com/en/android-sdk/methods/set-user-id/): Identify the current Android user.
- [Android SDK: Methods — userAnonymousID()](https://docs.openreplay.com/en/android-sdk/methods/user-anonymous-id/): Assign a stable anonymous ID on Android.
- [Android SDK: Modules](https://docs.openreplay.com/en/android-sdk/modules/): Optional Android modules for network, analytics, and crash capture.
- [Android SDK: Network](https://docs.openreplay.com/en/android-sdk/network/): Capture Android network traffic (OkHttp, Retrofit).
- [Android SDK: Sanitization](https://docs.openreplay.com/en/android-sdk/sanitization/): Mask Android view content and network payloads.
- [React Native SDK (Beta)](https://docs.openreplay.com/en/rn-sdk/): Cross-platform React Native SDK sharing the public API surface of the iOS and Android SDKs.
- [React Native SDK: Init](https://docs.openreplay.com/en/rn-sdk/init/): Initialize the RN tracker.
- [React Native SDK: Analytics](https://docs.openreplay.com/en/rn-sdk/analytics/): Emit analytics events from React Native.
- [React Native SDK: Inputs](https://docs.openreplay.com/en/rn-sdk/inputs/): Capture and mask RN TextInput content.
- [React Native SDK: Methods](https://docs.openreplay.com/en/rn-sdk/methods/): Full RN tracker method reference.
- [React Native SDK: Methods — start()](https://docs.openreplay.com/en/rn-sdk/methods/start/): Begin RN session recording.
- [React Native SDK: Methods — event()](https://docs.openreplay.com/en/rn-sdk/methods/event/): Emit a custom RN event.
- [React Native SDK: Methods — setMetadata()](https://docs.openreplay.com/en/rn-sdk/methods/set-metadata/): Attach metadata to RN sessions.
- [React Native SDK: Methods — setUserID()](https://docs.openreplay.com/en/rn-sdk/methods/set-user-id/): Identify the current RN user.
- [React Native SDK: Methods — userAnonymousID()](https://docs.openreplay.com/en/rn-sdk/methods/user-anonymous-id/): Assign a stable anonymous ID on RN.
- [React Native SDK: Methods — patchNetwork()](https://docs.openreplay.com/en/rn-sdk/methods/patch-network/): Monkey-patch fetch/XHR in React Native to capture HTTP traffic.
- [React Native SDK: Modules](https://docs.openreplay.com/en/rn-sdk/modules/): Optional RN modules for network, analytics, and crash capture.
- [React Native SDK: Network](https://docs.openreplay.com/en/rn-sdk/network/): Capture network traffic in React Native apps.
- [React Native SDK: Sanitization](https://docs.openreplay.com/en/rn-sdk/sanitization/): Mask RN view content and network payloads.

## Co-Browsing and Live Assist

- [Co-Browsing](https://docs.openreplay.com/en/co-browsing/): Real-time user assistance feature enabling support/CS operators to watch a live session, take control of the user's cursor (with permission), annotate the screen, start a voice/video call, and view the live console. Powered by WebRTC via the Assist plugin.

## Plugins

- [Plugins Overview](https://docs.openreplay.com/en/plugins/): Optional tracker plugins that add capture for state management, network libraries, performance, and live assist. Plugins install as peer packages and attach to the tracker instance.
- [Assist Plugin](https://docs.openreplay.com/en/plugins/assist/): Enables real-time co-browsing, live screen sharing, and WebRTC-powered voice/video communication between an operator and an end user.
- [Axios Plugin](https://docs.openreplay.com/en/plugins/axios/): Captures Axios (XHR-based) requests and responses into the replay's network panel.
- [Fetch Plugin](https://docs.openreplay.com/en/plugins/fetch/): Captures `fetch()` API calls with request and response bodies.
- [GraphQL Plugin](https://docs.openreplay.com/en/plugins/graphql/): Monitors GraphQL queries and mutations — supports both Apollo and Relay clients — and captures operation name, variables, and response.
- [MobX Plugin](https://docs.openreplay.com/en/plugins/mobx/): Captures MobX store state changes alongside session events.
- [NgRx Plugin](https://docs.openreplay.com/en/plugins/ngrx/): Records state and actions from Angular NgRx stores.
- [Pinia Plugin](https://docs.openreplay.com/en/plugins/pinia/): Monitors Pinia store state in Vue applications.
- [Profiler Plugin](https://docs.openreplay.com/en/plugins/profiler/): Tracks the runtime performance of wrapped JavaScript functions so slow calls surface in the replay's performance panel.
- [Redux Plugin](https://docs.openreplay.com/en/plugins/redux/): Captures Redux store state and dispatched actions for step-by-step state debugging during replay.
- [VueX Plugin](https://docs.openreplay.com/en/plugins/vuex/): Records VueX store mutations and actions for Vue 2/3 apps using VueX.
- [Zustand Plugin](https://docs.openreplay.com/en/plugins/zustand/): Monitors Zustand store state changes in React apps.

## Integrations

- [Integrations Overview](https://docs.openreplay.com/en/integrations/): Catalog of integrations grouped by purpose — sync backend logs with sessions (Datadog, Sentry, Elastic, Dynatrace, Bugsnag, New Relic, Rollbar, CloudWatch, Stackdriver, Sumo Logic), ticketing (Jira, GitHub, Zendesk), messaging (Slack, MS Teams), CDP (Segment, Google Tag Manager).
- [Sentry Integration](https://docs.openreplay.com/en/integrations/sentry/): Link Sentry issues to the matching session replay for full front-end context on each error event.
- [Datadog Integration](https://docs.openreplay.com/en/integrations/datadog/): Sync Datadog backend logs and APM traces with the corresponding OpenReplay session for unified full-stack debugging.
- [Elastic Integration](https://docs.openreplay.com/en/integrations/elastic/): Pull Elasticsearch/ELK backend logs and attach them to session replays.
- [Dynatrace Integration](https://docs.openreplay.com/en/integrations/dynatrace/): Connect Dynatrace APM observability with OpenReplay session data.
- [Jira Integration](https://docs.openreplay.com/en/integrations/jira/): Create Jira issues directly from session replays with the session URL and context attached.
- [GitHub Integration](https://docs.openreplay.com/en/integrations/github/): Submit bug reports as GitHub Issues with session context, for open-source and GitHub-first engineering teams.
- [Zendesk Integration](https://docs.openreplay.com/en/integrations/zendesk/): Create and update Zendesk support tickets from session replays for customer support workflows.
- [Slack Integration](https://docs.openreplay.com/en/integrations/slack/): Share session replay links and route alerts/monitors into Slack channels.
- [Microsoft Teams Integration](https://docs.openreplay.com/en/integrations/msteams/): Deliver issue notifications and alerts to Microsoft Teams workspaces.
- [Google Tag Manager Integration](https://docs.openreplay.com/en/integrations/google-tag-manager/): Install the OpenReplay tracker via GTM without code deployment.

## API

- [API Overview](https://docs.openreplay.com/en/api/): REST API reference covering projects, sessions, events, users, jobs, and live assist access. Use for programmatic session retrieval, event search, and automation.
- [Projects API](https://docs.openreplay.com/en/api/projects/): CRUD endpoints for projects and project keys.
- [Sessions API](https://docs.openreplay.com/en/api/sessions/): Query recorded sessions by filter, retrieve session metadata and replay URLs.
- [Events API](https://docs.openreplay.com/en/api/events/): Pull captured event data (clicks, navigation, custom events, errors) from sessions.
- [Users API](https://docs.openreplay.com/en/api/users/): Query users and their session history.
- [Jobs API](https://docs.openreplay.com/en/api/jobs/): Background processing jobs including exports.
- [Assist API](https://docs.openreplay.com/en/api/assist/): Programmatic access to live assist sessions and co-browsing controls.

## Configuration (Self-Hosted Administration)

- [Configuration Overview](https://docs.openreplay.com/en/configuration/): Administration index covering SMTP, SSL, proxy, storage, external databases, and SSO for a self-hosted OpenReplay instance.
- [Configure SMTP](https://docs.openreplay.com/en/configuration/configure-smtp/): Set SMTP credentials so OpenReplay can send team invites, alerts, and notifications.
- [Secure OpenReplay](https://docs.openreplay.com/en/configuration/secure-or/): Harden the instance with TLS, secret rotation, and recommended network/IAM configuration.
- [Proxy Settings](https://docs.openreplay.com/en/configuration/proxy-settings/): Configure outbound proxy for air-gapped or restricted-network environments.
- [Cleanup Storage](https://docs.openreplay.com/en/configuration/cleanup-storage/): Configure storage retention policies and manual cleanup of session data.
- [External Storage](https://docs.openreplay.com/en/configuration/external-storage/): Connect external object storage — AWS S3, Google Cloud Storage, or S3-compatible — for session recording assets instead of local storage.
- [External Database](https://docs.openreplay.com/en/configuration/external-db/): Point OpenReplay at an external PostgreSQL instance for production reliability and backups.
- [SSO Setup](https://docs.openreplay.com/en/configuration/sso/): Configure Single Sign-On (SAML, OIDC) for enterprise authentication of an OpenReplay instance.

## Tutorials

- [Tutorial: Assist](https://docs.openreplay.com/en/tutorials/assist/): Walkthrough for live user support via Assist — operators watch sessions in real time and, with permission, take cursor control to guide users through flows.
- [Tutorial: Build Plugins](https://docs.openreplay.com/en/tutorials/build-plugins/): How to author a custom tracker plugin that hooks into the SDK lifecycle and captures domain-specific data.
- [Tutorial: Capture Request](https://docs.openreplay.com/en/tutorials/capture-request/): Technique for intercepting and capturing arbitrary HTTP requests beyond what the built-in fetch/axios plugins cover.
- [Tutorial: Custom Events](https://docs.openreplay.com/en/tutorials/custom-events/): Emit custom functional events from application code and use them in funnels and trends.
- [Tutorial: Custom Heuristics](https://docs.openreplay.com/en/tutorials/custom-heuristics/): Build custom error/issue-detection heuristics that auto-flag sessions matching business-specific failure patterns.
- [Tutorial: GraphQL](https://docs.openreplay.com/en/tutorials/graphql/): End-to-end GraphQL integration including the GraphQL plugin, operation naming, and Apollo/Relay specifics.
- [Tutorial: Metadata](https://docs.openreplay.com/en/tutorials/metadata/): Practical patterns for attaching metadata (plan, tenant, experiment) and using it to segment sessions.
- [Tutorial: Pinia](https://docs.openreplay.com/en/tutorials/pinia/): Setup walkthrough for the Pinia store plugin in Vue apps.
- [Tutorial: Redux](https://docs.openreplay.com/en/tutorials/redux/): Setup walkthrough for the Redux store plugin and capturing action/state diffs.
- [Tutorial: VueX](https://docs.openreplay.com/en/tutorials/vuex/): Setup walkthrough for the VueX store plugin in Vue 2/3.
- [Tutorial: Zustand](https://docs.openreplay.com/en/tutorials/zustand/): Setup walkthrough for the Zustand store plugin in React.

## Troubleshooting

- [Troubleshooting Overview](https://docs.openreplay.com/en/troubleshooting/): Hub page linking to every common-issue guide below.
- [Session Recording Issues](https://docs.openreplay.com/en/troubleshooting/session-recordings/): Fixes for replays not appearing, missing styles, blank screens, missing images, iframe/subdomain problems, and incomplete recordings on non-SPA sites.
- [JavaScript Errors](https://docs.openreplay.com/en/troubleshooting/js-errors/): Solutions for common tracker integration errors: ES module require failures in SSR, `Navigator is not defined`, dependency warnings, cross-origin iframe exceptions.
- [Content Security Policy (CSP)](https://docs.openreplay.com/en/troubleshooting/csp/): Required CSP directives — worker-src, script-src — for OpenReplay Cloud and self-hosted instances, with Safari compatibility notes.
- [Sourcemaps Issues](https://docs.openreplay.com/en/troubleshooting/sourcemaps/): Fix inaccessible source maps by adding CORS headers or uploading them directly to OpenReplay.
- [Localhost Testing](https://docs.openreplay.com/en/troubleshooting/localhost/): How to test OpenReplay locally using `inlineCss` and `__DISABLE_SECURE_MODE` when HTTPS is unavailable in development.
- [Deployment Issues](https://docs.openreplay.com/en/troubleshooting/deployment-issues/): Fixes for self-hosted deployment problems: Helm operation conflicts, SSL certificate failures, PostgreSQL cleanup delays, kubectl auth errors.
- [Supported Browsers](https://docs.openreplay.com/en/troubleshooting/supported-browsers/): Browser compatibility matrix with minimum versions (Chrome 41+, Firefox 17+, Edge 12+, Safari 9+, IE 11+, Opera 28+).
- [Clear Cache](https://docs.openreplay.com/en/troubleshooting/cache/): Clear cached stylesheets, icons, and fonts from the Minio `sessions-assets` bucket via kubectl.
- [Network Resources](https://docs.openreplay.com/en/troubleshooting/network-resources/): Fix zero-value Resource Timing data by configuring the `Timing-Allow-Origin` header for cross-origin resources.

## Other

- [OpenReplay CLI](https://docs.openreplay.com/en/cli/): Command-line tool (`openreplay-cli`) for managing installations and operations — sourcemap upload, user admin, backups, and project lifecycle tasks.
- [Structure](https://docs.openreplay.com/en/structure/): Documentation covering OpenReplay's internal data structure and exported formats.
- [Exported Data](https://docs.openreplay.com/en/structure/exported-data/): Reference for the structure of session data exported from OpenReplay for offline processing or compliance.

## Key Facts

- Product category: open-source session replay, co-browsing and product analytics platform.
- Key differentiator: OpenReplay can be self-hosted for complete control over data security and privacy.
- License / source: AGPLv2. Source code at https://github.com/openreplay/openreplay.
- Deployment options: (1) fully self-hosted on your own infrastructure (AWS, Azure, GCP, DigitalOcean, Scaleway, OVHcloud, Ubuntu, Kubernetes, Docker, or source build); (2) managed OpenReplay Cloud at openreplay.com.
- Minimum self-hosted infrastructure: 2 vCPU, 8 GB RAM, 50 GB storage per instance.
- Client SDKs: JavaScript (frameworks: React, Next.js, Angular, Vue, Nuxt, Svelte, Gatsby, Remix, Electron, vanilla snippet), iOS (Swift, beta), Android (Kotlin/Java, beta), React Native (beta).
- Core capabilities: session replay with DOM fidelity; DevTools-grade network/console/state capture; product analytics (trends, funnels, heatmaps, journeys, dashboards, web analytics, monitors); co-browsing; Spot Chrome extension for bug capture; session-to-E2E test generation.
- Data privacy: all text and input masking configurable at capture time; per-field sanitization; private mode masks everything by default; data stays in the self-hosted instance.
- Key integrations: Sentry, Datadog, Elastic, Dynatrace, Jira, GitHub, Zendesk, Slack, Microsoft Teams, Google Tag Manager.

## Contact and Further Resources

- Documentation: https://docs.openreplay.com
- Marketing site: https://openreplay.com
- Pricing: https://openreplay.com/pricing
- GitHub (source, issues, community): https://github.com/openreplay/openreplay
- Slack community: https://slack.openreplay.com