Best Practices from Oracle Development's A‑Team

Preparing Linux for Oracle Remote Data Gateway

Validated on October 15, 2019 for OAC and RDG 105.4x


This post describes preparing an X11 graphical display system on a Linux 7 compute instance running on Oracle Cloud Infrastructure (OCI). A graphical interface is a requirement of The Oracle Analytics Cloud (OAC) Remote Data Gateway (RDG) installer. This post is also useful for preparing the 1.5 version of Remote Data Connector.

X11 is the simplest graphical display system to provision in a compute instance. Other options include installing a VNC server or a full desktop environment such as GNOME or KDE. 

It also describes configuring an X11 server running on a MAC-OS or Windows client to display a graphical user interface (GUI). 

This post is not intended for those who currently have a Linux environment with a Graphical Display system available for RDG. 


Published on June 28, 2019


  • Linux  7.2

  • OAC Remote Data Gateway 105.3, 105.4

  • OAC 105.3, 105.4

  • MAC OS 10.13.6


  • Before you Begin

  • Preparing the X11 Graphical Display System

  • Preparing the X11 Server

  • Validating the Graphical User Interface

  • Preparing Ports for RDC and RDG

 Before you Begin

In this post, the term "instance" refers to the Linux compute instance hosting a RDG agent.


Preparing the graphical user interface for RDG requires the following:

  • The IP address or host name of the compute instance.

  • The SSH private key associated with the instance's public key. 

  • A SSH utility with X11 tunneling capability to access the instance.

  • Administration privileges on a MAC-OS or Windows client.

 Preparing the X11 Graphical Display System

This section describes configuring an X11 graphical display system for the RDG Linux installer.

SSH Into the Linux Instance

Use an SSH utility to connect to the linux instance as the opc user. This require the IP address / host name of the instance and the private key.  The SSH syntax is:

ssh -i < private key path >  opc@< IP address or host name >

Switch to the Root User

sudo su -

Modify the SSH Daemon Configuration File

Set the X11UseLocalHost parameter for correct creation of the DISPLAY environment variable. Edit the sshd_config file, uncomment the X11UseLocalHost parameter and change the value from yes to no.

vi /etc/ssh/sshd_config

Restart the SSH Daemon

systemctl restart sshd

Set up X11 Authorization

This is accomplished by installing the xauth application.

yum -y install xauth

Install the X11 Terminal Emulator

The xterm application may be used to open an X11 terminal on a user's client machine. This post uses it to validate the graphical user interface.

yum -y install xterm

Install the X11 Test and Extension Library

This library is required for the RDG installer.

yum -y install libXtst.x86_64

Close the SSH Connection to the Instance.

 Preparing the X11 Server

An X11 server running on a client machine is required to display the RDG installer graphical user interface.

Download and Install X11 Server Software

Popular software for MAC-OS is XQuartz at https://www.xquartz.org. Popular software for Windows is Xming at https://sourceforge.net/projects/xming/.

This post uses MAC-OS and XQuartz.

Download the XQuartz .dmg file and install it using the default values.

Download and Install SSH Software

Also required is an SSH client that supports X11 tunneling. For MAC-OS the terminal application is sufficient. For Windows, PuTTY is the most widely used: https://www.putty.org

This post uses MAC-OS and the terminal application.

 Validating the Configuration

The configuration is validated by starting the X11 Server on the MAC-OS. This is done by starting the XQuartz application.

​Start the X11 Server Application.

Use Finder to open the Applications>Utilities folder and double-click XQuartz. An xterm window  opens on the MAC.

Now this terminal session or another remote terminal session can be used to SSH into the Linux instance to run an X11 application. 

SSH into the Linux Server with an X11 Tunnel

Use the SSH utility with the -X option to set up an X11 tunnel session on the Linux instance. Connect as the opc user.

This require the IP address / host name of the instance and the private key.  The SSH syntax is:

​​ssh -X -i < private key path >  opc@< IP address or host name >

As a test, run the Linux xterm application.

xterm &

You may have to wait up to a minute, then a new Xterm window appears on your desktop from the Linux instance validating the configuration.

 Preparing​ Ports for RDC and RDG

The Remote Data Gateway requires a http port (default 8080) to be opened for ingress by the browser-based agent configuration utility. After the agent is configured, the ingress is not required and access can be removed.

The Remote Data Connector requires a http(s) port (default 8080/443) to be opened for ingress for all operations..

Refer to Opening Ports in Linux 7 Firewalls for Oracle Analytics Cloud Access to Databases and Remote Data Connector for guidance.


You can now proceed to install and configure an OAC Remote Data Gateway agent on a Linux compute instance.

This post described preparing an X11 graphical display system on a Linux 7 compute instance running on Oracle Cloud Infrastructure and an X11 server running on a MAC-OS client to display an X11 graphical user interface (GUI).

For other posts relating to analytics and data integration visit http://www.ateam-oracle.com/dayne-carley.


Be the first to comment

Comments ( 0 )
Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.Captcha