Supported Platforms and Requirements for SwaggerHub On-Premise
SwaggerHub On-Premise can be installed on:
AWS (r5.large or similar)
Azure (E2s_v3 or similar)
VirtualBox running on a bare-metal server
Note
VirtualBox running on a VM is not supported.
System requirements
A SwaggerHub On-Premise virtual machine must have the following hardware configuration:
Dual-core CPU
16 GB of memory
200 GB disk storage
Additional requirements:
An SMTP server is required to send email from SwaggerHub. Trial users can use a temporary SMTP server.
The license can be activated online or offline. Online license activation requires that the VM be able to connect to
activation.smartbear.comon port 443 (HTTPS).SwaggerHub On-Premise cannot run in the
172.18.0.0/16(172.18.*.*) subnet. This subnet is used internally by the SwaggerHub On-Premise VM.
Please make sure that:
The host network does not change during the installation.
Both the host server and the SwaggerHub VM have the correct date and time set, preferably via NTP. Time zone errors or time differences may cause some SwaggerHub features to stop functioning.
Installation
The installation process is straightforward:
Get the license file from SmartBear.
Deploy the VM:
During the installation process, you will also create an admin account that will be used to configure your SwaggerHub On-Premise instance through the Admin Center.
Usage notes
SSH access
We recommend that you add at least one SSH user. SSH users can be added via the Admin Center. The instances launched in AWS and Azure also have a default SSH user created at launch time.
Firewall rules
SwaggerHub On-Premise uses iptables as the system firewall. All outbound ports are open by default.
If you need to update the iptables rules on your instance, please contact SmartBear Support.
Note
SwaggerHub On-Premise is not compatible with Uncomplicated Firewall (UFW). Do not enable UFW on your instance or use it to edit firewall rules.
Upgrade notes
Refer to the Upgrade Guide for information about upgrading an existing SwaggerHub On-Premise instance. To learn about new features in the current and previous releases of SwaggerHub, see the Release Notes.