Older versionVersion 2.2 SolutionsChange HTTP port for PhenixID Server

Change HTTP port for PhenixID Server

This article will describe how to change HTTP port used by PhenixID Server.

When making changes to the configuration, please make sure to have backup of the file/files.

System requirements

  • PhenixID Server installed.

Overview

The port used by PhenixID Server can be set during installation.

This port is set for the default prism module used for the administration GUI.

If the port needs to be changed after installation, please follow the instructions in the section "Change port for default prism module used for the administration GUI".

There is no user interface to change boot configuration - you’ll need to edit the configuration (boot.json) manually.

If other prism modules is used, like MFA Admin or Self Service, they will by default use port 8443. If this is not a desired port please follow the instructions in the section "Change port for MFA Admin and/or Self Service". This change will be made using the configuration GUI.

Change port for default prism module used for the administration GUI

Locate the boot configuration

The boot configuration file is located in the config directory:

<SERVER_ROOT>/config/boot.json

Note: <SERVER_ROOT> refers to the directory where PhenixID Server is installed.

Backup

Make a backup copy of the file/files in case you’ll need rollback your changes.

Change port

Open the PhenixID Server boot configuration in your favorite text editor and locate "port" : "8443" in module com.phenixidentity~phenix-prism and com.phenixidentity~auth-http

Replace the default port number 8443 with desired port number.

{
            "module": "com.phenixidentity~phenix-prism",
            "enabled": true,
            "config": {
                "base_url": "/config",
                "enable_language" : "false",
                "ssl":"true",
                "port":"8443",
                "enable_module_deployment": true,
                "enable_roles": "true",
                "enable_language": "false",
                "display_name": "Configuration Manager",
                "prism_modules": [{
                    "name": "com.phenixidentity~phenix-prism-start",
                    "config": {
                        "display_name": "Start",
                        "base_uri": "start",
                        "requires_role": "sysadmin"
                    }
                }, {
							"name": "com.phenixidentity~phenix-prism-report",
							"enabled": "true",
							"config": {
								"display_name": "Reports",
								"base_uri": "report",
								"requires_role": "sysadmin"
							}
						},{
                    "name": "com.phenixidentity~phenix-prism-guides",
                    "config": {
                        "display_name": "Scenarios",
                        "base_uri": "scenarios",
                        "requires_role": "sysadmin"
                    }
                }, {
                        "name": "com.phenixidentity~phenix-prism-config",
                        "enabled": "true",
                        "config": {
                            "display_name": "Advanced",
                            "base_uri": "configuration",
                            "requires_role": "sysadmin"
                        }
                    }]
            }
        },{
            "module": "com.phenixidentity~auth-http",
            "enabled": true,
            "config": {
                "ssl":"true",
                "port":"8443",
                "web_root": "webroot/authentication/web"
            }

Save the file and restart PhenixID Server.

Change port for MFA Admin and/or Self Service

To change the port for MFA Admin or Self Service, first go through the Scenario in question. When this is done go into the administration GUI, Scenarios, Applications, MFA Admin/Self Service and then the "Advanced" tab.

Now click "Use custom listener", set the desired port and enable SSL if suitable. Refresh the page and you should now see the new port in the URL at the top of the right column.