Skip to content

Organization — Prerequisites

Packages

sudo apt update
sudo apt install -y dnsutils            # dig command
sudo apt install -y uuid-runtime        # generating UUIDs
sudo apt install -y docker.io           # container runtime
sudo apt install -y docker-compose-v2   # compose file management
sudo apt install -y unzip               # extracting the installation package
sudo apt install -y nginx               # reverse proxy and TLS passthrough routing
sudo apt install -y libnginx-mod-stream # nginx stream module for SNI-based routing

User

Create a dedicated synkzone user and add it to the docker group:

sudo adduser synkzone
sudo usermod -aG docker synkzone

Docker Registry

Authenticate with the Synkzone registry as the synkzone user:

su - synkzone
docker login registry.synkzone.com
exit

Info

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

Plugins

See Plugins for optional additions and their prerequisites, such as Email, Remote Storage, and Identity Provider.

DNS

The Organization FQDN must match a domain owned by your company or the end customer. The World Server FQDN is reserved and cannot be used as an Organization FQDN.

Record Type Record Name Record Value Purpose
A sz<main-UUID-without-hyphens>.world.example.com IP of Organization Server Organization (szID)
A example.com IP of Organization Server Web services
CNAME szworld.example.com world.example.com Organization registration in World

Note

  • The <main-UUID-without-hyphens> in the szID record corresponds to the main component UUID generated in Installation — step 3.
  • The CNAME record does double duty: it tells the World which Organization it is, and it authorizes the Organization to register with that World. No separate registration step is required.

Warning

DNS records must be in place before installation begins. For a complete example, see Configuration Examples.

Web Certificate

The web component requires a trusted TLS certificate. If you don't have one, you can issue it via Let's Encrypt:

Example

sudo apt install -y certbot
sudo certbot certonly --webroot -w /var/www/html -d example.com

Note

The certificate must be issued for the same domain as SynkzoneWebAddress in main/config/server.config.

Firewall

See Network & Connectivity for which ports are used and why.

Source Destination Port Purpose
Client network(s) Organization Server TCP/443 Application traffic
World Server Organization Server TCP/443 Organization monitoring
0.0.0.0/0 Organization Server TCP/80 HTTP-01 challenge (if using Let's Encrypt)

Example

sudo iptables -A INPUT -p tcp -m tcp --dport 80 -m comment --comment LetsEncrypt -j ACCEPT
sudo iptables -A INPUT -p tcp -m tcp --dport 443 -m comment --comment SynkzoneOrganization -j ACCEPT