Skip to content
guarddog-dp edited this page May 1, 2024 · 18 revisions

Welcome to the GUARDDOG AI Documentation wiki!

Here we will upload the documentation for our technology and platform.

Supported Operating Systems:

  • RedHat Enterprise Linux 8.8
  • RedHat Enterprise Linux 8.9
  • RedHat Enterprise Linux 9.2
  • RedHat Enterprise Linux 9.3

Requirements:

  1. System Requirements Minimum: 4CPU/4GB/40GB; Recommended: 4CPU/8GB/64GB.
  2. Port Mirroring. This is a key configuration that is needed to allow us to have the visibility needed to provide the assessments and protection desired.
  3. Network configuration. The container needs to be deployed on a network that is configured to allow traffic to and from the container out to the internet.
  4. Firewall configuration. Refer to the firewall_ports document for the list of ports allowed through the firewall.
  5. Docker. At least Docker version 23.x must be installed on the system where the container is to be deployed.
  6. License. Every container uses a unique, non-transferrable license that is to be requested by contacting us. Follow the process below.
  7. Host network interfaces: The container is prepared to work with the network interfaces presented to the host. Have those configured with IP, Subnet, Gateway, VLAN, and DNS before running the container.
  8. Container runs with host networking access to be able to be completely functional. It will detect all ethernet interfaces and add them to the internal network configuration within the container.
  9. Container runs in privilege mode to be able to perform the functions it is designed for.

Index:

  1. Requirements Guide. Refer to the requirements_doc This document goes over the initial steps on how to use the platform.
  2. Manual. The manual is a more in-depth document explaining the multiple modules and settings of the dashboard.
  3. Firewall Document. This firewall_ports document shows the communication that needs to be allowed through in the firewall in order for the container to be fully operational.
  4. RHEL Deployment Guide. This deployment guide shows the simple steps needed to deploy the container on a supported RHEL system.

Licensing and Deployment Summary:

  1. Create an account at https://fido.guarddog.ai
  2. Contact us at support@guarddog.ai to request a license.
  3. Once the account is verified, validated and payment is completed the license will be generated and we will communicate with you.
  4. Use the license as stated in the deployment guide to start the container.
  5. Once the container is running, and given all the requirements have been met, please allow for 1h - 2h for the container to fully update. Once done it will automatically start learning and assessing the network to discover digital assets.
  6. Once those digital assets are identified then it will automatically proceed to identify vulnerabilities.

Clone this wiki locally