Skip to content
Edit

Installation#

To install Gluu Gateway, follow these steps:

  1. Add the required third party repositories
  2. Install the gluu-gateway package
  3. Run setup-gluu-gateway.py

Note

Before installing Gluu Gateway, be sure to have a Gluu Server installed and operational. The Gluu Gateway setup script requires an existing Gluu Server's hostname be provided.

Minimum Requirements#

Gluu Gateway needs to be deployed on a server or VM with the following minimum requirements:

CPU Unit RAM Disk Space Processor Type
1 2 GB 10 GB 64 Bit

Required Third Party repositories#

Important

Always run the following commands as root.

Ubuntu 16#

  • Add the Gluu repo:
    # echo "deb https://repo.gluu.org/ubuntu/ xenial main" > /etc/apt/sources.list.d/gluu-repo.list
    # curl https://repo.gluu.org/ubuntu/gluu-apt.key | apt-key add -
    
  • Add the PostgreSQL 10 repo:
    # echo "deb http://apt.postgresql.org/pub/repos/apt/ xenial-pgdg main" > /etc/apt/sources.list.d/psql.list
    # wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
    
  • Add the Node repo:
    # curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
    

CentOS 7#

  • Add the Gluu repo:
    # wget https://repo.gluu.org/centos/Gluu-centos7.repo -O /etc/yum.repos.d/Gluu.repo
    # wget https://repo.gluu.org/centos/RPM-GPG-KEY-GLUU -O /etc/pki/rpm-gpg/RPM-GPG-KEY-GLUU
    # rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-GLUU
    
  • Add the PostgreSQL 10 repo:
    # rpm -Uvh https://yum.postgresql.org/10/redhat/rhel-7-x86_64/pgdg-centos10-10-2.noarch.rpm
    
  • Add the Node repo:
    # curl -sL https://rpm.nodesource.com/setup_8.x | sudo -E bash -
    

RHEL 7#

  • Add the Gluu repo:
    # wget https://repo.gluu.org/rhel/Gluu-rhel7.repo -O /etc/yum.repos.d/Gluu.repo
    # wget https://repo.gluu.org/rhel/RPM-GPG-KEY-GLUU -O /etc/pki/rpm-gpg/RPM-GPG-KEY-GLUU
    # rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-GLUU
    
  • Add the PostgreSQL 10 repo:
    # rpm -Uvh https://yum.postgresql.org/10/redhat/rhel-7-x86_64/pgdg-redhat10-10-2.noarch.rpm
    
  • Add the Node repo:
    # curl -sL https://rpm.nodesource.com/setup_8.x | sudo -E bash -
    

Install the Gluu Gateway package#

Important

The Gluu Gateway package installs the following required components: PostgreSQL v10, oxd Server 4.0, NodeJS v8, Kong Community Edition v0.14.1.

Ubuntu 16#

 # apt update
 # apt install gluu-gateway

Centos 7, RHEL 7#

 # yum clean all
 # yum install gluu-gateway

Run the setup script#

 # cd /opt/gluu-gateway/setup
 # python setup-gluu-gateway.py

After acknowledging the Gluu Stepped-Up Support License, you will be prompted to answer several questions. Just hit Enter to accept the default values, which are specified in square brackets.

Important

When prompted to provide a two-letter value, make sure to follow the instructions. A mistake may result in the lack of certificates.

Question Explanation
Enter IP Address IP Address of your API gateway
Enter Kong hostname Internet-facing FQDN to generate certificates and metadata. Do not use an IP address or localhost.
Enter two-letter Country Code Used to generate web X.509 certificates
Enter two-letter State Code Used to generate web X.509 certificates
Enter your City or locality Used to generate web X.509 certificates
Enter Organization name Used to generate web X.509 certificates
Email address Used to generate web X.509 certificates
Password If you already have a database password for user postgres, enter it here. Otherwise, enter a new password.
OP hostname The hostname of the Gluu Server that will be used for OAuth 2.0 client credentials and access management. Example: op-server.com
oxd server URL If oxd is installed on a different hostname than Gluu Gateway, provide its URL. If not, enter the hostname for Gluu Gateway
Would you like to generate client_id/client_secret for Konga? Register an OpenID Client for Konga, or enter existing client credentials manually. By default, the client expiration is set to 24 hours; make sure to extend this expiration date. Without this step, after 24 hours you will no longer be able to log in to the Gluu Gateway. If you enter existing client details, make sure your client in Redirect Login URIs and Post Logout Redirect URIs field has the value https://localhost:1338.
oxd_id Used to manually set the oxd ID.
client_id Used to manually set the client ID.
client_secret Used to manually set the client secret.

Finish the setup#

 Gluu Gateway configuration successful!!! https://localhost:1338

If you see the above message, it means the installation was successful. To log in to the Gluu Gateway admin portal, create an SSH tunnel on port 1338 from your workstation to the Gluu Gateway server, and point your browser at https://localhost:1338. Use the login and password that you also use to access the Gluu Server.

Note

If you do not want an SSH tunnel connection. See FAQ for global access configuration.

Warning

By default, the Gluu Gateway Client expiration date is set for one day during the installation process. To change it, follow these instructions. Without this step, after 24 hours you will no longer be able to log in to the Gluu Gateway.

Applications and their ports#

Port Description
1338 Gluu Gateway Admin GUI
8001 Kong Admin API
8000 Kong Proxy Endpoint
443 Kong SSL Proxy Endpoint. By default, Kong uses 8443 port for SSL proxy, but during setup it is changed to 443.
8443 oxd Server

To change the port and configurations, you can update the specific application's config file. For details, see the Configuration section.

Removal#

Important

Always run the following commands as root.

Choose one of the following three options:

  1. Use apt-get to remove only the gluu-gateway package. Any dependencies installed at the same time, as well as configuration, will remain.

    # apt-get remove gluu-gateway
    
  2. If you want to also remove the configuration files (/etc/init.d/gluu-gateway and /opt/gluu-gateway/konga/config), use purge.

    # apt-get purge gluu-gateway
    

  3. Using the --auto-remove parameter will also remove the package dependencies (kong-community-edition, lua-cjson, nodejs, oxd-server, postgresql).

    # apt-get remove --auto-remove gluu-gateway