SyncingBoard Documentation
Explore quickstart setup guides, system architecture specifications, API rate limits, self-hosting cost breakdowns, and security standards.
Quick Start Guide
Choose your deployment mode to get SyncingBoard up and running in minutes.
Install Miro Plugin
Add SyncingBoard to your Miro team workspace with zero server setup or infrastructure required.
Connect Figma
Authorize 1-click read-only Figma access in Miro SyncingBoard App settings. Optional: install Figma Desktop plugin for live frame selection.
Connect Penpot
Install the Penpot Companion Plugin inside Penpot to link your design canvas directly to Miro using a secure Pairing Key.
Overview, Setup & Video Demos
Everything you need to set up SyncingBoard and see core features in action.
SyncingBoard Overview & Features
Stateless, open-source integration tool syncing design screens from Figma and Penpot directly into Miro and FigJam whiteboards in-place with zero duplicates.
Setup & Deployment
Register your target whiteboard, configure your source adapter (Figma and/or Penpot), deploy to Vercel, and set up optional extras.
Product Roadmap
Strategic milestones, upcoming features, and future architecture plans for SyncingBoard.
Features & Video Demos
Explore SyncingBoard's core capabilities in action with short video walkthroughs, GIFs, and screenshots.
System Design & Adapter Modules
Technical specifications detailing source adapters, target whiteboards, Ably relay transport, and security controls.
SyncingBoard Architecture & System Design
Master system architecture overview detailing SyncingBoard's 3-layer adapter principles, quick status matrix, and sub-module directory.
Source Adapters Architecture
Cloud REST integration for Figma and event-driven Penpot WASM relay, plus research specs for Lovable, Stitch, Framer, and Adobe UXP.
Target Adapters & Metadata Architecture
Miro SDK v2 image widget integration, stateless metadata title signatures, preserveSize geometry, and duplicate card consolidation.
Design System Architecture & Specifications
Core design tokens, typography rules, component standards, and multi-surface guidelines across Miro, FigJam, Companion, and Web Documentation interfaces.
Selection Detection & Cloud Relay Architecture
Real-time Ably WebSocket selection stream, zero-Redis selection transport, companionRelayClient, and 16-character secure pairing keys.
Security, Rate Limits & Quotas Architecture
Sliding-window rate limiting, SHA-256 token hashing, 300s Redis SETEX OAuth state store, and CORS/PNA preflights.
Testing & Quality Assurance
Technical breakdown of SyncingBoard's 132 automated Vitest tests across 18 files covering token security, rate limiting, URL parsers, relay fairness, target adapters, and API route handlers.
Environment Variables
Complete reference for all configuration keys, secret keys, cloud credentials, and rate-limiting options in SyncingBoard.
Data Transport & Infrastructure Costs Architecture
Data path traces, Vercel 4.5MB payload ceilings, zero cloud rendering costs, and self-hosting cost matrix across tiers.
Model Context Protocol (MCP) Roadmap Architecture
Planned specifications for SyncingBoard as an MCP Client (Lovable/Stitch) and MCP Server exposing sync tools to AI agents.
Release Notes & Legal Terms
Version history, open-source license, privacy safeguards, and frequently asked questions.
Changelog
Complete release history, version updates, feature additions, and bug fixes across SyncingBoard releases.
Privacy
SyncingBoard privacy policy — what transient operational data we process, your GDPR rights, and how we never store your design data.
License & CLA
GNU Affero General Public License v3 (AGPL-3.0) — SyncingBoard open-source terms, trademark guidelines, and Contributor License Agreement.
Frequently Asked Questions (FAQ)
Answers to common questions about SyncingBoard real-time collaboration, metadata signatures, network constraints, security, and self-hosting.
Contribution Guidelines & CLA
Guidelines for contributing to SyncingBoard, signing off commits under DCO, running unit tests, and CLA compliance.
Security Policy & Disclosure
Security architecture, vulnerability reporting procedures, zero-persistent-storage guarantees, and token encryption standards.
Historical Research Logs
Preserved engineering research on Chromium Private Network Access (PNA) and architecture evolution.
Chromium Loopback & Sandboxing Security
Historical engineering research on Chromium Private Network Access (PNA), iframe sandboxing, and desktop SSL trust stores.
Architecture Evolution Log
Decision log detailing the shift from local Tauri loopback transport to Cloud-Relay-First architecture.
For AI agents: All documentation content is accessible via raw markdown endpoints:
GET /api/docs/listGET /api/docs/raw?slug=<slug>