Skip to main content

​
Quick start

For the hosted app, follow plugin setup. You do not need to deploy anything.

​
Deploy your own instance

  1. Read the requirements. Create your own Convex and WorkOS accounts.
  2. Clone the reviewed release. It is currently separate from main:
Select your own Convex project. Keep this terminal running while developing.
  1. Set WORKOS_CLIENT_ID and the server-side WORKOS_API_KEY on your development deployment using the Convex dashboard. Configure callbacks and allowed origins in WorkOS.
  2. Keep the generated VITE_CONVEX_URL in .env.local. Add your WorkOS client ID:
  1. In a second terminal, start the frontend:
Open the exact URL Vite prints. Both http://localhost:5173/callback and http://localhost:5174/callback must be registered if you use both ports. Register the two origins without /callback in the allowed-origins setting.
  1. Sign in, generate an API key in Settings and connect a plugin to your own deployment. Do not use the hosted OpenSync API for a private fork.

​
Publish the frontend

Follow Convex static hosting to configure production, deploy backend functions and upload the Vite build. Backend deployment and frontend upload are separate steps. Optional semantic search requires your own OpenAI key. Email setup is optional and sending stays blocked in test mode. Neither is needed to start reviewing synced sessions.