SwaggerHub On-Premise is initially accessible over HTTP (non-secure connection). Secure HTTPS access can be achieved in two ways:
-
Install an SSL certificate to your SwaggerHub instance (requires v. 1.18.5 or later).
-- OR --
-
Configure a load balancer with SSL termination in front of your SwaggerHub instance.
| Note: | Self-signed SSL certificates are supported starting with SwaggerHub On-Premise 1.18.6. |
Which method to use?
Built-in HTTPS
Advantages:
-
Easy to configure: simply upload your certificate and private key in the PEM format, and you are ready to go!
-
HTTP will be redirected to HTTPS automatically.
Follow these links to learn how to install an SSL certificate:
Load balancer with SSL termination
Advantages:
-
Leverages your existing infrastructure. For example, if you use AWS to manage your infrastructure, including SSL certificates and DNS entries, setting up an AWS load balancer will let you easily reuse wildcard SSL certificates already stored in AWS.
Limitations:
-
If HTTP-to-HTTPS redirection is required, it needs to be implemented on the load balancer.
Learn how to configure a load balancer for SwaggerHub On-Premise.
See Also
Enabling HTTPS/SSL in SwaggerHub On-Premise
Setting a Static IP Address
Proxy Settings
Certificate Manager