Skip to content

Architecture Overview

Architecture

The Synkzone system consists of one World and one or more Organizations.

World

The World is the trust anchor and PKI root of the system. It issues certificates that authorize organizations to operate and provides the registration and discovery endpoint used by clients and organizations to locate each other. A single World can host multiple Organizations.

A World consists of the following components:

Name Components Required Reference installation Description
World world Yes Yes Core World service

Tip

Synkzone operates a World at world.synkzone.com. Operators who only need to deploy Organizations can register against this hosted World instead of running their own. Contact support for more information.

Organization

The Organization is the central service for users, zones, and files. It coordinates synchronization, storage, and access control. Each Organization is registered in and discovered through a World.

An Organization consists of the following components:

Name Components Required Reference installation Description
Main main Yes Yes Core Organization service
Web web + bff No Yes Frontend and backend-for-frontend enabling web client access and shared links
API api No No Exposes the Synkzone API for external integrations
SCIM scim No No Automated user and group provisioning

Note

Optional components can be deployed independently of each other with the exception of scim which depends on api.

Connectivity

Clients contact the World during Organization discovery, then connect directly to the Organization.

Info

For concrete DNS names, IP addresses, and port numbers, see Examples.

Backup

Backup is the responsibility of the operator. The standard delivery reference installation is suited for a complete VM snapshot as the backup strategy.