DNS
Before deployment, the following DNS records must be created and provided to the team responsible for DNS registration:
- Four DNS records are required for each Synkzone World and Synkzone Organization.
- DNS records must be configured and accessible from the location where the deployment will occur.
- All records must use fully qualified domain name (FQDN)–compatible names.
- Ensure that DNS records are defined for both the World and the Organization.
Synkzone World
The world requires an A record.
The world name (FQDN-compatible) should point to the external IP of the host where it will run (VPS, cluster, or other infrastructure).
Synkzone Organization
Organization name must match a domain owned either by your company or the end customer.
- Internal Organization example:
internaldemo.<your-company-domain> - Customer Organization example:
synkzone.example.org
Required DNS Records for a Synkzone Organization
- Web/API address – The FQDN-compatible name of the organization, used to reach its web/API endpoints.
- szDNS record – Used by desktop clients to locate the organization. This must be registered by the owner of the world domain.
- World registration (CNAME) – Registers the organization on the Synkzone World and whitelists it. This must be configured to allow the world to recognize the organization.
Note: The Synkzone World name is reserved and cannot be used for a Synkzone Organization.
Standard Delivery
| Purpose | Record Type | DNS Record Example |
|---|---|---|
| Web services | A | <organization-fqdn> → external IP of Synkzone Web |
| Organization (szDNS) | A | sz<UUID of the main component without hyphens>.<world-domain> → external IP of Synkzone Organization |
| Organization registration in world | CNAME | szworld.<organization-fqdn> → <world-domain> |
If using the reference installation, where Synkzone Organization, Synkzone Web and Synkzone SSI are deployed on one VPS, the external IP of Synkzone Web and Synkzone Organization are the same.
Enterprise Delivery
| Purpose | Record Type | DNS Record Example |
|---|---|---|
| Web services | A | <organization-fqdn> → <INGRESS-IP> |
| Organization (szDNS) | A | sz<UUID of the main component without hyphens>.<world-domain> → <EXTERNAL-IP of nginx stream> |
| Organization registration in world | CNAME | szworld.<organization-fqdn> → <world-domain> |
Examples
Example 1 – Internal organization
Your company, XYZ, owns the domain xyz.com. You are creating an internal organization for your employees.
- World name:
synkzone-world.xyz.com - Organization name:
internal.xyz.com - Main component UUID:
dafca858-60e0-47c6-918c-e6b83e5db92a
Required DNS records:
- A record:
synkzone-world.xyz.com→ external IP of Synkzone World - A record:
internal.xyz.com→ external IP of Synkzone Web/Synkzone SSI - CNAME record:
szworld.internal.xyz.com→synkzone-world.xyz.com - A record:
szdafca85860e047c6918ce6b83e5db92a.synkzone-world.xyz.com→ external IP of Synkzone Organization
Example 2 – Customer organization
Your company, XYZ, owns the domain xyz.com. You are creating an Organization for a customer, Customer-A, who owns the domain customer-a.net.
- World name:
synkzone-world.xyz.com - Organization name:
synkzone.customer-a.net - Main component UUID:
2cc36a17-61ca-4c08-b565-2881b0431376
Required DNS records:
- A record:
synkzone-world.xyz.com→ external IP of Synkzone World - A record:
synkzone.customer-a.net→ external IP of Synkzone Web/Synkzone SSI - CNAME record:
szworld.synkzone.customer-a.net→synkzone-world.xyz.com - A record:
sz2cc36a1761ca4c08b5652881b0431376.synkzone-world.xyz.com→ external IP of Synkzone Organization