Getting Started

Welcome to CloudSync. This guide walks you through everything you need before deploying your VM from the Azure Marketplace.

---

Prerequisites

• An active Azure subscription

• A CloudSync license key (CS-XXXX-XXXX-XXXX-XXXX)

• A domain you control (e.g. sync.yourcompany.com) with the ability to add DNS records

---

Step 1 — Create an App Registration

CloudSync uses an Azure App Registration to authenticate your users via Microsoft Entra ID (Azure AD). You only need to do this once.

1.1 Create the registration

1. Navigate to the Azure Portal

2. Go to Microsoft Entra ID → App registrations → New registration

3. Fill in the form:

   • Name: CloudSync (or any name you prefer)

   • Supported account types: Accounts in this organizational directory only

   • Redirect URI: Leave blank for now — you'll add this after deployment

4. Click Register

Copy the Application (client) ID shown on the overview page — you'll need it during first login.

---

1.2 Configure API permissions

Go to API permissions → Add a permission → Microsoft Graph → Delegated permissions and add the following:

Permission	Type	Description
email	Delegated	View users' email address
openid	Delegated	Sign users in
profile	Delegated	View users' basic profile
User.Read	Delegated	Sign in and read user profile

Once added, click Grant admin consent for [your organization] and confirm.

All four permissions should show a green Granted status before proceeding.

---

1.3 Create a client secret

1. Go to Certificates & secrets → New client secret

2. Set a description (e.g. cloudsync-vm) and an expiry

3. Click Add

4. Copy the secret value immediately — it won't be shown again

Store the client secret securely. You will be prompted to enter it on first SSH login to your VM.

---

Step 2 — Deploy from Azure Marketplace

1. Find CloudSync in the Azure Marketplace and click Deploy

2. Fill in the deployment form:

   • Domain — the domain where CloudSync will be accessible (e.g. sync.yourcompany.com)

   • VM size, networking, and credentials as required

3. Click Review + create → Create

Azure will provision the VM and write your configuration automatically. This takes roughly 2–3 minutes.

---

Step 3 — Point your DNS

Once the VM is deployed, navigate to the created Public IP resource in the Azure Portal and copy the IP address.

Add the following DNS record with your DNS provider:

Type	Name	Value
A	sync (or your chosen subdomain)	<your VM public IP>

DNS propagation can take a few minutes. CloudSync will configure TLS automatically once the domain resolves.

---

Step 4 — First Login

SSH into your VM using the credentials you set during deployment:

ssh <admin-username>@<your-vm-ip>

The setup wizard will launch automatically. You'll be prompted for:

Prompt	Where to find it
App Registration ID	Azure Portal → App registrations → your app → Overview → Application (client) ID
App Client Secret	The secret value you copied in Step 1.3
License Key	Your CloudSync license (CS-XXXX-XXXX-XXXX-XXXX)

The installer will run for approximately 10–15 minutes. Once complete, CloudSync will be live at https://<your-domain>.

---

Step 5 — Add the Redirect URI

After deployment, go back to your App Registration and add the redirect URI:

1. Authentication → Add a platform → Web

2. Set the redirect URI to: https://<your-domain>/auth/callback

3. Click Save

---

Managing Your Instance

Once installed, every SSH session will greet you with:

✓ CloudSync is installed. Use 'sudo cloudsync-maintenance' to manage.

Run sudo cloudsync-maintenance for status, logs, restarts, and updates.

---

Need Help?

Contact support at [email protected] or visit the CloudSync documentation.