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

Support and Summary

On-prem Deployment Guide (AWS)

Before Contacting Support

Work through this checklist to gather information. Support will ask for the same details, so collecting them first saves time.

  1. Check Troubleshooting: Search Troubleshooting for your specific symptom

  2. Collect deployment status (run on the VM):

   ./deploy.sh --status
   ./deploy.sh --health

  1. Collect service logs (run on the VM):

   ./deploy.sh --logs <service-name>

Or for full, untruncated output:

   docker logs <service-name>

  1. Collect container status (run on the VM):

   docker ps -a

  1. Collect your config/.env file with all passwords, keys, and tokens redacted

  2. Collect versions (run on the VM):

   docker --version
   docker-compose --version
   aws --version

Also note your RDS PostgreSQL engine version (visible in AWS RDS Console > Databases > your instance)

  1. Note the issue timeline:

    • Exact timestamp the issue started

    • Any recent changes: upgrade, config edit, instance reboot, credential rotation

  2. Contact Hivel support: Email support@hivel.ai with all information above

Deployment Checklist

This guide covers the complete deployment process. Ensure you've completed these steps:

  1. Overview & Decision Guide - Reviewed deployment options and chose a path

  2. Infrastructure Setup - Provisioned EC2 and RDS instances

  3. AWS Configuration - Set up CLI access and ECR authentication

  4. Database Setup - Configured RDS and created the database

  5. Project Setup - Downloaded hivel-onprem from S3, configured .env

  6. Database Migration - Ran flyway-migration with root credentials

  7. Deployment - Started services with deploy.sh or docker-compose

  8. Log Rotation - Configured automatic log management

  9. Verification - Validated health, endpoints, and UI access

  10. Application Setup and Tool Integration - Set up the Hivel account and integrated required tools.

  11. Operations - Reviewed backup, upgrade, cleanup, and security procedures

Key Points to Remember

  • Always run migration first: Flyway must complete before services start

  • Credential phases: Use root credentials for migration only, then switch to application-user credentials for services (see Security and Secrets)

  • AWS setup: Configure CLI and ECR access before deployment

  • Package source: Download hivel-onprem from Hivel's S3 bucket (you'll receive the path or pre-signed URL from support@hivel.ai)

Deployment is complete. Next Steps:

To get started with Hivel:

Go to the Application Setup Guide: User Sign-up and Integration to create your admin account and connect the required integrations.

If you've already signed up, go directly to the Integrations page to continue connecting additional tools.

To set up a stable custom domain with HTTPS (optional):

Follow the AWS DNS Setup guide instead of using the raw IP address, which changes on restart and doesn't support secure connections.

If you encounter issues:

Return to Troubleshooting or use the Support checklist above.

Back to Quick Reference

DNS Setup

Last updated