Installing the SDK

The Guardium Application Framework SDK can be installed on Windows, Linux, or macOS operating system.

Before you begin

Verify all SDK prerequisites and limitations. To run the application on a Docker container, you must install Docker and start its service prior to installing the SDK.

Procedure

  1. Download the app from the Security App Exchange and extract the Guardium Application Framework SDK archive (.zip file).
  2. Install the SDK:
    • Windows without Docker:
      1. As Administrator, right-click install.bat to run the installation process. The SDK installs to the c:\GuardiumAppSDK folder. Close the terminal window and re-open, so the grd_sdk command is available.
      2. Once the install has successfully completed, close the terminal window and re-open, to ensure that the new 'grd_sdk' command is added to your environment
    • Windows with Docker:
      1. Install the Docker Toolbox, install it now on your development machine, see Install Docker Toolbox process.
      2. Start Docker.
      3. Extract the contents of the SDK zip archive.
      4. Open a Docker Quickstart Terminal, and run the install.bat script as Administrator by entering ./install.bat. During the SDK installation, the new Docker is added to the local Docker repository.
      5. Once the install has successfully completed, open a new QuickStart Terminal window to ensure that the new grd_sdk.bat command is added to your environment.
    • Linux, Unix, macOS:
      1. Extract the contents of the SDK zip archive.
      2. From within the SDK folder, run the install.sh script as root: ./install.sh.
        If you have permission problems, install using sudo ./install.sh
      3. Once the install has successfully completed, open a new Terminal window to ensure the new grd_sdk.bat command is added to your environment.

What to do next

Creating your Guardium application