Custom Domains
Serve your application on your own domain with automatic TLS.
You can configure a custom domain (like app.example.com) to point to your Convoy Cloud application. Convoy Cloud handles TLS certificate provisioning automatically via Let's Encrypt.
Adding a custom domain
- Navigate to Domains in the sidebar.
- Click Add Domain.
- Enter your domain name (e.g.,
app.example.comorexample.com).
Configuring DNS
After adding your domain, Convoy Cloud shows the DNS record you need to create at your DNS provider:
Subdomain (e.g., app.example.com)
Create a CNAME record:
| Type | Name | Value |
|---|---|---|
| CNAME | app | ingress.codeship.site |
Apex domain (e.g., example.com)
Create an A record:
| Type | Name | Value |
|---|---|---|
| A | @ | 84.247.168.74 |
Domain verification
After configuring DNS, Convoy Cloud verifies that the domain resolves correctly. The domain goes through these statuses:
| Status | Meaning |
|---|---|
| Pending Verification | DNS record not yet detected. Convoy Cloud rechecks pending domains roughly every two minutes. Refresh the Domains page to see the latest status. |
| Verified | DNS is configured correctly. Ready to assign to an app. |
| Pending SSL | TLS certificate is being provisioned. |
| Active | Domain is fully configured with TLS. Traffic is being served. |
| Error | Something went wrong. Check your DNS configuration. |
DNS propagation can take up to a few minutes, depending on your DNS provider. If a domain stays in Pending Verification for more than a few minutes, verify the DNS record with dig before troubleshooting further.
If verification has not succeeded within two hours, Convoy Cloud marks the domain as Error. Remove and re-add the domain to restart the process.
Assigning a domain to an application
Once a domain is verified, you can assign it to any application in your workspace:
- On the Domains page, find your verified domain.
- Click Assign to App.
- Select the application from the dropdown.
Your application is now accessible at both its *.codeship.site URL and your custom domain.
Removing a custom domain
To remove a custom domain:
- Go to Domains.
- Click the remove action on the domain.
- The TLS certificate and ingress rule are automatically cleaned up.
You should also remove the DNS record at your DNS provider.
Troubleshooting
- Domain stuck on "Pending Verification" -- ensure your DNS record is correct and has propagated. Use
digor a DNS checker to verify. - Domain stuck on "Pending SSL" -- certificate provisioning can take a few minutes. If it stays in this state for more than 10 minutes, check that port 80 is not blocked for your domain (needed for ACME challenge).
- SSL certificate errors -- Convoy Cloud uses automatically renewed TLS certificates. If you see certificate warnings, try removing and re-adding the domain.
Under the hood TLS certificates for custom domains are issued by Let's Encrypt and managed by cert-manager.