Custom Domains

If you've deployed the Sublime Platform via our AWS CloudFormation deployment, it's simple to set up a custom domain for your instance, such as sublime.example.com:

  1. In the AWS console, navigate to the same region in which you deployed the Sublime Platform
  2. Request a public certificate for the custom domain you want to use through AWS Certificate Manager
  3. In the EC2 Load Balancers interface, locate the Sublime-Platform-ALB load balancer CloudFormation created for you and add the certificate you created to the load balancer's HTTPS listener
  4. Create a CNAME DNS record pointing your custom domain to the load balancer's DNS name (which should start with Sublime-Platform-ALB-)
  5. Copy the ARN for the certificate you set in step (4). Navigate to AWS Systems Manager and then Parameter Store. Select the /sublime-security/self-signed-acm-certificate-for-sublime-platform parameter and click Edit. Replace the current value with the ARN of your new certificate and Save Changes.

That's it!


Setting up a domain for Track Link Clicks Action and Quarantine Digests

When enabling Track Link Clicks Action or Quarantine Digests, you will need to setup a subdomain to use for the redirect traffic. Follow these steps:

  1. In the AWS console, navigate to the same region in which you deployed the Sublime Platform
  2. Request a public certificate for the custom click tracking domain you want to use through AWS Certificate Manager. For example clicks.sublime.myorg.com where myorg.com is a domain you own (e.g. you might have sublime.myorg.com for the Sublime UI).
  3. In the EC2 Load Balancer interface, locate the Sublime-Click-Tracking-ALB load balancer CloudFormation created for you and add the certificate you created to the load balancer's HTTPS listener.
  4. Create a CNAME DNS record pointing your custom domain to the load balancer's DNS name (which should start with Sublime-Click-Tracking-ALB-)
  5. Copy the ARN for the certificate you set in step (4). Navigate to AWS Systems Manager and then Parameter Store. Select the /sublime-security/click-tracking-acm-certificate parameter and click Edit. Replace the current value with the ARN of your new certificate and Save Changes.
  6. Set the redirect service DNS name. This can be done on the Track Link Clicks Action page or via a direct API call to PATCH /v1/orgs/mine/settings with {"url_defense_base_url": "https://<your-redirect-service-dns-name>"}.
    1. (For Quarantine Digests only) Update the ALB's path pattern to include the quarantine digest path.  On the AWS Load Balancer Detail page under Listeners and rules, find the HTTPS:443 listener and update the rule Priority 10 ("Forward to Target Group")'s path pattern conditions to include /v1/quarantine-digest/* in addition to the existing /v1/ping and /v1/link-click* path patterns. (Note that this is a temporary workaround which should become unnecessary in a pending update).