Getting Started

Before logging into the cloud platform to manage risky data flows, track new third party or AI subprocessors, and update privacy reports such as RoPA and PIA for compliance, you will need to complete the following steps:

1. Activate your account on app.hounddog.ai: Ensure that your organization has been properly onboarded and has an active account in the cloud platform. As part of the onboarding process, you will choose the authentication mechanism for logging in, such as Google SSO, Azure AD, Microsoft Entra ID, or SAML-based authentication (supporting Okta and other providers).
2. Generate an API key: Navigate to API Keys and click the "New API Key" button to create a new API key that can be used by the scanner.
3. Run the scanner at any stage of the development cycle.
   1. Manual CLI-based scanning: Use a stand-alone binary installed on your machine or a Docker image. Refer to the documentation [here]. This method is ideal for POCs or when code repositories do not change frequently.
   2. Install an IDE plug-in: Leverage one of the published IDE plug-ins to identify privacy risks as you write code.
   3. Automated CI configuration: Integrate directly with your source control management platform, such as GitHub Cloud or GitHub Enterprise Server. You can customize scan frequency, enable pull request comments for faster remediation, and run scans on your self hosted runners. CI configurations can be applied in bulk across selected repositories, enabling a smooth and consistent rollout across your organization.
   4. Manual CI configuration: Run the scanner continuously before code is merged into the main branch. Follow the instructions in the CI/CD Integrations section and ensure that the HOUNDDOG_API_KEY environment variable is used to unlock the vulnerability detection capabilities.