Install SwaggerHub On-Premise on Azure

SwaggerHub On-Premise is available in the Azure Marketplace, so that you can quickly deploy SwaggerHub to the Azure cloud.


To deploy SwaggerHub On-Premise to Azure you need:

Create a SwaggerHub On-Premise virtual machine

  1. In the Azure portal sidebar, click Create a resource.

  2. Search for swaggerhub and select SwaggerHub Cloud in the search results.

    Creating a SwaggerHub VM in the Azure portal
  3. Click Create.

    Creating a SwaggerHub VM
  4. On the Basics page, specify the following options:




    Select your Azure subscription

    Resource group

    Click Create new and specify SwaggerHub as the resource group name. A resource group is a logical container that holds related resources for deployment.

    Virtual machine name

    Enter a name for your SwaggerHub VM


    Select the Azure region to deploy the VM to

    Availability options

    Optional – select if needed


    Leave as is


    The recommended VM size is E2s_v3 (selected by default), but you can use a different size if you wish. The selected VM size must have at least 2 VCPUs and at least 16 GB of memory.

    Authentication type

    SSH public key


    Enter a username for SSH access to your SwaggerHub VM.

    Note: The administrator username for the SwaggerHub application will be configured later during initial SwaggerHub configuration.

    SSH public key

    Paste your SSH public key

  5. Click Next : Disks.

  6. Leave all the options as is and click Next : Networking.

  7. Specify the networking options:



    Virtual network and Subnet

    Select the virtual network and subnet where the VM must be deployed, or create new ones.

    Public IP

    Azure automatically assigns a public IP address to the VM so that the VM can be accessed from the Internet. The IP address is dynamic by default. If you want a static IP, click Create new and change Assignment to Static.

    NIC network security group

    Leave as is. SwaggerHub VM image has preconfigured network security rules.

    Configure network security group

    Leave as is

    Accelerated networking

    Leave as is

    Load Balancing

    Select No. If you wish to set up a load balancer for SSL termination, you can do this later.

  8. Click Next : Management.

  9. Specify the following options:



    Boot diagnostics

    Optional – select if needed

    OS guest diagnostics

    Optional – select if needed

    Diagnostics storage account

    If you enabled boot diagnostics or OS guest diagnostics, select the storage account for diagnostic data

    System assigned managed identity


    Enable auto-shutdown


  10. Click Review + create, then Create.

  11. Wait until the VM is deployed. This may take a few minutes. You can track the deployment status via the notifications menu.

  12. After the VM has been deployed, click Go to resource.

    Deployment has complete
  13. Note down the public IP address of the VM.

    The public IP address of the SwaggerHub VM

    Click the image to enlarge it.

Configure SwaggerHub

  1. Navigate to http://<VM_IP>/ui to access the installer.

  2. Activate your license.

  3. Configure the basic system settings, including the admin username and password.


    If you have already configured a DNS name for the SwaggerHub VM, specify it in the DNS name for this instance option. Otherwise, specify the VM IP address in that option.

  4. Log in to the SwaggerHub Admin Center using the created admin user. Here you can configure additional system settings, such as single sign-on, HTTPS, and others.

After configuring the settings, you can access the SwaggerHub application at http://DNS_or_IP, and the SwaggerHub Admin Center at http://DNS_or_IP/ui.

You can also connect to the VM via SSH using the SSH user and key pair you specified when creating the VM.

Start using SwaggerHub

See Getting Started With SwaggerHub On-Premise.

See Also

Publication date: