icoretech / airbroke

Open Source Error Catcher Features > Airbroke is currently in active development! Using it in production environments is at your own discretion. We appreciate your feedback and support as we work towards a stable release. • :floppy_disk: Based on PostgreSQL • :globe_with_meridians: Airbrake(tm)/Sentry(tm)-compatible HTTP collector endpoints • :computer: Modern, React-based frontend for error management • :rocket: Designed with simplicity at its core • :wrench: Maintains small database footprint even under heavy data ingestion • :robot: Ask AI about issues • :clipboard: Provide cURL command to reproduce HTTP exceptions • :arrow_forward: Replay HTTP exceptions • :key: Supports multiple OAuth providers for secure user authentication • :bar_chart: Occurrence charts • :bookmark: Save and manage bookmarks for important occurrences • :electric_plug: MCP API for LLM/agent integrations System Requirements • Node.js 22/24+ compatible environment • Minimum of 300MB RAM • At least 1000 millicores, equivalent to 1 CPU core • PostgreSQL 15+ database • 8+ free database connections slots per instance Deployment Options Airbroke provides flexibility in deployment options. You can either deploy it from the built source code or use a multiarch Docker image. For Kubernetes deployments, a Helm chart is provided. As Airbroke is a Next.js 16 application, it can be deployed wherever a Node.js server is supported. This includes managed environments such as Vercel, Netlify, and Heroku. Build from source For a production build, you can run: Then edit the file to set your own values. This will generate a build output. Because this repo uses , the runnable server output is in (see the for a working copy strategy / asset layout). You can also run to test the production build locally on port . Docker We publish images for both and architectures on ghcr.io but in case you want to build your own image you can do so. You can build the Docker image with: You can then run the image locally with: Vercel While testing on Vercel has not been conducted, Airbroke should be fully compatible. It's important to keep the following points in mind: • For optimal performance, ensure your database is located in the same region. • The endpoints under will be converted into serverless functions, which may introduce potential cold boot time. • If you connect directly to Postgres, use a pooler (or Prisma Accelerate / Data Proxy) to avoid exhausting DB connections. • Migrations must be executed as part of deployment. The Deploy Button above sets a that runs DB migrations only for before building (adjust this in your Vercel project settings if you need a different workflow). • The Deploy Button defaults to for quick starts. After your first deploy, set it to your deployed origin (for example ) and any custom domains. Detailed instructions for this process can also be found in the Prisma deployment guide for Vercel. Render.com The Render Deploy Button uses (Render Blueprint). On the free tier, the template runs at boot (safe no-op if already applied). Airbroke allows all origins if is unset — once Render assigns your public URL, lock it down in the Render dashboard for production (this controls CORS for and ). Railway Railway supports one-click deployments via **Templates**. Because templates are created and published from within Railway, you’ll need to create a template once and then wire up the button URL. Steps: • Create a Railway project from this repo (GitHub deploy). • Add a PostgreSQL database in Railway. • Set required environment variables (Railway can suggest vars from ). • Publish the project as a Template and replace above with the template ID. Netlify The Deploy to Netlify button is configured via . The build command runs DB migrations only for production deploys. Because you don't know your final URL before the first deploy, you can start with and then tighten it to your deployed origin (for example ) and any custom domains. Heroku The Deploy to Heroku button uses to provision add-ons and prompt for required environment variables. Because you don't know your final URL before the app is created, you can start with and then tighten it to your deployed origin (for example ) and any custom domains. Helm You can deploy Airbroke to Kubernetes using the dedicated Helm chart. The Helm chart includes a file with some default values that you can override with your own. It also includes a pgBouncer chart as optional dependency. When using Helm we recommend using a GitOps approach to deploy your application(s), such as Flux. Please find more information about the Helm chart in the dedicated repository: icoretech/charts Docker Compose For users who prefer Docker Compose for managing multi-container Docker applications, a file is provided at the root of the repository. To get started, make sure you have Docker and Docker Compose installed on your system. Then, you can start the application using the following command in the terminal: You can override the default values in the file by creating a file in the same directory. This file is ignored by Git and will not be committed to the repository. Setup Please view all the available configuration variables in the file. Airbroke requires at runtime. is required when you need a *direct* database connection for migrations (for example, when goes through PgBouncer or a data proxy). Some examples: The optimal connection pool size without pgBouncer ( ) can be calculated using the following formula: For a system with 8 CPU cores and 3 application instances, the calculation would proceed as follows: Since must be an integer, it should be rounded down to the nearest whole number. In this scenario, each of the 3 application instances should have a of . This limit can be set in your connection strings. After deployment, you should be able to access your ingress (preferably secured with HTTPS) and start adding projects. This process will generate an API key that…