software:chipmunk:getting_started
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| software:chipmunk:getting_started [2025/07/01 11:23] – support@smikar.com | software:chipmunk:getting_started [2025/08/20 16:51] (current) – [Prerequisites] support@smikar.com | ||
|---|---|---|---|
| Line 11: | Line 11: | ||
| Chipmunk is designed for IT administrators and businesses that want a simple, affordable, and automated way to archive Microsoft 365 user data once employees leave the organization. | Chipmunk is designed for IT administrators and businesses that want a simple, affordable, and automated way to archive Microsoft 365 user data once employees leave the organization. | ||
| - | When a user account is disabled in Entra ID: | + | When a user account is disabled in Entra ID, the following is archived to your Azure Blob Storage Account: |
| - | * Their **OneDrive** files are backed up to Azure Blob. | + | * Their **OneDrive** files are archived. |
| * Their **Exchange** emails are archived. | * Their **Exchange** emails are archived. | ||
| - | * Their **Microsoft Teams** chats and messages are preserved. | + | * Their **Microsoft Teams** chats and messages are archived. |
| * Data is stored under your control in your Azure tenant. | * Data is stored under your control in your Azure tenant. | ||
| * Easy recovery options are available later if required. | * Easy recovery options are available later if required. | ||
| - | ===== Chipmunk Architecture ===== | ||
| - | Chipmunk | + | ===== Prerequisites ===== |
| - | * PowerShell scripts manage the backup processes. | + | |
| - | * MySQL database tracks backup status, performance, and reporting. | + | Before installing |
| - | * Node.js | + | |
| - | * Azure Blob Storage holds archived user data. | + | * An **Azure Storage Account** (General Purpose v2) with a container named **chipmunkarchive**. |
| + | * A **container-scoped SAS URL** for `chipmunkarchive` with **racwdl** permissions (Read, Add, Create, Write, Delete, List) and HTTPS-only access. | ||
| + | * An **Azure AI (Cognitive Services)** resource with endpoint URL and API key. | ||
| + | * A registered **Azure App** in **Entra ID** (Azure AD) with **admin-consented Microsoft Graph** application permissions and **Exchange Web Services** access. | ||
| + | * An internal **VNet** and **subnet** | ||
| + | * A **DNS name** pointing to the appliance IP address (A/AAAA record), matching the TLS certificate. | ||
| + | * A **TLS certificate** in PEM format (certificate + full chain) and matching private key, with CN/SAN matching your DNS name. | ||
| + | * (Optional) A static IP address (public or private) and corresponding DNS entry for reliable access. | ||
| + | * An Entra ID group that grants admin access to Chipmunk (i.e. ChipmunkAdmins) | ||
| ===== Prerequisites ===== | ===== Prerequisites ===== | ||
| Before installing Chipmunk, you’ll need: | Before installing Chipmunk, you’ll need: | ||
| - | * An Azure subscription with Blob Storage and a container created. | ||
| - | * A registered Azure App in Entra ID (Azure AD) with Graph API and Exchange Online permissions. | ||
| - | * An internal DNS name and TLS certificate for the Chipmunk appliance (e.g., chipmunk.yourcompany.local). | ||
| - | * (Optional) A static internal IP address and DNS entry for reliable access. | ||
| - | ===== Installation Steps ===== | + | * **Azure Storage Account (General Purpose v2)** |
| + | * Create a container named **chipmunkarchive**. | ||
| + | * Generate a **container-scoped SAS URL** for '' | ||
| + | * Example: < | ||
| - | 1. Provision your Azure Blob Storage account and create a container. | + | * **Azure AI (Cognitive Services)** |
| - | 2. Register a new App in Entra ID and assign the required Microsoft Graph and Exchange Online API permissions. | + | * An active resource in your region. |
| - | 3. Choose a DNS name for the Chipmunk appliance | + | * Provide |
| - | 4. Deploy Chipmunk from the Azure Marketplace. | + | |
| - | 5. Navigate to the Chipmunk setup URL (e.g., https://chipmunk.yourcompany.local) and complete the configuration wizard using the details you prepared. | + | |
| - | 6. Start Chipmunk services from the dashboard. | + | |
| - | Chipmunk is designed for quick deployment | + | * **Entra ID (Azure AD) App Registration** |
| + | * Create or use an existing application registration. | ||
| + | * Record your **Tenant ID**, **Application (client) ID**, and **Client secret**. | ||
| + | * Assign the following **API permissions** and **grant admin consent**: | ||
| + | * //Microsoft Graph — Application permissions// | ||
| + | * AuditLog.Read.All | ||
| + | * Calendars.Read | ||
| + | * ChannelMessage.Read.All | ||
| + | * Chat.Read.All | ||
| + | * Chat.ReadBasic.All | ||
| + | * Contacts.Read | ||
| + | * Directory.Read.All | ||
| + | * Files.Read.All | ||
| + | * Files.ReadWrite.All | ||
| + | * Group.Read.All | ||
| + | * Mail.Read | ||
| + | * Mail.Send | ||
| + | * Sites.Read.All | ||
| + | * Sites.ReadWrite.All | ||
| + | * Team.ReadBasic.All | ||
| + | * TeamMember.Read.All | ||
| + | * TeamSettings.Read.All | ||
| + | * TeamSettings.ReadWrite.All | ||
| + | * User.Read.All | ||
| + | * //Microsoft Graph — Delegated permission// | ||
| + | * User.Read | ||
| + | * //Office 365 Exchange Online — Application permission// | ||
| + | * full_access_as_app | ||
| + | |||
| + | * **Networking** | ||
| + | * Existing **VNet** and **Subnet** for the appliance. | ||
| + | * **Static IP** (public or private) and matching **DNS A/AAAA** record. | ||
| + | * DNS name must match the TLS certificate (e.g., '' | ||
| + | |||
| + | * **TLS Certificate** | ||
| + | * **PEM** format (server certificate + intermediate chain) **and** matching **private key**. | ||
| + | * CN/SAN must match the DNS name above. | ||
| + | |||
| + | * **Email Notification Settings** //(optional but recommended)// | ||
| + | * **From**: a valid mailbox in your tenant (e.g., '' | ||
| + | * **To**: operations/ | ||
| + | * **SMTP server**: '' | ||
| + | * **SMTP port**: '' | ||
| ===== Using Chipmunk ===== | ===== Using Chipmunk ===== | ||
| Line 58: | Line 103: | ||
| * Fully automated offboarding. | * Fully automated offboarding. | ||
| + | |||
| * Archives OneDrive, Exchange, and Teams data. | * Archives OneDrive, Exchange, and Teams data. | ||
| + | |||
| * Affordable licensing model. | * Affordable licensing model. | ||
| + | |||
| * Your data remains in your Azure tenant. | * Your data remains in your Azure tenant. | ||
| + | |||
| * Scalable for small and large environments. | * Scalable for small and large environments. | ||
| + | |||
| * Simple setup and minimal management overhead. | * Simple setup and minimal management overhead. | ||
| + | |||
| Chipmunk helps organizations meet compliance, legal hold, and operational continuity requirements while simplifying the Microsoft 365 offboarding process. | Chipmunk helps organizations meet compliance, legal hold, and operational continuity requirements while simplifying the Microsoft 365 offboarding process. | ||
| Line 70: | Line 121: | ||
| If you need assistance setting up your App Registration, | If you need assistance setting up your App Registration, | ||
| - | * [[chipmunk: | + | * [[software:chipmunk: |
| - | * [[chipmunk: | + | * [[software:chipmunk: |
| - | * [[chipmunk: | + | * [[software:chipmunk: |
| You can also contact our team at [[support@smikar.com]] for assistance. | You can also contact our team at [[support@smikar.com]] for assistance. | ||
software/chipmunk/getting_started.1751333013.txt.gz · Last modified: 2025/07/01 11:23 by support@smikar.com