# Deploy Convex with Easypanel

URL: /templates/convex

Convex is the open-source reactive database and backend platform designed for modern app developers. It provides real-time data synchronization, TypeScript-first development, and built-in features like authentication, file storage, and serverless functions. The self-hosted version includes the main backend service, dashboard for data management, and PostgreSQL database support. Perfect for building full-stack applications with automatic caching, real-time updates, and strong consistency guarantees.

## Installation notes

Click the "Generate Admin Key" script on the backend service, copy the printed key, then use it to log into the Convex dashboard.

## Benefits

### Real-time Data Synchronization

Automatic real-time updates across all clients with optimistic concurrency control and conflict resolution for seamless user experiences.

### TypeScript-First Development

Write your entire backend in TypeScript with full type safety from database schema to client-side queries and mutations.

### Built-in Reactive Queries

Database queries automatically cache and subscribe to data changes, eliminating the need for manual cache invalidation or WebSocket management.

### Strong Consistency Guarantees

ACID compliance with immediate consistency, serializable isolation, and automatic conflict resolution using optimistic multi-version concurrency control.

### Serverless Functions Runtime

Deploy server functions with automatic scaling, hot reloads, and integrated development workflow using the Convex CLI.

### Integrated Development Experience

Built-in dashboard for data browsing, function testing, log viewing, and environment variable management with cloud-first development workflow.

## Features

### Reactive Database

NoSQL-style documents with relationships, custom indexes, and real-time subscriptions that automatically update your UI when data changes.

### TypeScript Functions

Write queries, mutations, and actions in TypeScript with full type safety and automatic code generation for client-side usage.

### Real-time Subscriptions

Automatic real-time data synchronization across all connected clients with optimistic updates and conflict resolution.

### Built-in Authentication

Integrated user authentication system with support for various providers and secure session management.

### File Storage

Built-in file upload and storage capabilities with automatic URL generation and secure access controls.

### Background Jobs

Schedule functions to run in the background with cron job support and automatic retry mechanisms for reliable task execution.

### HTTP Endpoints

Create HTTP endpoints for webhooks and external API integrations with automatic request routing and response handling.

### Vector Search

Built-in vector search capabilities for AI and machine learning applications with efficient similarity matching.

### Development Dashboard

Web-based interface for browsing data, testing functions, viewing logs, and managing environment variables during development.

### CLI Integration

Command-line tools for deployment, function management, schema migrations, and local development with hot reloading.

### Import/Export Tools

Streaming import and export capabilities for data migration and backup with snapshot support for point-in-time recovery.

### Runtime Validation

Automatic validation for function arguments and database data with schema enforcement and type checking at runtime.

## Configuration

- `appServiceName` (App Service Name, required): convex

- `appServiceImage` (Backend Service Image, required): ghcr.io/get-convex/convex-backend:e03b3a72dc412eeff4c1a6958ef1879712fb70e6

- `dashboardServiceImage` (Dashboard Service Image, required): ghcr.io/get-convex/convex-dashboard:e03b3a72dc412eeff4c1a6958ef1879712fb70e6

- `convexCloudOrigin` (Convex Cloud Origin): https://$(PRIMARY_DOMAIN) — Public URL for the Convex backend API

- `convexSiteOrigin` (Convex Site Origin): https://$(PRIMARY_DOMAIN):3211 — Public URL for the Convex site proxy

- `nextPublicDeploymentUrl` (Next Public Deployment URL): https://$(PRIMARY_DOMAIN) — Public URL for the deployment (used by dashboard)

- `instanceSecret` (Instance Secret): Set during installation — Secret key for instance authentication (auto-generated if empty)

- `databaseType` (Database Type): None (No Database) / Generic Database URL / PostgreSQL / MySQL — Select the database type to use

- `databaseUrl` (Database URL): Set during installation — Full database connection URL (required if database type is selected)

- `rustLog` (Rust Log Level): info — Logging level for Rust backend (e.g., info, debug, warn, error)

- `documentRetentionDelay` (Document Retention Delay): 172800 — Document retention delay in seconds (default: 2 days)

- `instanceName` (Instance Name): Set during installation — Name for this Convex instance (defaults to the app service name if left empty)

- `awsAccessKeyId` (AWS Access Key ID): Set during installation — AWS access key for S3 storage (optional)

- `awsSecretAccessKey` (AWS Secret Access Key): Set during installation — AWS secret key for S3 storage (optional)

- `awsRegion` (AWS Region): Set during installation — AWS region for S3 storage (optional)

- `s3EndpointUrl` (S3 Endpoint URL): Set during installation — Custom S3 endpoint URL (for S3-compatible storage, optional)

- `s3StorageFilesBucket` (S3 Files Bucket): Set during installation — S3 bucket name for file storage (optional)

- `s3StorageModulesBucket` (S3 Modules Bucket): Set during installation — S3 bucket name for modules storage (optional)

- `nextPublicLoadMonacoInternally` (Load Monaco Internally): Set during installation — Load Monaco editor internally (optional)

## Services

- convex-backend: app (ghcr.io/get-convex/convex-backend:e03b3a72dc412eeff4c1a6958ef1879712fb70e6)

- convex-dashboard: app (ghcr.io/get-convex/convex-dashboard:e03b3a72dc412eeff4c1a6958ef1879712fb70e6)

## Resources

- [Website](https://www.convex.dev)

- [Documentation](https://docs.convex.dev)

- [GitHub](https://github.com/get-convex/convex-backend)

- [Template source](https://github.com/easypanel-io/templates/tree/main/templates/convex)