This is an application for capturing rrweb sessions with enhanced plugins and multi-domain support.
It allows website owners to simply add a recorder script to their site and start capturing user sessions.
The backend validates each session using a pre-shared domain token and routes session data to the correct AWS S3 bucket.
Optional console log recording and replay can be enabled via configuration.
- Continuous Session Capture: Uses localStorage to merge events across page navigations.
- Enhanced Recording:
- rrdom & rrdom-nodejs for DOM snapshot handling.
- rrvideo for video operations.
- Sequential ID Plugins for recording and replay.
- Optional Console Plugins for recording/replaying console logs.
- Multi-Domain Support: The backend verifies incoming sessions (via a pre-shared token) and routes data to per‑domain S3 buckets.
- Secure Uploads: Sessions are stored in AWS S3 with signed URLs (valid for 1 hour) for secure playback.
- Playback Interface: A simple page to load sessions via URL with sequential ID and optional console replay support.
- Dockerized: Easily build and deploy via Docker.
- Hosted Recorder Script: Easily embed the recorder by adding a single
<script>tag. (Hosted via jsDelivr)
-
Clone the Repository:
git clone https://github.com/alokemajumder/rrweb-server.git cd rrweb-server
Configure Environment Variables:
Rename .env.example to .env.
Update AWS credentials, allowed domains, and other settings.
Set ENABLE_CONSOLE_PLUGIN to "true" or "false" as desired.Build and Run with Docker:
docker build -t rrweb-session-capture .
docker run -p 3000:3000 --env-file .env rrweb-session-captureRecorder Script Integration:
Recorder Script Integration (Self-Hosted):
Download the recorder.js file from the repository and host it on your own server. Then, on your website, include the recorder script in your <head> tag as follows:
`<script src="https://yourdomain.com/path/to/recorder.js"
data-domain-key="YOUR_DOMAIN_TOKEN_FOR_DOMAIN_COM"></script>`
Replace https://yourdomain.com/path/to/recorder.js with the actual URL where you host the file, and update the data-domain-key value with the token for your domain.
Playback:
Access the playback interface at http://yourserver:3000/playback.html and enter a session URL to view recordings.
Contributions to this project are very welcome! Whether you’re fixing bugs, suggesting improvements, or adding new features, please follow these guidelines:
-
Fork the Repository:
Create a fork on GitHub and clone your fork locally. -
Create a Branch:
Use a descriptive branch name (e.g.,fix/bug-descriptionorfeature/new-enhancement). -
Write Clear Commit Messages:
Ensure your commit messages accurately describe the changes you have made. -
Submit a Pull Request:
Once your changes are ready, submit a pull request against themainbranch. Please provide a detailed description of your changes and reference any issues or feature requests. -
Report Issues:
If you find a bug or have a feature request, please open an issue on GitHub with as much detail as possible. -
Testing:
If you add new functionality, include tests to cover your changes, ensuring the project remains stable.
Thank you for considering contributing to rrweb Server. Your help is appreciated!
rrweb is an open-source web session recording library that enables you to capture, store, and replay user interactions on web applications. It is designed to help developers understand user behavior, debug issues, and analyze sessions without compromising performance.
-
Comprehensive Recording & Replay:
rrweb captures a wide variety of events (such as clicks, scrolls, mouse movements, input changes, etc.) and DOM snapshots, allowing you to faithfully replay user sessions. -
Lightweight and Efficient:
Optimized to minimize the impact on user experience while recording sessions in real time. -
Extensible Architecture:
Supports a plugin-based architecture, enabling additional functionalities such as:- Sequential ID Plugins:
Ensuring consistent assignment of identifiers to DOM nodes for accurate replays. - Console Record/Replay Plugins:
Optionally capture and replay console logs, providing insights into client-side errors or debugging information. - DOM Snapshot Plugins:
With tools likerrdomandrrdom-nodejs, it efficiently captures the state of the DOM. - Video Operations:
Integrated via packages likerrvideofor enhanced multimedia support.
- Sequential ID Plugins:
In our project, rrweb is a core component that powers both the recording and replay functionalities:
-
Client-Side Recorder:
The self-hosted recorder script uses rrweb to capture user sessions. It merges events across page navigations using localStorage and integrates additional plugins (sequential ID, optional console record, and video plugins) to enhance the recording experience. -
Server-Side Integration:
Although primarily used for session storage and retrieval, the backend includes packages such asrrdomandrrdom-nodejsfor potential advanced DOM processing if required. -
Session Playback:
The playback interface leveragesrrweb-playerto recreate recorded sessions accurately. It also utilizes the sequential ID replay and, optionally, the console replay plugins to provide a comprehensive playback experience.
For more detailed information and usage examples, please visit the rrweb GitHub repository.