# CliqRelay

CliqRelay is an open-source platform that automatically transforms browser clicks and interactions into beautiful, step-by-step visual documentation and technical guides. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/7193/cliqrelay

## Description

CliqRelay is an open-source platform that automatically transforms browser clicks and interactions into beautiful, step-by-step visual documentation and technical guides. By pairing a native browser extension with a high-performance backend, CliqRelay tracks exact DOM interactions and contextual screenshots, automating the heavy lifting of writing user manuals, onboarding documentation, and SOPs. Key Features: - Instant Capture: Record user workflows in real time using the CliqRelay Chrome/Firefox browser extension. - Contextual Screenshots: Automatically captures and crops screenshots for every click and interaction. - Live Recording Sidepanel: Start, pause, review, and watch steps populate live in the extension sidepanel. - Rich Guide Editor: Reorder steps, edit descriptions, blur sensitive details, and insert annotations (tips, callouts, alerts,

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

59/100 (Fair), based on 3 of 4 factors.
- Maintained: 100 (last commit 8 days ago)
- Popular: 32 (41 GitHub stars)
- Easy to install: 10 (1 install platform)

## Links

- Unraid: https://ca.unraid.net/apps/app_4781bb829c3285ca
- GitHub: https://github.com/CliqRelay/cliqrelay
- Official website: https://cliqrelay.com

## Common questions

### What command sequence starts the self-hosted CliqRelay backend?

Use Docker Compose with the production env file and production compose file to stop and remove volumes, build in parallel, and start the stack detached.

### How do I run the browser extension with a self-hosted CliqRelay instance?

Build the extension from the apps/extension project and install it in Chrome. The extension README explains how to run it as a local extension.

### Can I export captured guides from CliqRelay?

Any guide can be exported as a PDF for offline sharing or documentation handoff.

### Can I edit captured steps after recording them?

In the web dashboard, you can reorder steps, edit titles and descriptions, and insert annotation blocks such as headers, tips, callouts, and alerts.

### Does self-hosting let me keep documentation data on my own infrastructure?

Yes, you can deploy CliqRelay on your own infrastructure and keep the data under your control.

---
Source: Our Local Host (https://ourlocalhost.com/app/7193/cliqrelay), the self-hosted and open-source app directory.