PingOne

Configuring an Authorize gateway instance

Customize the environment and behavior of the gateway instance to suit your business needs.

Use the Docker run command or Docker Compose to pass configuration information to your gateway instance. ​

  • Docker run

  • Docker Compose

Use the Docker run command

Steps

  1. Stop the gateway instance container.

  2. Using the SPRING_APPLICATION_JSON environment variable, modify the docker run command to include the relevant configuration object.

    For example, to configure decision logging for the gateway instance, the command should look something like this (line breaks are included for readability and are not necessary in your command):

    docker run --init \
  -e PING_IDENTITY_ACCEPT_EULA=yes \
  -e gatewayCredential=<your-gateway-credential> \
  -e SPRING_APPLICATION_JSON='{"decision-logging":[{"name":"debugLog","details":["decisionTree"],"logged-attributes":["Amount"],"log-format":"%date{yyyy-MM-dd'\''T'\''HH:mm:ss.SSSXXX,UTC} [%logger] %msg%n"}]}' \
  -p 8080:8080 pingidentity/pingone-authorize-gateway:1.0.0

    Learn more about starting a gateway instance.

  3. Run the command.

    The container starts with the relevant configuration enabled for the gateway instance.

Use Docker Compose

With Docker Compose, you can manage the Docker application by configuring the application’s services, networks, and volumes in a single, comprehensible YAML file. You can also start and stop all managed services with the docker compose up and docker compose down commands, respectively.

  1. Stop the gateway instance container.

  2. In the host server, create a docker-compose.yml file.

    For example:

    touch docker-compose.yml

    Learn more in the Docker Compose documentation.

  3. In the newly created docker-compose.yml file, use the environment.SPRING_APPLICATION_JSON variable to pass in the relevant configuration object.

    For example, to configure decision logging for the gateway instance, the docker-compose.yml file should look something like this:

    services:
  authorize-gateway:
    image: pingidentity/pingone-authorize-gateway:1.0.0
    init: true
    environment:
      PING_IDENTITY_ACCEPT_EULA: "yes"
      gatewayCredential: <your-gateway-credential>
      SPRING_APPLICATION_JSON: '{"decision-logging":[{"name":"debugLog","details":["decisionTree"],"logged-attributes":["Amount"],"log-format":"%date{yyyy-MM-dd'\''T'\''HH:mm:ss.SSSXXX,UTC} [%logger] %msg%n"}]}'
    ports:
      - "8080:8080"

  4. From your gateway instance directory, start the application by running docker compose up.

    The container starts with the relevant configuration enabled for the gateway instance.

    Learn more about the Docker Compose CLI in How Compose works in the Docker Compose documentation.

Next steps

Learn more about configuring decision logging, authentication, and service caching for your gateway instance.