For IT admins: understand the requirements for connecting Docs to your on-premise instance.
This article is intended for IT administrators who are installing an on-premise version of the Superhuman Docs Pack to their workspace. Docs supports on-premise Packs like Jira Data Center and GitLab Self-Managed, for instance.
While the install flows for each of these Packs are separate, each have common requirements to connect Superhuman Docs and your on-premise instance. This article will walk you through these requirements.
ℹ️ For step-by-step instructions on installing and connecting to the Jira Data Center Pack (for on-premise Jira instances), check out this article.
Enterprise admins: Enable Packs
Before we get started, an Enterprise org admin will first need to enable the ability to install the Pack. You can do this by going to docs.superhuman.com/docs > click on your account name (lower-left corner) > Admin settings > Pack approvals > All Packs, and searching for the specific Pack. If any of your workspace members have requested this Pack previously, you will see the requests on this page as well.
For full instructions on enabling and managing Packs in your Enterprise workspace, check out this article.
Requirements to access the On-Premise System
On-premise Packs have a common set of requirements to connect your on-premise service to Superhuman Docs.
Requirement #1: On-premise system must be served via HTTPS and have an SSL certificate signed by a public certificate authority. The fetcher only supports the HTTP protocol and requires that the connection be secured with SSL. This requirement ensures a secure connection to your on-premise system.
Requirement #2: On-premise system must have a publicly accessible hostname that resolves to an Internet-accessible IP address. Superhuman Docs requires a public IP address and hostname in order to access your on-premise system over the internet.
Requirement #3: If a firewall or VPN is used to secure access to the system at a network level, the IT administrator must add an IP allowlist so that Docs can access this system. In order to find the existing set of IP addresses, you can perform a DNS lookup on the domain egress.docs.superhuman.com. You can read more about how to do this in our developer documentation.