How to resolve an OpenLegacy API that fails to start

  • Make sure you have Java 17 to Java 21.
  • Make sure you have a connection to the OpenLegacy Hub:
    • If it's an SSL connection issue, please see the section How to resolve SSL connection Error when starting the OpenLegacy API.
    • Make sure your application YAML (/build/resources/main/application.yml) is configured correctly; see this section:
      ol:
        flow:
          hub:
            api-key: <VALID HUB API KEY>
            project-name: <VALID PROJECT NAME>
            url: <VALID HUB URL>
      
    • Ensure that the port is not taken; the default port is 8080. If it is, you can change it using the application YAML (/build/resources/main/application.yml).
      server.port: <DESIRED PORT NUMBER>
      
    • Make sure your license is valid. If the error indicates something regarding the license, please get in touch with the OpenLegacy support or CS team and ask for a new license. You can update the license in the application YAML (/build/resources/main/application.yml).
      ol.license.key: <OL LICENSE>