Examples
Tip
Edit the values in the table below — all references to them on this page will update automatically.
Example data
| Parameter | Value |
|---|---|
| World IP | |
| Organization IP | |
| World FQDN | |
| Organization FQDN | |
| UUID for main component | |
| UUID for World component | |
| UUID for API component | |
| UUID for Web component |
DNS records
World
| Record Type | Record Name | Record Value | Purpose |
|---|---|---|---|
| A | world.synkzone.example.com | 203.0.113.10 | World |
Organization
| Record Type | Record Name | Record Value | Purpose |
|---|---|---|---|
| A | szex4mpl318d4f4c9ba2e37f5c1b9d3e6a.world.synkzone.example.com |
203.0.113.20 | Organization (szDNS) |
| CNAME | acme.example.com | szex4mpl318d4f4c9ba2e37f5c1b9d3e6a.world.synkzone.example.com |
Web services (if enabled) |
| CNAME | szworld.acme.example.com |
world.synkzone.example.com | Organization registration in World |
Firewall rules
World
| Source | Destination | Port | Purpose |
|---|---|---|---|
| 0.0.0.0/0 | 203.0.113.10 | 443 | Client and Organization communication |
Organization
| Source | Destination | Port | Purpose |
|---|---|---|---|
| 0.0.0.0/0 | 203.0.113.20 | 80 | HTTP challenge for certificate renewal (if enabled) |
| 0.0.0.0/0 | 203.0.113.20 | 443 | TLS routes to Organization or web/API based on SNI |
Configuration
World
World component
ApplicationInstance=ex4mpl30-5c2e-4b8a-9f1d-3a7e6b4c2d8f
World=world.synkzone.example.com
SNTPServer=ntp.netnod.se
SNTPServerBackup=ntp.netnod.se
mailservice=true
mailservice.bounce=bounce@example.com
mailservice.domain=example.com
mailservice.reply=noreply@example.com
mailservice.sender=Synkzone
mailservice.smtp.host=mail.example.com
mailservice.smtp.port=587
mailservice.smtp.credentials=/config/mailservice-credentials.properties
mailservice.startup=admin@example.com
mailservice.monitoring=monitoring@example.com
username=smtp-user@example.com
password=secret
Organization
Main component
ApplicationInstance=ex4mpl31-8d4f-4c9b-a2e3-7f5c1b9d3e6a
World=world.synkzone.example.com
Organization=acme.example.com
AdminEmail=admin@example.com
TLSPort=443
SynkzoneWebAddress=acme.example.com
SNTPServer=pool.ntp.org
SNTPServerBackup=pool.ntp.org
otp.issuer=Synkzone
EmailTemplates=/email-templates
# Comma-separated UUIDs of the API and BFF components — required if using API or Web
TrustedNodeInstances=ex4mpl32-3a7f-4e1c-b8d5-2c9e4f7a1b3d,ex4mpl33-6b1e-4d8c-a5f2-9e3c7b4d2f1a
mailservice=true
mailservice.bounce=bounce@example.com
mailservice.domain=example.com
mailservice.reply=noreply@example.com
mailservice.sender=Synkzone
mailservice.smtp.host=mail.example.com
mailservice.smtp.port=587
mailservice.smtp.credentials=/config/mailservice-credentials.properties
mailservice.startup=admin@example.com
mailservice.monitoring=monitoring@example.com
remote_storage.enabled=true
remote_storage.bucket=ex4mpl31-8d4f-4c9b-a2e3-7f5c1b9d3e6a
remote_storage.provider=SafeSpring
remote_storage.endpoint=s3.sto2.safedc.net
remote_storage.credentials=/config/remote-storage-credentials.properties
username=smtp-user@example.com
password=secret
accessKey=EXMPL1234567890ABCD
secretKey=ExAmPlEsEcReTkEy1234567890abcdefghijkl
API component
ApplicationInstance=ex4mpl32-3a7f-4e1c-b8d5-2c9e4f7a1b3d
world=world.synkzone.example.com
organization=acme.example.com
ClientScope=SynkzoneSSI
StorageFileDirectory=/storage
ApplicationDataDirectory=/appdata
Web component
ApplicationInstance=ex4mpl33-6b1e-4d8c-a5f2-9e3c7b4d2f1a
world=world.synkzone.example.com
organization=acme.example.com
ClientScope=SynkzoneWeb
ApplicationDataDirectory=/appdata
StorageFileDirectory=/storage
SCIM component
com.synkzone.ssi.api.token=EXMPLscimApiToken1234567890abcdef
com.synkzone.azure.token=EXMPLazureSharedSecret1234567890
com.synkzone.preferred.language.code=en
# UPN domain used to classify users as internal (matched against user's UPN)
com.synkzone.organization.name.internal.users=customer.onmicrosoft.com
com.synkzone.organization.name.case.sensitive=false
com.synkzone.allow.creation.internal.users=true
com.synkzone.allow.creation.external.users=true
# Organization email domain — used with the use_left_side_of_upn email strategy
com.synkzone.organization.email=example.com
com.synkzone.email.strategy.internal=use_scim_email
com.synkzone.email.strategy.external=use_scim_email