software:chipmunk:installation
Table of Contents
Chipmunk Installation Guide
This page provides a high-level checklist to get Chipmunk installed and operational.
Before You Begin
Make sure you have the following ready before starting:
- Azure Storage Account (GPv2) with a container named
chipmunkarchive
and a container-scoped SAS URL withracwdl
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).
Installation Steps
1. Create an App Registration in Azure
- Register a new App in Entra ID.
- Assign Microsoft Graph + Exchange Online permissions (admin consent).
- Generate a client secret.
2. Create an Entra ID Admin Group
- Create a security group for Chipmunk administrators.
- Add users who should have dashboard access.
- Note the exact group name for the setup wizard.
3. Provision Azure Blob Storage
- Create a storage account and
chipmunkarchive
container. - Generate a SAS URL with read/write/list/delete permissions (
racwdl
).
4. Configure Azure AI
- Create an Azure AI (Cognitive Services) resource in your target region.
- Note the endpoint URL and API key.
5. Configure Internal DNS and TLS Certificate
- Decide your appliance hostname (e.g.
chipmunk.company.local
). - Add a DNS record pointing to your Chipmunk IP.
- Prepare a TLS certificate (PEM format) and private key matching the hostname.
6. Deploy Chipmunk from Azure Marketplace
- Search for “Chipmunk - Automated User Archiving”.
- Select your plan and follow the deployment steps.
7. Run Initial Configuration Wizard
- Access the wizard at
http://chipmunk.yourdomain:3000
(port 3000 is only required for initial setup). - Enter your App ID, secret, SAS URL, Azure AI details, admin group name, and other settings.
- Complete setup — appliance restarts and is accessible via
https://dnsname.yourdomain
.
Chipmunk is designed to be deployed in under an hour, with minimal Azure expertise required.
If you need help at any stage, contact support@smikar.com.
chipmunk installation setup guide entraid group azure_ai storage vnet tls
software/chipmunk/installation.txt · Last modified: 2025/08/15 14:14 by support@smikar.com