Introduction & Quick Start

Welcome to the official documentation for the Nextcloud Exchange Connector.

What is the Connector?

The connector is a decoupled, high-performance microservice designed to run in the background. It acts as a bidirectional protocol translator, automatically synchronizing Calendars and Contacts between Nextcloud (CalDAV/CardDAV) and Microsoft Exchange (Exchange Web Services) without impacting your Nextcloud web server's performance.

Quick Onboarding

To get your synchronization engine running as quickly as possible, follow this exact sequence:

Step 1: Preparation (Authentication)

You cannot start the application without access keys. First, configure your environments to generate your credentials.

Go to: Configuring Exchange Web Services (EWS) OR Configuring Exchange On-Premise
Go to: Configuring Nextcloud

Step 2: Installation (Deployment)

Once you have your Microsoft and Nextcloud credentials, deploy the worker service using your preferred infrastructure.

Go to: Installation Guides [TO INSERT THE SUBCATEGORY LINK HERE AFTER FULL DOCUMENTATION APPROVAL]

Step 3: Verification (Logging & Monitoring)

Verify that the service is running.

Go to: Logging & Monitoring [TO INSERT THE SUBCATEGORY LINK HERE AFTER FULL DOCUMENTATION APPROVAL]

Step 4: Granting User Access

Instruct your users to activate their synchronization.

Go to: Granting User Access (Consent Flow)

Where to Find What You Need

Jump directly to the guide that solves your current problem:

"I need to configure Microsoft 365 / Azure AD..."
Read: Configuring Exchange Web Services (EWS)

"I need to configure Exchange 2016/2019..."
Read: Configuring Exchange On-Premise
"Synchronization is slow or takes longer than expected"
Read: Managing Service Accounts (admins.json)
"I want to change what data gets synced..."
Read: Configuring the .env File
"I am upgrading from the legacy application..."
Read: Migrating from Legacy
"I want to understand how the backend works..."
Read: Understanding the Architecture

Key Concepts & Best Practices

To ensure a stable deployment, remember that your .env file is your Single Source of Truth for all configurations. For large deployments, we highly recommend using multiple service accounts to scale your synchronization throughput.

For a deeper dive into how the backend engine and scaling work, read our Understanding the Architecture article.

Support & Troubleshooting

If the synchronization stops or the container fails to start:

Check the Logs First: The application uses Serilog to output highly detailed diagnostics. Depending on your .env configuration, check your Docker console, file system, or Grafana dashboard.
See Logging & Monitoring [TO INSERT THE SUBCATEGORY LINK HERE AFTER FULL DOCUMENTATION APPROVAL] to know more about supported logging options and exact commands.

Verify the Shared Secret: The #1 cause of deployment failure is a typo in the SharedSecret between Nextcloud and the .env file.
Contact Support: If you cannot resolve the issue, gather your log files (ensuring no sensitive personal data is included) and open a ticket with the Sendent Support Desk.

Next Step

Choose your platform: Configuring Exchange Web Services (EWS) OR Configuring Exchange On-Premise