Skip to main content

​
Fork guide

Deploy OpenSync to your own Convex project with your own WorkOS application.

​
Choose a release

Fork the repository on GitHub, including the codex/convex-static-hosting-release branch. The hosted static-hosting release is on that branch and has not yet been merged into main. Clone that branch from your fork, install dependencies with npm ci, then follow Quick start. Before deployment:
  • Select your own Convex project and separate development/production deployments.
  • Configure your WorkOS callback URLs, allowed origins and matching client IDs.
  • Replace the owner allowlist in convex/lib/adminPolicy.ts with your own verified identities.
  • Replace hosted build values in deploy:static:prod, or use the uploader commands in the static-hosting guide.
  • Keep private keys in your deployment’s environment settings.

​
Develop locally

Run these in separate terminals:
Use the frontend URL printed by Vite. Configure both localhost callbacks if you switch between ports 5173 and 5174.

​
Publish and maintain

Deploy backend functions, upload frontend assets and verify sign-in and plugin sync before directing users to the instance. Follow Convex static hosting. Review upstream changes before merging. Planned teams, evaluation leaderboards, moderation and the larger in-app docs redesign are separate from the deployed release. Do not bulk deploy an unrelated development checkout. This setup uses managed Convex and WorkOS. See requirements if you intend to operate the Convex backend yourself.