Deploying Configuration Changes

Last modified on June 01, 2023

Every time you change SwaggerHub On-Premise configuration settings on the Config page of the Admin Console, you need to deploy these changes for them to take effect. The procedure is as follows:

  1. In the Admin Console, scroll to the bottom of the Config page and click Save config.

    The 'Save config' button on the Config tab

    Click the image to enlarge it.

  2. In the message that appears, click Go to updated version.

    Click the image to enlarge it.

  3. You will be redirected to the Version history page of the Admin Console. The configuration change appears as a new sequence which starts preflight checks.

    Preflight check status

    Click the image to enlarge it.

    We recommend that you wait for the preflight checks to complete, but you can ignore them if you are sure that the configuration changes do not affect the checks. If so, skip to the next step.

    Otherwise, wait until the status becomes Ready to Deploy.

  4. Click Deploy.

    Deploying a configuration change

    Click the image to enlarge it.

  5. If the preflight checks are still running, you will see the corresponding warning. To skip the checks, click Ignore Preflights and deploy.

    If the checks have completed successfully, you will be prompted to confirm the deployment.

  6. Wait until the status becomes Deployed.

    In VM installations (with an embedded cluster), deploying a new configuration can take several minutes.

    Click the image to enlarge it.

See Also

Admin Console Overview
SwaggerHub 2.x Configuration

Highlight search results