# OpenReplay Docs

> Documentation for OpenReplay, a self-hosted session replay, co-browsing and product analytics platform for debugging web and mobile apps.

## Getting Started

- [Home](https://docs.openreplay.com/en/home/): Documentation homepage with navigation to all major sections and quick links.
- [Getting Started](https://docs.openreplay.com/en/getting-started/): Onboarding guide covering deployment options, SDK setup for React, Vue, Angular, and plugin configuration.
- [Installation How-Tos](https://docs.openreplay.com/en/installation/): Categorized how-to guides for setup, user identification, custom events, data privacy, and error tracking.

## Deployment

- [Deployment Overview](https://docs.openreplay.com/en/deployment/): Step-by-step deployment tutorials for AWS, Azure, GCP, DigitalOcean, Scaleway, OVHCloud, Ubuntu, Kubernetes, and Docker.
- [Deploy to AWS](https://docs.openreplay.com/en/deployment/deploy-aws/): EC2 deployment guide with minimum requirements (2 vCPUs, 8GB RAM, 50GB storage), SSL/TLS, and load balancer setup.
- [Deploy to GCP](https://docs.openreplay.com/en/deployment/deploy-gcp/): Google Cloud Platform deployment instructions for Compute Engine instances.
- [Deploy to Azure](https://docs.openreplay.com/en/deployment/deploy-azure/): Microsoft Azure deployment guide for virtual machine instances.
- [Deploy to Kubernetes](https://docs.openreplay.com/en/deployment/deploy-kubernetes/): Kubernetes cluster deployment and orchestration guide.
- [Deploy with Docker](https://docs.openreplay.com/en/deployment/deploy-docker/): Docker-based deployment for local or containerized environments.
- [Deploy from Source](https://docs.openreplay.com/en/deployment/deploy-source/): Build and deploy OpenReplay from source code for maximum customization.
- [Upgrade Guide](https://docs.openreplay.com/en/deployment/upgrade/): Instructions for upgrading OpenReplay to the latest version.
- [Upload Sourcemaps](https://docs.openreplay.com/en/deployment/upload-sourcemaps/): How to upload JavaScript sourcemaps for readable stack traces in session replays.

## JavaScript SDK

- [JavaScript SDK Overview](https://docs.openreplay.com/en/sdk/): SDK initialization, configuration options, Canvas/WebGL recording, and cross-domain iframe tracking.
- [SDK Installation](https://docs.openreplay.com/en/sdk/installation/): Package installation via npm/yarn and script snippet setup.
- [SDK Constructor Options](https://docs.openreplay.com/en/sdk/constructor/): Full list of constructor parameters for customizing tracker behavior, organized by category below.
- [Constructor: General Purpose](https://docs.openreplay.com/en/sdk/constructor/#general-purpose): Core settings including project key, session handling, and asset management.
- [Constructor: Stylesheets](https://docs.openreplay.com/en/sdk/constructor/#stylesheets): CSS file recording behavior and emotion-js library support for style preservation.
- [Constructor: Privacy](https://docs.openreplay.com/en/sdk/constructor/#privacy): Data obscuration settings for sensitive information like emails and numbers.
- [Constructor: Console](https://docs.openreplay.com/en/sdk/constructor/#console): Configure which console methods to capture and throttling limits.
- [Constructor: Exceptions](https://docs.openreplay.com/en/sdk/constructor/#exceptions): JavaScript error and stack trace capture configuration.
- [Constructor: Performance](https://docs.openreplay.com/en/sdk/constructor/#performance): Framerate, CPU, and memory consumption monitoring options.
- [Constructor: Network](https://docs.openreplay.com/en/sdk/constructor/#network): HTTP request/response capture, payload handling, and data sanitization settings.
- [Constructor: Canvas](https://docs.openreplay.com/en/sdk/constructor/#canvas): Canvas and WebGL element recording with format and scaling options.
- [Constructor: Security](https://docs.openreplay.com/en/sdk/constructor/#security): SSL requirements and development mode configurations.
- [SDK Methods](https://docs.openreplay.com/en/sdk/methods/): API reference for all tracker methods including start, stop, event, setUserID, and session management.
- [Framework Guides - React](https://docs.openreplay.com/en/sdk/using-or/react/): Setup instructions specific to React applications.
- [Framework Guides - Next.js](https://docs.openreplay.com/en/sdk/using-or/next/): Setup instructions specific to Next.js applications.
- [Framework Guides - Angular](https://docs.openreplay.com/en/sdk/using-or/angular/): Setup instructions specific to Angular applications.
- [Framework Guides - Svelte](https://docs.openreplay.com/en/sdk/using-or/svelte/): Setup instructions specific to Svelte applications.
- [Data Sanitization](https://docs.openreplay.com/en/sdk/sanitize-data/): How to redact sensitive data (emails, inputs, network requests) at the source before it reaches OpenReplay.
- [Network Options](https://docs.openreplay.com/en/sdk/network-options/): Configuration for capturing and sanitizing network request/response data.

## Session Replay

- [Identify User](https://docs.openreplay.com/en/session-replay/identify-user/): Associate user identities with recordings via setUserID() method or tracker init options, with examples for NPM, JS snippet, and iOS SDK.
- [Metadata](https://docs.openreplay.com/en/session-replay/metadata/): Attach custom key-value pairs to sessions (up to 10 per project), then filter recordings by metadata using Omni-Search.

## Mobile SDKs

- [iOS SDK (Beta)](https://docs.openreplay.com/en/ios-sdk/): Session recording SDK for native iOS applications with Swift integration.
- [Android SDK (Beta)](https://docs.openreplay.com/en/android-sdk/): Session recording SDK for native Android applications with Kotlin/Java integration.
- [React Native SDK (Beta)](https://docs.openreplay.com/en/rn-sdk/): Session recording SDK for React Native cross-platform applications.

## Products

- [Product Analytics](https://docs.openreplay.com/en/product-analytics/): Trends, funnels, user journeys, heatmaps, dashboards, web analytics, and monitors for tracking user behavior.
- [Funnels](https://docs.openreplay.com/en/product-analytics/funnels/): Conversion funnel analysis to identify where users drop off.
- [Heatmaps](https://docs.openreplay.com/en/product-analytics/heatmaps/): Visual heatmaps showing click and interaction patterns on pages.
- [User Journeys](https://docs.openreplay.com/en/product-analytics/journeys/): Flow visualization showing how users navigate between pages.
- [Dashboards](https://docs.openreplay.com/en/product-analytics/dashboards/): Custom dashboard builder for monitoring key product metrics.
- [Custom Events](https://docs.openreplay.com/en/product-analytics/custom-events/): How to send functional events (tracker.event) and technical events (tracker.issue) via NPM, JavaScript snippet, or iOS SDK.
- [Co-Browsing](https://docs.openreplay.com/en/co-browsing/): Real-time user assistance with live session viewing, remote control, annotations, video calling, and console monitoring.

## Plugins

- [Plugins Overview](https://docs.openreplay.com/en/plugins/): Store management (Redux, VueX, Pinia, ngRx, Zustand), network capture (Fetch, Axios, GraphQL), performance profiling, and Assist.
- [Redux Plugin](https://docs.openreplay.com/en/plugins/redux/): Capture and replay Redux state changes alongside session recordings.
- [Fetch Plugin](https://docs.openreplay.com/en/plugins/fetch/): Capture Fetch API network requests and responses.
- [GraphQL Plugin](https://docs.openreplay.com/en/plugins/graphql/): Monitor and capture GraphQL queries and mutations.
- [Assist Plugin](https://docs.openreplay.com/en/plugins/assist/): Enable real-time co-browsing and live session assistance.

## Integrations

- [Integrations Overview](https://docs.openreplay.com/en/integrations/): Connect with backend logging (Datadog, Sentry, Elasticsearch), ticketing (Jira, GitHub), messaging (Slack, MS Teams), and CDPs (Segment).
- [Sentry Integration](https://docs.openreplay.com/en/integrations/sentry/): Link Sentry errors to session replays for full debugging context.
- [Datadog Integration](https://docs.openreplay.com/en/integrations/datadog/): Sync Datadog backend logs with frontend session recordings.
- [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 tickets directly from session replays with context attached.
- [Slack Integration](https://docs.openreplay.com/en/integrations/slack/): Share session replay links and alerts to Slack channels.

## API

- [API Overview](https://docs.openreplay.com/en/api/): REST API reference with endpoints for projects, sessions, events, users, jobs, and live assist access.
- [Sessions API](https://docs.openreplay.com/en/api/sessions/): Retrieve and query recorded user sessions programmatically.
- [Events API](https://docs.openreplay.com/en/api/events/): Pull captured event data from sessions.

## Configuration

- [Configuration Overview](https://docs.openreplay.com/en/configuration/): Instance administration including SMTP setup, SSL security, proxy settings, storage management, external databases, and SSO.
- [SSO Setup](https://docs.openreplay.com/en/configuration/sso/): Configure Single Sign-On authentication for your OpenReplay instance.
- [External Storage](https://docs.openreplay.com/en/configuration/external-storage/): Connect external object storage (S3, GCS) for session recording data.
- [Roles and Access](https://docs.openreplay.com/en/deployment/roles-and-access/): Configure team roles and access control permissions.

## Troubleshooting

- [Troubleshooting Overview](https://docs.openreplay.com/en/troubleshooting/): Central hub for resolving common OpenReplay issues with links to all troubleshooting guides 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 including ES module require failures in SSR, Navigator not defined, dependency warnings, and 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, including Safari compatibility notes.
- [Sourcemaps Issues](https://docs.openreplay.com/en/troubleshooting/sourcemaps/): Fixing 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 options when HTTPS is unavailable.
- [Deployment Issues](https://docs.openreplay.com/en/troubleshooting/deployment-issues/): Fixes for self-hosted deployment problems including Helm operation conflicts, SSL certificate failures, PostgreSQL cleanup delays, and kubectl auth errors.
- [Supported Browsers](https://docs.openreplay.com/en/troubleshooting/supported-browsers/): Browser compatibility matrix listing minimum versions (Chrome 41+, Firefox 17+, Edge 12+, Safari 9+, IE 11+, Opera 28+).
- [Clear Cache](https://docs.openreplay.com/en/troubleshooting/cache/): How to clear cached stylesheets, icons, and fonts from the Minio sessions-assets bucket via Kubernetes.
- [Network Resources](https://docs.openreplay.com/en/troubleshooting/network-resources/): Fixing zero-value resource timing data by configuring the Timing-Allow-Origin header for cross-origin resources.

## Optional

- [OpenReplay CLI](https://docs.openreplay.com/en/cli/): Command-line interface for managing OpenReplay installations and operations.
- [Tracker Compatibility](https://docs.openreplay.com/en/deployment/compatibility/): Browser and framework compatibility matrix for the OpenReplay tracker.
- [Deprecated Versions](https://docs.openreplay.com/en/deployment/deprecated-versions/): Reference for older OpenReplay versions no longer supported.
- [Spot Chrome Extension](https://docs.openreplay.com/en/sdk/using-or/snippet/): JavaScript snippet installation without npm for quick setup.