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

Prerequisites

Confirm you have all required components and credentials before starting deployment

Required Components & Credentials

Before proceeding, you must have:

  • Host: Virtual machine, bare metal, or cloud instance meeting Server Infrastructure Setup specifications.

  • Software: Docker and Docker Compose installed on the host

  • License file: license_signed.json (provided by your Hivel contact)

  • Registry credentials: AWS Access Key ID and AWS Secret Access Key (provided by your Hivel contact)

  • S3 access: Path or pre-signed URL to download the docker-onprem-installer package

  • PostgreSQL support: PostgreSQL 12, 13, 14, or 15 (you'll install this in Database Setup, coming up in this guide)

If you do not have license files, registry credentials, or S3 access, contact your Hivel representative before proceeding. Deployment cannot continue without these items.

Verify Software Versions

Run these commands on the host to confirm supported versions:

docker --version           # supported: Docker >= 26.0
docker-compose --version   # supported: Docker Compose >= 2.25.0
aws --version               # any current v2.x
psql --version               # see Database Setup (Self-Managed PostgreSQL) - PostgreSQL 12 through 15
df -h                        # confirm free disk space against (see Server Infrastructure Setup)

All commands must complete without errors and show supported versions.

Network Requirements

Configure your firewall with the following inbound and outbound rules:

Direction

Port/Destination

Purpose

Inbound

22

Used for secure remote access to the server via SSH.

Inbound

80

API Gateway access

Inbound

3000

Hivel UI (only for direct-IP or ALB access)

Inbound

4317

Required only while integrating Claude Code

Inbound

5432

Database access (host only; no public or external access permitted)

Outbound

443

Pull Hivel Docker images from AWS ECR, download installation packages from S3, connect to external package repositories

Outbound (optional)

Your Jira/GitHub/GitLab instance

Integration connectivity

Proxy Support:

Outbound traffic to Hivel's container registry (ECR) can route through a standard corporate proxy without additional configuration. If your organization requires all other outbound destinations (S3, package repositories, Jira/GitHub/GitLab) to route through a proxy, contact your Hivel representative to confirm support before finalizing firewall rules.

Back to Server Infrastructure Setup

Database Setup

Last updated