Prerequisites

For the local docker deployment mode, a machine with the following specifications will enable you to experiment with the main features:

• RAM: 16 GB
• CPU: 8 core
• GPU: 4 GB VRAM, for Synthetic Data only
• Hard Disk: 50GB available

For the local docker deployment mode, a machine with the following specifications will enable you to experiment with the main features:

• RAM: 16 GB
• CPU: 8 core
• GPU: 4 GB VRAM, for Synthetic Data only
• Hard Disk: 50GB available

• Python v3.12.11 and above is installed. For more information about installing Python, refer to the Python website. Ensure that the Python command points to a supported python3 version, for example, Python 3.12. Verify using the python --version command.
• pip for installing packages.
• Python Virtual Environment.
• Docker CLI is installed to manage Docker containers.
• Docker Compose is installed for local containerized deployments. This application supports Docker Compose V2.30 and later. Ensure that your installation supports this version.
• Git is installed for cloning the repository.
• Java 11 or later.
• Maven 3.6+ for AP Java.

• Python v3.12.11 and above is installed. For more information about installing Python, refer to the Python website. Ensure that the Python command points to a supported python3 version, for example, Python 3.12. Verify using the python --version command.
• pip for installing packages.
• Python Virtual Environment.
• Docker Desktop or Colima is installed.
• Docker Compose is installed for local containerized deployments. This application supports Docker Compose V2.30 and later. Ensure that your installation supports this version.
• Git is installed for cloning the repository.
• Java 11 or later.
• Maven 3.6+ for AP Java.

Additional settings for macOS

macOS requires additional steps for Docker and for systems with Apple Silicon chips. Complete the following steps before using AI Developer Edition.

1. Complete one of the following options to apply the settings.

   • For Colima:
     1. Open a command prompt.
     2. Run the following command.

        colima start --vm-type vz --vz-rosetta --memory 8
        

   • For Docker Desktop:
     1. Open Docker Desktop.
     2. Go to Settings > General.
     3. Enable the following check boxes:
        • Use Virtualization framework
        • Use Rosetta for x86_64/amd64 emulation on Apple Silicon
     4. Click Apply & restart.

2. Update one of the following options for resolving certificate related errors.

   • For Colima:

     1. Open a command prompt.

     2. Navigate and open the following file.

        ~/.colima/default/colima.yaml
        

     3. Update the following configuration in colima.yaml to add the path for obtaining the required images.

        Before update:

        docker: {}
        

        After update:

        docker:
            insecure-registries:
                - ghcr.io
        

     4. Save and close the file.

     5. Stop colima.

        colima stop
        

     6. Close and start the command prompt.

     7. Start colima.

        colima start --vm-type vz --vz-rosetta --memory 8
        

   • For Docker Desktop:

     1. Open Docker Desktop.

     2. Click the gear or settings icon.

     3. Click Docker Engine from the sidebar. The editor opens the current Docker daemon configuration daemon.json.

     4. Locate and add the insecure-registries key in the root JSON object. Ensure that a comma is added after the last value in the existing configuration.

        After update:

        {
            .
            .
            <existing configuration>,
            "insecure-registries": [
                "ghcr.io",
                "githubusercontent.com"
            ]
        }
        

     5. Click Apply & Restart to save the changes and restart Docker Desktop.

     6. Verify: After Docker restarts, run docker info in your terminal and confirm that the required registry is listed under Insecure Registries.

3. Optional: If the The requested image’s platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested error is displayed.

   1. Start a command prompt.

   2. Navigate and open the following file.

      ~/.docker/config.json
      

   3. Add the following paramater.

      "default-platform": "linux/amd64"
      

   4. Save and close the file.

   5. Run docker compose up -d from the protegrity-developer-edition directory if already cloned, else continue with the setup.