This page provides a high-level checklist to get Chipmunk installed and operational.

Each step links to a detailed setup guide.

Make sure you have the following ready before starting:

• Azure Storage Account (GPv2) with a container named chipmunkarchive and a container-scoped SAS URL with racwdl permissions.
• Azure AI (Cognitive Services) endpoint and API key.
• Entra ID App Registration with required Microsoft Graph + Exchange permissions (admin consent will be needed).
• Entra ID Security Group for Chipmunk admins.
• Networking: existing VNet + Subnet, static IP (public or private), and DNS name.
• TLS certificate in PEM format with private key, matching the DNS name.
• (Optional) Email notification settings (from address, to address, SMTP server/port).

1. Create an App Registration in Azure

1. Register a new App in Entra ID.
2. Assign Microsoft Graph + Exchange Online permissions (admin consent).
3. Generate a client secret.

 → [[software:chipmunk:installation:app_registration|View App Registration Guide]]

2. Create an Entra ID Admin Group

1. Create a security group for Chipmunk administrators.
2. Add users who should have dashboard access.
3. Note the group name for the setup wizard.

 → [[software:chipmunk:installation:app_registration#step_7_create_admin_group|How to create the admin group]]

3. Provision Azure Blob Storage

1. Create a storage account and chipmunkarchive container.
2. Generate a SAS URL with read/write/list/delete permissions (racwdl).

 → [[software:chipmunk:installation:storage_account|View Storage Setup Guide]]

4. Configure Azure AI

1. Create an Azure AI (Cognitive Services) resource in your target region.
2. Note the endpoint URL and API key.

 → [[software:chipmunk:installation:azure_ai|View Azure AI Setup Guide]]

5. Configure Internal DNS and TLS Certificate

1. Decide your appliance hostname (e.g. chipmunk.company.local).
2. Add a DNS record pointing to your Chipmunk IP.
3. Prepare a TLS certificate (PEM format) and private key matching the hostname.

 → [[software:chipmunk:installation:certificate_dns|View DNS & Certificate Guide]]

6. Deploy Chipmunk from Azure Marketplace

1. Search for “Chipmunk - Automated User Archiving”.
2. Select your plan and follow the deployment steps.

7. Run Initial Configuration Wizard

1. Access the wizard at http://chipmunk.yourdomain:3000 (port 3000 is only required for initial setup).
2. Enter your App ID, secret, SAS URL, Azure AI details, admin group name, and other settings.
3. Complete setup — appliance restarts and is accessible via https://chipmunk.yourdomain.

 → [[software:chipmunk:installation:first_run|View First-Time Configuration Guide]]

Chipmunk is designed to be deployed in under an hour, with minimal Azure expertise required.

If you need help at any stage, visit our Support page or contact support@smikar.com.

chipmunk installation setup guide entraid group azure_ai storage vnet tls