For the complete documentation index, see llms.txt. This page is also available as Markdown.

Prerequisites - Overview

Hivel runs as Docker containers on a single EC2 instance, backed by a managed PostgreSQL database in Amazon RDS.

Architecture

  • Compute: EC2 instance running Docker containers

  • Database: Amazon RDS for PostgreSQL (managed)

Data Flow

Integration traffic (Jira/GitHub/GitLab webhooks or polling) → API Gateway → Services → RDS

The UI talks to the API Gateway. The API Gateway validates sessions with the Auth Service.

Network Access

Outside your VPC, traffic is outbound only:

  • Hivel's ECR (pull Docker images)

  • Hivel's S3 bucket (download installer, one-time only)

  • Your connected engineering tools (Jira, GitHub, GitLab, etc.)

See Network Requirements for the full breakdown.

Before You Start

Review these pages to confirm you're ready:

  1. Deployment Decision Guide: Three key decisions and pre-deployment checklist

  2. Verify Prerequisites: Version checks and network requirements

  3. Verify EC2 Instance Requirements: VM size, OS, storage, and required ports

Last updated