VM Preparation Guide#
This document provides instructions for preparing a VM for a single-node Gluu Server deployment. Once the server is ready, install Gluu on one of the supported operating systems.
A barebones Gluu Server can be set up with only oxAuth, oxTrust, LDAP, and SAML IDP as a test or demo environment. The minimum requirements for this deployment are:
- 4 GB RAM
- 2 GB swap space
- 2 CPU units
- 40 GB disk space
The minimum requirements for a production environment with the same services (oxAuth, oxTrust, LDAP, and SAML IDP) are:
- 8 GB RAM
- 4 GB swap space
- 4 CPU units
- 50 GB disk space
Swap space should be scaled to the amount of RAM in the deployment. We recommend deployments with over 8GB of RAM also include .5 times the RAM in swap space. For example, if a deployment has 20 GB of RAM, it should also have 10 GB of swap space.
Each deployment will have unique requirements depending on its architecture, services, and number of users. The following table contains some recommended resources to start with. These requirements should be adjusted to suit the specific deployment.
|config - job||0.5||0.5GB||Required if Cloud Native|
|jackrabbit||1.5||1GB||Required if Cloud Native|
|persistence - job||0.5||0.5GB||Required if Cloud Native|
Gluu must be deployed on a server or VM with a static IP Address. The static IP address should resolve to a computer hostname which can be achieved by adding an entry to the DNS server or in
If setting up a VM locally, we recommend using VM Player (not Virtual Box).
Supported Operating Systems#
Deploy Gluu on a server or VM with one of the following supported operating systems:
The following ports are open to the Internet by default.
|80||tcp||Forwards to 443|
See the operations guide for a list of internal ports used by Gluu Server components (e.g. oxAuth, oxTrust, etc.).
To check the status of these ports in Ubuntu, use the following commands (other OS have similar commands):
ufw status verbose
If the status is found to be inactive, run the
ufw enable command.
The default for
ufw is to
deny incoming and
allow outgoing. To reset your setting to default :
ufw default deny incoming
ufw default allow outgoing
If for any reason the ports are closed, allow connections by:
ufw allow <port>
Ports 443, 80, and 22 must be accessible.
For clustered deployments, more ports must be configured.
File Descriptors (FD)#
The Gluu Server requires setting the
file descriptors to 65k.
Follow these steps or research how to do this on your Linux platform.
- Add the following lines in the
* soft nofile 65535 * hard nofile 262144
- Add the following lines to
/etc/pam.d/loginif not already present.
session required pam_limits.so
- Increase the FD limit to 65535. The system file limit is set in
It is recommended to check the FD limit before increasing it. If this limit is customized and more than default, we recommend using the higher one. The FD limit can be found using the following command.
# cat /proc/sys/fs/file-max
Please note, the command may vary depending on the OS in use.
echo 65535 > /proc/sys/fs/file-max**
- Use the
ulimitcommand to set the FD limit to the hard limit specified in
ulimit -n 262144
CentOS by default will not accept more than the default maximum of 65535. You may get an error while performing the above command.
If the above does not work, use the
ulimit command to set the FD limit to the soft limit of the file
ulimit -n 65535
- Restart the system.
The Server or VM must be deployed on a static IP address. Cloud servers should already have that set. When installing the Gluu Server, make sure the server has a static IP.
Create a file named /etc/sysconfig/network-scripts/ifcfg-eth0 containing the following information:
DEVICE=eth0 BOOTPROTO=none ONBOOT=yes PREFIX=24 IPADDR=192.168.2.203 <replace with your IP>
Restart the network service: systemctl restart network
Other Operating Systems#
Open the following using any editor:
Below is the network configuration. Notice
iface ens33 inet is set to
#This file describes the network interfaces available on your system #and how to activate them. For more information, see interfaces(5). source /etc/network/interfaces.d/* # The loopback network interface auto lo iface lo inet loopback # The primary network interface auto ens33 iface ens33 inet dhcp
Comment out the line that contains the
dhcp by adding
# in front of it and add the values for the
dns-nameservers of the network, as seen in the example below:
#This file describes the network interfaces available on your system #and how to activate them. For more information, see interfaces(5). source /etc/network/interfaces.d/* # The loopback network interface auto lo iface lo inet loopback # The primary network interface auto ens33 #iface ens33 inet dhcp iface ens33 inet static # This value is an example address 192.168.1.10 # This value is an example netmask 255.255.255.0 # This value is an example network 192.168.1.0 # # This value is an example broadcast 192.168.1.255 # This value is an example gateway 192.168.1.1 # This value is an example dns-nameservers 126.96.36.199 188.8.131.52 # This value is an example
Restart the network service:
service networking restart
Restart the server.
In the case of Ubuntu 18 or higher, use the file present in /etc/netplan to set the static IP address.
Fully Qualified Domain Name (FQDN)#
Gluu must be deployed on a fully qualified domain name (FQDN), e.g.
https://my-gluu.server.com. Localhost is not supported.
In Linux, edit the hosts file and add the appropriate IP Address and FQDN. For example:
192.168.1.1, and the FQDN was
test.gluu.org, add this to all hosts files:
The Windows hosts file is located at
Amazon AWS instances provide a public and private IP address. While running the
/install/community-edition-setup/setup.py script, use the Private IP address. Also, use a hostname other than the long default hostname that Amazon provides as CN(Canonical Name). Update the DNS or hosts file accordingly.
Google Cloud Platform#
Gluu Server installation in GCP is pretty straight forward. We need to check a couple of points for this installation:
- Deployer must select supported operating system and required resources.
- Enable 'HTTPS' from 'Firewall'
- Do not enter any IP during the installation of Gluu Server, the setup script will automatically gather appropriate IP information.
- When accessing the newly installed Gluu server from a browser, update the DNS or hosts file accordingly.
A video tutorial is also available in the Gluu channel
Accessing the Gluu Server on Azure can be a little tricky because of the Public/Private IP. Azure assigns new Public/Private IP addresses each time the server is started.
Follow these steps to set up the VM on Azure:
Log into Windows Azure Administrative Panel
Create a Virtual Machine
From the menu, choose
Choose the operating system. Remember to set selinux to permissive if you choose CentOS.
Provide a name for the VM in the
Virtual Machine Namefield and use
Select a server with at least 4GB RAM in the
Provide a username/password to connect via SSH and upload an SSH certificate. Click
Create a new cloud service and select
Availability Setoption. * Endpoints Section: This is where port forwarding is set so that the internal IP address can be selectively reachable from the outside world. By default, only tcp /22 is there for SSH. The public ports for
https(tcp ports 80 and 443) have to be added and mapped to the same private ports. If the cloud mappings are flagged as conflicting, proceed without setting them. Remember to set them after the creation of the VM. Then, click
Choose not to install
VM Agentand click the
tickbutton to finalize the VM.
Go to the
Dashboardtab of VM Management Panel and copy the
DNS Name. This is the name that is used to access the Gluu Server.
SSH to the server and proceed with the installation.
Linode Virtual Machines (VM) use a custom kernel which is not supported by the Gluu Server, therefore the kernel must be updated before the Gluu Server can be installed in a Linode VM. The following steps will guide you through kernel update in the Linode VM.
Check for the current version of the kernel. If the output contains
-Linode, then proceed
# uname -a
Run the following command to update the kernel:
# apt-get install linux-image-virtual grub2
grubfile in the
# vim /etc/default/grub
Ensure that the following lines are present in the grub file
GRUB_TIMEOUT=10 GRUB_CMDLINE_LINUX="console=ttyS0,19200n8" GRUB_DISABLE_LINUX_UUID=true GRUB_SERIAL_COMMAND="serial --speed=19200 --unit=0 --word=8 --parity=no --stop=1"
Finally run the following commands to update
# update-grub # reboot