Installation

This guide walks you through installing and configuring the HoundDog.ai Broker to securely connect your on-premise services with the HoundDog.ai Cloud Platform.

Requirements

• Subscription to our enterprise plan (please see Pricing for details).

• A valid HoundDog.ai API Key (please see API Keys for details).

• Docker Configuration:

  • Engine version 20.10 or higher.
  • x86-64 or ARM64 CPU architecture.
  • Minimum 4 CPU cores and 4 GB of memory allocated per broker container.

• Network Configuration:

  • The domains below must be allowlisted in your network firewall:

    • https://api.hounddog.ai
    • https://broker.hounddog.ai
    • https://hd-app-prod-us-east-1-scan-files.s3.amazonaws.com

  • The domains listed in https://docs.docker.com/desktop/setup/allow-list must also be allowlisted in your network firewall for Docker image pulls.

• Bitbucket Data Center:

  • Valid username and access token with REPOSITORY ADMIN and PROJECT ADMIN permissions.

Installation

Create a .hounddog-env.list file in a secure location (e.g., $HOME) with the following configuration values:

HOUNDDOG_API_KEY="your-hounddog-api-key-here"

​

# Required for Bitbucket Data Center integration.

HOUNDDOG_BITBUCKET_USERNAME="your-bitbucket-data-center-username"

HOUNDDOG_BITBUCKET_TOKEN="your-bitbucket-data-center-access-token"

HOUNDDOG_BITBUCKET_HOST="https://bitbucket.example.com"

HOUNDDOG_BITBUCKET_PORT=443

Run the HoundDog.ai broker using its Docker image:

docker run --pull=always --env-file=$HOME/.hounddog-env.list hounddogai/hounddog-broker

Here is an interactive demo for installing and running the HoundDog.ai Broker.