Skip to content

World — Prerequisites

Packages

sudo apt update
sudo apt install -y \
  uuid-runtime \        # Generating UUIDs
  docker.io \           # Container runtime
  docker-compose-v2 \   # Compose file management
  unzip                 # Extracting the installation package

Docker

Add your user to the docker group and authenticate with the Synkzone registry:

sudo usermod -aG docker $USER
docker login registry.synkzone.com

Info

Registry credentials are provided by Synkzone. Contact your Synkzone sales representative to obtain access.

Email (optional)

Ensure SMTP credentials are available and the SMTP server is configured to accept connections from the World Server. See server.config and mailservice-credentials.properties for configuration details.

Info

Email is used for sending monitoring emails.

DNS

Record Type Record Name Record Value Purpose
A world.synkzone.example.com IP of World Server World

Warning

DNS records must be in place before deployment begins.

Info

For a complete example, see Examples.

Firewall

The following ports must be reachable on the World Server.

Source Destination Port Purpose
client network(s) IP of World Server 443 Client and Organization communication

Example

sudo iptables -A INPUT -p tcp --dport 443 -m comment --comment SynkzoneWorld -j ACCEPT

Info

For a complete example, see Examples.