CliqRelay
v0.1.0
cliqrelay-web:latest
https://github.com/CliqRelay/cliqrelay
bridge
3000
sh
false
https://github.com/CliqRelay/cliqrelay/issues
https://github.com/CliqRelay/cliqrelay
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.
[b]Key Features:[/b]
- [b]Instant Capture:[/b] Record user workflows in real time using the CliqRelay Chrome/Firefox browser extension.
- [b]Contextual Screenshots:[/b] Automatically captures and crops screenshots for every click and interaction.
- [b]Live Recording Sidepanel:[/b] Start, pause, review, and watch steps populate live in the extension sidepanel.
- [b]Rich Guide Editor:[/b] Reorder steps, edit descriptions, blur sensitive details, and insert annotations (tips, callouts, alerts, headers).
- [b]PDF Export:[/b] Export polished, print-ready PDF guides for offline handoff and team sharing.
- [b]Guide Lifecycle Management:[/b] Star, publish, organize, and soft-delete guides with full restore capabilities.
[b]DEPLOYMENT & SETUP INSTRUCTIONS:[/b]
CliqRelay consists of a web frontend, backend API, worker, PostgreSQL database, Redis, and RustFS object storage.
[b]Recommended: Docker Compose Manager on Unraid[/b]
1. Upstream provides a complete [inline]docker-compose.prod.yml[/inline] in the repository.
2. Clone the repository into your appdata folder:
[code]git clone https://github.com/CliqRelay/cliqrelay.git /mnt/user/appdata/cliqrelay[/code]
3. Copy [inline]docker-compose.prod.env.example[/inline] to [inline]docker-compose.prod.env[/inline] and configure your secrets:
[code]cd /mnt/user/appdata/cliqrelay && cp docker-compose.prod.env.example docker-compose.prod.env[/code]
4. Build and start the stack with Docker Compose:
[code]docker compose --env-file docker-compose.prod.env -f docker-compose.prod.yml up -d --build[/code]
5. Open the web interface at [inline]http://[IP]:3000[/inline] and install the browser extension.
[b]Credits & Support:[/b]
- CliqRelay is created by the [b]CliqRelay Team[/b] ([url=https://github.com/CliqRelay/cliqrelay]GitHub[/url]). Support the project via [url=https://dub.sh/tLh3JgA]GitHub Sponsors[/url].
- The donation link below specifically supports the maintenance of this Unraid template repository.
Productivity: Tools:Utilities Other:
http://[IP]:[PORT:3000]/
https://raw.githubusercontent.com/TeeCodeDev/unraid-templates/main/templates/CliqRelay.xml
https://raw.githubusercontent.com/CliqRelay/cliqrelay/main/README.md
cliqrelay documentation guide scribe tango screenshot dom recorder walkthrough sop manual
Apache-2.0
https://raw.githubusercontent.com/CliqRelay/cliqrelay/main/apps/web/public/app-logo-dark.png
2026-10-22
https://raw.githubusercontent.com/CliqRelay/cliqrelay/main/app-screenshot.png
https://raw.githubusercontent.com/CliqRelay/cliqrelay/main/project-banner.png
Support the Unraid template maintainer (TeeCodeDev)
https://ko-fi.com/D1D51ZGUNL