Installing the Replay Browser is only required to record replays. If youβve received a link to an existing replay, open it in any browser and skip straight to debugging.
Our default Replay Browser is a fork of Firefox. We have a beta version of Chromium that you can download on Linux today (Mac and Windows support coming soon).
To start recording your own replays, you first need to install the Replay Browser.
- Go to replay.io and download Replay for either Mac, Linux, or Windows.
- Install Replay like you would any other native application on your computer.
- Open Replay and create an account.
Importing browser settings
The first time you open the Replay Browser, you may be prompted to import your settings and data from another browser. This is not required, but may be helpful if you want access to data like saved passwords while recording with Replay.
You can also import these later by selecting File > Import From Another Browser in the Replay Browser menu.
Installing on Linux
You will need to install libgtk version 3.0 (for libgtk-3.so.0) and libdbus-glib version 1.2 (for libdbus-glib-1.so.2). These may already be installed on your distribution if you use Ubuntu or Fedora. If you have Firefox installed, then you already have these shared libraries.
A simple way to get setup on most Linux distributions is to first install Firefox which will install the necessary dependencies. After that, it should be easy to download Replay and get started.
Check out our Linux Support guide for more details.
Installing on Windows
Replay has both a Windows installer and supports WSL. Check out the Windows Support guide for getting set up.
Installing Replay Chromium
Replay Chromium is currently in beta for Linux only, with these limitations:
- The browser does not have login functionality or a βRecordβ button
- All tabs are automatically recorded to disk for as long as it runs.
- Recordings are saved to your home directory and must be manually uploaded using the Replay CLI for debugging.
- During both, recording and replaying, you will likely encounter some bugs.
Use these manual installation steps:
- Download the latest Replay Chromium build https://static.replay.io/downloads/linux-replay-chromium.tar.xz
- Extract the archive:
tar xf linux-replay-chromium.tar.xz
- To record:
cd replay-chromiumand run./chromeor./chrome https://example.com - Note: It starts recording all tabs to disk immediately.
- You can now interact with the website to produce the desired recording.
- Recording will stop once you close Replay Chromium.
Initial setup before uploading recordings:
- Globally install the Replay CLI package:
npm i -g @replayio/replay
- Create a Replay API access token using the βSettingsβ dialog in the Replay UI.
- Set the API key in your shell:
export RECORD_REPLAY_API_KEY=$TheApiToken
To upload recordings:
- List recordings that have been saved locally:
replay ls. View the list of recordings, find the correct recording based on the βURLβ column, and copy the recording ID.
- Upload the recording:
replay upload $RECORDING_ID
- Once uploaded, the CLI shows you a link where you can replay your recording as usual.