Skip to main content

Changing the Keycloak Port

PoolParty comes with Keycloak as an authentication and authorization service. You can change the port on which Keycloak is running by modifying the relevant configuration files.

  1. Stop all PoolParty services:

    1. Linux: /opt/poolparty/bin/poolparty stop

    2. Windows: you have to manually stop the two services running (the Apache Tomcat and the Solr PoolParty service).

      First open the Windows Start Menu and type "Services" in the Search field. This opens the Services window listing all Windows services. Now select the respective service and right click on it to open the context menu; then click Stop to manually stop the selected service. You can also use the menu bar and the menus to stop the services. This operation requires Windows administrator rights.

  2. Open the Keycloak configuration file:

    1. Linux: /opt/poolparty/auth_service/keycloak/conf/keycloak.conf

    2. Windows: C:\opt\poolparty\auth_service\keycloak\conf\keycloak.conf

  3. Change the port number in the http-port property.

    Caution

    The port to which you are changing to must be free.

    For example, if you want to change the port from 8181 to 8000, change it to http-port=8000.

  4. If you run Keycloak in production:

    1. rebuild Keycloak:

      1. Linux: /opt/poolparty/auth_service/keycloak/bin/kc.sh build

      2. Windows: C:\opt\poolparty\auth_service\keycloak\bin\kc.bat build

    2. start Keycloak to verify that is starts without any problems:

      1. Linux: /opt/poolparty/auth_service/keycloak/bin/kc.sh start

      2. Windows: C:\opt\poolparty\auth_service\keycloak\bin\kc.bat start

  5. Open the Keycloak configuration files for the individual PoolParty components (admin-keycloak.json, ppgs-keycloak.json, ppt-keycloak.json, ppx-keycloak.json):

    1. Linux: /opt/poolparty/config/keycloak

    2. Windows:C:\opt\poolparty\config\keycloak

  6. Change the port to match the port number you specified in step 3.

  7. If you run PoolParty on Linux:

    1. Open the poolparty.conf file: /opt/poolparty/config/poolparty.conf

    2. Change the port number in the PP_auth_server_url property to match the port number you specified in step 3.

  8. Start all PoolParty services:

    1. Linux: /opt/poolparty/bin/poolparty start

    2. Windows: you have to manually start the two previously stopped services (the Apache Tomcat and the Solr PoolParty service).

      First open the Windows Start Menu and type "Services" in the Search field. This opens the Services window listing all Windows services. Now select the respective service and right click on it to open the context menu; then click Start to manually start the selected service. You can also use the menu bar and the menus to start the services. This operation requires Windows administrator rights.