What problem does it solve?
This skill guides teams through deploying and maintaining a self-hosted Convex backend, including authentication setup, environment configuration, and production-readiness considerations.
Core Features & Use Cases
- Docker-based deployment guidance: Set up the Convex backend locally or in a containerized environment.
- Authentication integration: Configure @convex-dev/auth with JWT keys, JWKS, and issuer settings for secure sign-in.
- Environment & production readiness: Provide environment variable recipes, database setup (PostgreSQL), storage options, and security best practices for production deployments.
- Troubleshooting & maintenance: Operational guidance for common issues, upgrades, and backups.
Quick Start
Clone the Convex self-hosted repo and spin up the stack:
git clone https://github.com/get-convex/convex-backend
cd convex-backend/self-hosted
docker compose up
docker compose exec backend ./generate_admin_key.sh
Configure environment:
export CONVEX_SELF_HOSTED_URL=http://127.0.0.1:3210
export CONVEX_SELF_HOSTED_ADMIN_KEY=<your-key>
Deploy your code:
npx convex deploy