PeopleSync Documentation

PeopleSync Prerequisites

The following system requirements apply to the PeopleSync components. Requirements are shown separately for the PeopleSync Service, Frontend Server, Database, and Console.

Supported Platform Overview

Requirement

Service

Frontend

Database

Console

x64 CPU architecture

Required

Required

Required

Required

Minimum system memory

8 GB

8 GB

According to SQL Server sizing

8 GB

Minimum free disk space

10 GB

10 GB

According to database sizing

10 GB

Operating system

Windows Server 2019, 2022, or 2025

Windows Server 2019, 2022, or 2025

Operating system supported by the selected SQL Server version

Windows 11 or a supported Windows Server version

Microsoft .NET 10 x64

Required

—

—

.NET Desktop Runtime required

Microsoft IIS

—

Required

—

—

Microsoft SQL Server

Database access required

Database access required

SQL Server 2019, 2022, or 2025

Database access required

Lifecycle policy: Before installation or upgrade, verify that Windows Server, SQL Server, .NET, directory services, and all other dependencies remain in vendor mainstream support or extended support. Do not deploy PeopleSync on end-of-life software.

All roles may be installed on one server or distributed across dedicated systems. A combined system must satisfy the requirements of every installed role. Additional CPU, memory, and storage may be required depending on the number of contacts, address lists, clients, and synchronization jobs.

User Directory

PeopleSync does not maintain its own user directory. Users authenticate through an existing enterprise LDAP directory, and directory-group membership controls access to address lists.

The following directory types are supported:

  • Microsoft Active Directory

  • Microsoft Active Directory Lightweight Directory Services (AD LDS)

  • NetIQ eDirectory

Microsoft Active Directory

Nested group memberships are evaluated when Microsoft Active Directory is used as the user directory.

  • Setup user: A Windows user account with local administrative permissions on each PeopleSync server where components are installed.

  • PeopleSync Service Account: An Active Directory user account.

  • PeopleSync Admin Group: An Active Directory group. The recommended default name is “PeopleSync Admins”.

  • Address-list groups: Assign each address list through a dedicated Active Directory group. Default groups such as “Domain Users” are not supported for this purpose.

Active Directory domain membership is required only when the selected deployment or authentication method depends on it.

NetIQ eDirectory

PeopleSync uses the following attributes and object classes:

User object:

  • objectClass: inetOrgPerson

  • User-name attribute: uid

  • Group-membership attribute: groupMembership

The groupMembership attribute must list every membership that PeopleSync is expected to evaluate. Users authenticate with their uid.

Group object:

  • objectClass: groupOfNames

  • RDN: cn

Only direct group memberships are evaluated; nested groups are not supported.

Microsoft AD LDS

PeopleSync uses the following attributes and object classes:

User object:

  • objectClass: user

  • User-name attribute: userPrincipalName

  • Group-membership attribute: memberOf

The memberOf attribute must list every membership that PeopleSync is expected to evaluate. Users authenticate with their userPrincipalName.

Group object:

  • objectClass: group

  • RDN: cn

Only direct group memberships are evaluated; nested groups are not supported.

PeopleSync Service

Hardware

  • x64 CPU architecture

  • 8 GB RAM

  • 10 GB free disk space

Software and Access

  • Microsoft Windows Server 2019, 2022, or 2025 with current security updates and within Microsoft mainstream or extended support.

  • Microsoft .NET 10 x64.

  • Network access to the PeopleSync Database, PeopleSync Frontend, configured directory services, and configured source systems.

PeopleSync Frontend Server

Hardware

  • x64 CPU architecture

  • 8 GB RAM

  • 10 GB free disk space

Software and Access

  • Microsoft Windows Server 2019, 2022, or 2025 with current security updates and within Microsoft mainstream or extended support.

  • Microsoft Internet Information Services (IIS).

  • Network access to the PeopleSync Database and the configured LDAP directory.

  • A trusted TLS server certificate for production CardDAV synchronization.

Multiple load-balanced Frontend Servers may be deployed when additional capacity or availability is required.

PeopleSync Database

PeopleSync requires Microsoft SQL Server 2019, 2022, or 2025 while the selected version remains in Microsoft mainstream support or extended support. Express, Standard, and Enterprise editions are supported. The database may be local or hosted on a dedicated database server.

  • Enable SQL Server Mixed Mode Authentication and the TCP/IP protocol.

  • The setup user requires database owner (dbo) permissions in the PeopleSync database.

  • If the setup user has the necessary SQL Server permissions, setup creates the PeopleSync database. Otherwise, create the database before running setup.

  • The PeopleSync Frontend requires a SQL Server login with access to the PeopleSync database. It must not be a Windows account. The recommended default login name is psweb.

  • Size CPU, memory, and storage according to Microsoft SQL Server requirements and the expected number of contacts, address lists, clients, and synchronization jobs.

PeopleSync Console

Hardware

  • x64 CPU architecture

  • 8 GB RAM

  • 10 GB free disk space

Software and Access

  • Microsoft Windows 11 or Microsoft Windows Server 2019, 2022, or 2025 with current security updates and within Microsoft mainstream or extended support.

  • Microsoft .NET 10 Desktop Runtime x64.

  • Local administrative permissions are required to install PeopleSync components.

  • Network access to the PeopleSync Database and the configured directory service.

Network Requirements

Allow only the connections required for the installed PeopleSync roles and configured agents. The following table lists the required source, target, port, protocol, and TLS behavior.

Ports

Source

Target

Port/Protocol

SSL/TLS enabled

Description

CardDAV Client

Frontend

443 or 8843/TCP

always

Sync, https CardDAV

Backend

Frontend

443 or 8843/TCP

always

Sync, https CardDAV

Backend

Frontend

88/TCP

-

Sync, http CardDAV (Default Configuration)

Frontend

Active Directory

3268/TCP

when SSL disabled in System Settings

Authentication, Active Directory GC

Frontend

Active Directory

389/TCP

when SSL disabled in System Settings

Authentication, Active Directory

Frontend

Active Directory

3269/TCP

when SSL enabled in System Settings

Authentication, Active Directory GC

Frontend

Active Directory

636/TCP

when SSL enabled in System Settings

Authentication, Active Directory

Frontend

SQL Server

1433/TCP


Data access, SQL Server Database *

Console

SQL Server

1433/TCP


Configuration, SQL Server Database *

Console

Active Directory

389/TCP

when SSL disabled in System Settings

User & group lookup, Active Directory

Console

Active Directory

3268/TCP

when SSL disabled in System Settings

User & group lookup, Active Directory

Console

Active Directory

636/TCP

when SSL enabled in System Settings

User & group lookup, Active Directory

Console

Active Directory

3269/TCP

when SSL enabled in System Settings

User & group lookup, Active Directory

Backend

SQL Server

1433/TCP


Data access, SQL Server Database *

Backend (AD Agent)

Active Directory

389/TCP

when no Port is specified

Load Contacts, Active Directory

Backend (AD Agent)

Active Directory

636/TCP

when Port 636 specified as part of hostname

Load Contacts, Active Directory

Backend (Azure AD Agent)

Microsoft Graph API

443/TCP

always

Load Contacts, Azure Active Directory

Backend (GAL Agent)

Exchange Server / Office 365

443/TCP

always

Load Contacts, Exchange Remote PowerShell

Backend (Exchange Folder Agent)

Exchange Server / Office 365

443/TCP

always

Load Contacts, Exchange EWS API

Backend (Salesforce Agent)

Salesforce

443/TCP

always

Load Contacts, Salesforce

Backend (Microsoft CRM Agent)

Microsoft CRM

443/TCP

always

Load Contacts, Microsoft CRM

Backend (SharePoint Agent)

Microsoft SharePoint

443/TCP

always

Load Contacts, SharePoint

Backend (Database Agent)

Database Servers

DB-specific

DB-specific

Load Contacts, Depends on Database Type

* Only for single instance. For multiple instances, please see
Configure the Windows Firewall to allow SQL Server access

Further Requirements

TLS certificate: A TLS server certificate is required for device synchronization. For evaluation environments, setup can create a self-signed certificate. Production environments require a certificate trusted by the connecting clients.

Data-source accounts: Each configured source system requires an account with sufficient read permissions for the contacts PeopleSync imports. PeopleSync agents read from source systems and do not write changes back.