Get started with GoldenGate Studio Free

Discover what you need and how to get started with GoldenGate Studio Free.

What you need

To use Oracle GoldenGate Studio Free, you need the following:

  • A system running one of the following:
    • Docker, or a compatible container runtime such as Podman
    • Linux
  • Internet connectivity to access the container registry or Oracle Technology Network (OTN)
  • A valid Oracle.com login

Get GoldenGate Studio Free

You can get GoldenGate Studio Free from the Oracle Container Registry (OCR) or Oracle Technology Network (OTN). Follow the applicable instructions to access GoldenGate Studio Free.

From Oracle Container Registry

Follow these instructions to access the GoldenGate Studio Free from Oracle Container Registry (OCR).

You must sign in to your Oracle account and accept the license agreement before you can pull the GoldenGate Studio Free docker image from the Oracle Container Registry.
To access the GoldenGate Studio Free docker image:
  1. Accept the license agreement.
  2. In your Docker client, enter the following command to log in to the Oracle Container Registry:
    docker login container-registry.oracle.com
    
  3. When prompted, enter your Oracle account username and password.
  4. Copy the docker pull command to pull the latest GoldenGate Studio Free image, and run it in your Docker client:
    docker pull container-registry.oracle.com/goldengate/goldengate-studio-free:latest

From Oracle Technology Network

Follow these instructions to access the GoldenGate Studio Free from Oracle Technology Network (OTN).

You must sign in to your Oracle account and accept the license agreement before you can download the GoldenGate Studio Free configuration assistant from the Oracle Technology Network.
To download the GoldenGate Studio Free configuration assistant:
  1. Open Oracle Technology Network in your browser.
  2. On the Software Download page, scroll down, and then select Middleware.
  3. Under Middleware, select GoldenGate Studio Free.
  4. On the Oracle GoldenGate Studio Free Downloads page, select the available installer package.
  5. Accept the license agreement.
  6. When prompted, save the installer package to your local machine and take note of its location.

Start and run the GoldenGate Studio Free docker image

Learn to start and run GoldenGate Studio Free after pulling the docker image from Oracle Container Registry.

To start and run GoldenGate Studio Free:
  1. In your Docker client, you can enter a run command with default settings or enter a run command with parameter values:
    • To run GoldenGate Studio Free with default settings:
      docker run -p 80:80 -p 443:443 container-registry.oracle.com/goldengate/goldengate-studio-free:latest

      A container instantiates with the following default options:

      • auto generated container name
      • 80 port for HTTP Server
      • 443 port for HTTPS Server
      • oggadmin for the name of the administrative account
      • auto generated the password for the administrative account
      • Local for the name of the deployment
      • Use container storage for /u02 and /u03 volume
      • auto generated self-signed certificate
    • To run GoldenGate Studio Free with modified settings:
      docker run \
          --name <container-name> \
          -p <host port>:80 \
          -p <host port>:443 \
          -e OGG_ADMIN=<admin user name> \
          -e OGG_ADMIN_PWD=<admin password> \
          -e OGG_DEPLOYMENT=<deployment name> \
          -e OGG_DOMAIN=<domain name> \
          -v [<host mount point>:]/u02 \
          -v [<host mount point>:]/u03 \
          -v [<host mount point>:]/etc/nginx/cert \
          container-registry.oracle.com/goldengate/goldengate-studio-free:latest

      Parameter descriptions:

      • <container-name>: Name for the container. Auto-generated by default.
      • -p <host-port>:80: The host port to map the Oracle GoldenGate HTTP server. No mapping by default.
      • -p <host-port>:443: The host port to map the Oracle GoldenGate HTTPS server. No mapping by default.
      • -e OGG_ADMIN: The name of the administrative account to create. oggadmin by default.
      • -e OGG_ADMIN_PWD: The password of the administrative account. Auto-generated by default.

        Tip:

        Ensure the password meets the following requirements:
        • At least one lowercase character [a...z]
        • At least one upposercase character [A...Z]
        • At least one digit [0...9]
        • At least one special character [- ! @ % & * . #]
        • The length should be between 8 and 30 characters.
      • -e OGG_DEPLOYMENT: The name of the deployment. Local by default.
      • -e OGG_DOMAIN=<domain name>: The domain name to use for the self-signed certificate (default: hostname of the container). Not needed if you bring your own ssl certificates.
      • -v /u02: The volume used for persistent GoldenGate data. Use container storage by default.
      • -v /u03: The volume used for temporary GoldenGate data. Use container storage by default.
      • -v /etc/nginx/cert: The volume used for storing the SSL certificat for the HTTPS server. Creates a self-signed certificate by default.

      Data storage volumes

      • /u01: the volume for the GoldenGate system
      • /u02: the volume for persistent GoldenGate data
      • /u03: the volume for temporary GoldenGate data

      Administrative account password

      On first startup of the container, a random password is generated for the Oracle GoldenGate if one is not provided for OGG_ADMIN_PWD. You can find this password at the start of the container log:

      docker logs <container-name> | head -3
  2. After a few minutes, you should see Server started at: http://localhost:8080. GoldenGate Studio Free is now ready for you to use.
  3. Launch a web browser, and go to http://localhost:8080.
  4. On the GoldenGate Studio Free login screen, enter the username and password that you passed to the docker run command, and then click Log in.
After you log in successfully, you're brought to the GoldenGate Studio Free Home page.

Next steps

Now that you're in GoldenGate Studio Free, you can: