Initial Configuration

Last modified on November 28, 2022

This information applies to SwaggerHub On-Premise.

Once you deploy the SwaggerHub On-Premise virtual machine and activate your license, you will be taken to the System Configurations page where you can configure SwaggerHub.

The initial configuration includes only the minimal required settings:

  1. Your company name – The name of the company installing SwaggerHub. In SwaggerHub On-Premise 1.19.2 and later, the company name is used to generate the default organization name. Note that you will be able to rename the default organization later.

  2. DNS name for this server – The domain name or IP address assigned to this SwaggerHub instance, for example, swaggerhub.acme.com or 10.0.28.208. Users will use this domain name or IP address to access SwaggerHub, and the links in email notifications, mocks and elsewhere in the SwaggerHub application will also use this domain or IP.

    Usually, an IT administrator needs to assign a static IP address to a SwaggerHub VM and, optionally, assign a user-friendly domain name to that IP address. The SwaggerHub installer will attempt to detect the IP address during the installation, so, please make sure the IP address is externally accessible.

  3. Port for this server (in v. 1.20.0 and later) – Leave it blank unless you run SwaggerHub On-Premise on VirtualBox in the NAT mode. In the latter case, specify the host’s listening port that corresponds to the VM’s port 80.

    Note: In SwaggerHub On-Premise v. 1.19.3 and earlier, the port is specified in the DNS name for this server field as host:port.
  4. Administrator credentials:

    Option Description
    Username for the administrator of the server The admin username. 3 to 20 characters, allowed characters: A..Z a..z 0..9 - _ .
    Admin password The admin password. 7 - 32 characters long, with at least one lowercase letter and one digit.
    Admin email address The admin email address for notifications. If you are going to use single sign-on, use the same email address as in your identity provider.
  5. An SMTP email server for outgoing email. This is required to invite users and send email notifications.

    Option Description
    Notification email address The "From" address of email notifications, for example, swaggerhub@YourCompany.com or no-reply@YourCompany.com. Depending on the SMTP service you use, this may need to be a real address verified with the SMTP service provider. For example, Amazon SES requires that you verify the ownership of the From email address or the domain of this address.
    Notification email sender The "From" name used in email notifications. For example, SwaggerHub.
    SMTP Mail Host The SMTP server used for outbound email from SwaggerHub. For example, smtp.sendgrid.com.
    SMTP Mail Port The SMTP server port. The typical port numbers are 465 for SSL, 587 for STARTTLS, and 25 for unencrypted (plain) connections.
    SMTP Username and SMTP Password The username and password used to access the SMTP server.
    SMTP Protocol The type of the connection to the SMTP server: PLAIN, SSL, TLS (STARTTLS). Please check with your SMTP provider.

    If you are only trialling and would like to set up a temporary SMTP server, see the temporary SMTP examples.

    To test the email configuration, click Test Email Config. You will receive an email to the administrator email address in a few minutes. If you do not receive it, make sure the Admin email address is correct and check your junk folder.

  6. Send usage data to help improve SwaggerHub – Choose whether to send SwaggerHub On-Premise usage data to SmartBear. You can also disable or enable usage data collection at any time later through the Admin Center. For more information, see Usage Data Collection.

Other settings can be configured later in the Admin Center.

What’s next

Highlight search results