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

Support and Summary

On-Prem Deployment Guide (Azure)

Support

  1. Before contacting Hivel support, collect:

  • Output of ./deploy.sh --status and ./deploy.sh --health from the VM

  • docker logs <service-name> for the affected service(s) - full output, not truncated

  • docker ps -a from the VM

  • Your config/.env file with all passwords/keys redacted

  • VM OS version (lsb_release -a) and Docker/Docker Compose/Azure CLI/AWS CLI versions (see the Verify Prerequisites Before Starting commands)

  • The exact timestamp the issue started, and any recent change (upgrade, config edit, VM reboot, Azure PostgreSQL restore)

  • Contact: support@hivel.ai (or your named Hivel contact)

For issues or questions, also:

  1. Check the Troubleshooting section above.

  2. Review service logs: ./deploy.sh --logs

  3. Check service health: ./deploy.sh --health

Summary

This guide covers the complete deployment process for Hivel on-premises:

  1. Infrastructure Setup: VM and Azure Database for PostgreSQL provisioning

  2. AWS Configuration: AWS CLI and ECR access setup (Hivel's registry remains on AWS regardless of your Azure deployment)

  3. Database Setup: Database configuration and database creation

  4. Project Setup: Download from AWS S3, license files, environment configuration

  5. Migration: Flyway database migration

  6. Deployment: Two methods (deploy.sh and docker-compose)

  7. Log Rotation: Automatic log management

  8. Verification: Health checks and access

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

  10. Operations: Backup/restore, upgrade/rollback, uninstall, and security practices for ongoing operation

Remember:

  • Always run migration before deploying services

  • Configure AWS CLI and ECR access before deployment, even though your infrastructure runs on Azure

  • Download the hivel-onprem package from Hivel's AWS S3 bucket

  • Use admin credentials for migration, then switch to the application user for services

Credential Management:

  • Phase 1 (Migration): Use PostgreSQL server admin credentials in the .env file

    • If credentials are stored in Azure Key Vault, retrieve admin credentials from Key Vault

    • Flyway needs admin privileges to create schemas, tables, and users

  • Phase 2 (Services): After migration, update .env to use <user>

    • Default password: <password> (can be customized)

    • If password is customized, ensure it matches in both migration config and .env

  • Security Best Practice: Never use admin credentials for running services

Package Distribution:

  • The hivel-onprem package is distributed via Hivel's AWS S3 bucket, regardless of your Azure deployment

  • You will receive the S3 bucket path or a pre-signed download URL from Hivel support

  • Download and extract the package on the VM before deployment

Default Application Credentials:

  • Username: <user>

  • Password: <password> (default, can be customized)

  • These are created by flyway-migration and should be used for all Hivel services

Good luck with your deployment!

Next step: 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.

if you need HTTPS on the UI without provisioning an Azure Load Balancer,

see DNS Setup.

Last updated