User Tools

Site Tools


software:chipmunk:getting_started

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
software:chipmunk:getting_started [2025/08/15 13:58] – [Prerequisites] support@smikar.comsoftware:chipmunk:getting_started [2025/08/20 16:51] (current) – [Prerequisites] support@smikar.com
Line 18: Line 18:
   * Easy recovery options are available later if required.   * Easy recovery options are available later if required.
  
-===== Chipmunk Architecture ===== 
- 
-Chipmunk uses a lightweight architecture: 
-  * PowerShell scripts manage the backup processes. 
-  * MySQL database tracks backup status, performance, and reporting. 
-  * Node.js and React front-end dashboard for easy monitoring. 
-  * Azure Blob Storage holds archived user data. 
  
 ===== Prerequisites ===== ===== Prerequisites =====
Line 38: Line 31:
   * A **TLS certificate** in PEM format (certificate + full chain) and matching private key, with CN/SAN matching your DNS name.   * 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.   * (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 =====
 +
 +Before installing Chipmunk, you’ll need:
 +
 +  * **Azure Storage Account (General Purpose v2)**
 +    * Create a container named **chipmunkarchive**.
 +    * Generate a **container-scoped SAS URL** for ''chipmunkarchive'' with **racwdl** permissions (Read, Add, Create, Write, Delete, List) and HTTPS-only.
 +    * Example: <code>https://&lt;storageaccount&gt;.blob.core.windows.net/chipmunkarchive?sp=racwdl&st=YYYY-MM-DDTHH:MM:SSZ&se=YYYY-MM-DDTHH:MM:SSZ&spr=https&sv=2024-11-04&sr=c&sig=&lt;yoursassignature&gt;</code>
 +
 +  * **Azure AI (Cognitive Services)**
 +    * An active resource in your region.
 +    * Provide the **Endpoint URL** (e.g., ''https://&lt;your-ai-resource&gt;.cognitiveservices.azure.com/'') and **API key**.
 +
 +  * **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  (EWS; scope with an Application Access Policy if required)
  
-===== Installation Steps =====+  * **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., ''chipmunk.yourcompany.local'' or ''chipmunk.yourcompany.com'').
  
-1. Provision your Azure Blob Storage account and create a container. +  * **TLS Certificate** 
-2. Register a new App in Entra ID and assign the required Microsoft Graph and Exchange Online API permissions. +    * **PEM** format (server certificate + intermediate chain**and** matching **private key**
-3. Choose a DNS name for the Chipmunk appliance (e.g., chipmunk.yourcompany.local) and bind a TLS certificate to that domain+    * CN/SAN must match the DNS name above.
-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 — most installations can be completed in under an hour.+  * **Email Notification Settings** //(optional but recommended)// 
 +    * **From**: a valid mailbox in your tenant (e.g., ''chipmunk-alerts@yourcompany.com''). 
 +    * **To**: operations/alerts mailbox (e.g., ''admin@yourcompany.com''). 
 +    * **SMTP server**: ''smtp.office365.com'' 
 +    * **SMTP port**: ''587'' (STARTTLS) or ''25'' if internal relay.
  
 ===== Using Chipmunk ===== ===== Using Chipmunk =====
software/chipmunk/getting_started.1755230331.txt.gz · Last modified: 2025/08/15 13:58 by support@smikar.com