Skip to content

Setup Script Options

Setup Prompt#

The setup.py script will bring up a prompt to provide information for certificate as well as the IP Address and the hostname for the Gluu Server. The prompt with example values is provided below.

Do you acknowledge that use of the Gluu Server is under the MIT license? [N|y] : y
Enter IP Address [192.168.122.60] :
Enter hostname [localhost] : e.g. idp.mydomain.info
Enter your city or locality : 
Enter your state or province two letter code : 
Enter two letter Country Code : 
Enter Organization Name : MyOrg
Enter email address for support at your organization : e.g. support@mydomain.com
Enter maximum RAM for applications in MB [3072] :
Optional: enter password for oxTrust and LDAP superuser [hlE3vzf0hMdD] :
Install oxAuth OAuth2 Authorization Server? [Yes] : 
Install oxTrust Admin UI? [Yes] : 
Install LDAP Server? [Yes] : 
Install Apache HTTPD Server [Yes] : 
Install Shibboleth SAML IDP? [No] : 
Install oxAuth RP? [No] : 
Install Passport? [No] : 
Install JCE 1.8? [Yes] : 
You must accept the Oracle Binary Code License Agreement for the Java SE Platform Products to download this software. Accept License Agreement? [Yes] :

If a resolvable DNS host is not used, then it must be added to the hostname of the Operating System hosts file on the server running the browser.

Warning

Please remove or encrypt the setup.properties.last file as it contains the clear text passwords for LDAP, admin user, keystores, and 3DES salt.

The errors can be found the the setup_errors.log file and a detailed step by step installation is found in the setup.log file under the /install/community-edition-setup folder.

Warning

Use a FQDN (fully qualified domain name) as hostname and refrain from using 127.0.0.1 as IP address or usage of private IP is not supported and not recommended.

Script Command Line Options#

The setup.py script can be used to configure your Gluu Server and to add initial data for oxAuth and oxTrust to start. If setup.properties is found in this folder, these properties will automatically be used instead of the interactive setup.

The administrator can use the following command line options to include additional components:

  • -a Install Asimba
  • -r Install oxAuth RP
  • -p Install Passport
  • -d specify the directory where community-edition-setup is located. Defaults to '.'
  • -f specify setup.properties file
  • -h invoke this help
  • -n no interactive prompt before install starts. Run with -f
  • -N no Apache httpd server
  • -s install the Shibboleth IDP
  • -u update hosts file with IP address/hostname
  • -w get the development head war files
  • -e Download JCE 1.8 and install it
  • --allow_deprecated_applications Give the option to install Asimba and OpenLDAP
  • --import-ldif=custom-ldif-dir Render LDIF templates from custom-ldif-dir and import them in LDAP
  • --listen_all_interfaces Allow the LDAP server to listen on all server interfaces. This is required for clustered installations to replicate between LDAP servers. If not enabled, the LDAP server listens only to localhost
  • --allow_pre_released_applications Enable options to install experimental features, not yet officially supported.

Example Command: # ./setup.py -as This command will install Gluu Server with Asimba and Shibboleth IDP.