software:chipmunk:configuration []

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Chipmunk Installation ======

Chipmunk is delivered as a **preconfigured appliance** for deployment in Microsoft Azure.

Once deployed, Chipmunk is managed entirely through the **web portal**.  
No other access is required or available.

===== Deployment =====

The Chipmunk appliance is deployed into your organisation's Microsoft Azure tenant.

Once running, all management and configuration is performed through the Chipmunk web portal.

===== System Requirements =====

  * Azure virtual machine with:
    * **8 vCPU**
    * **16 GB RAM**
  * Network access to:
    * Microsoft Graph API (Entra ID)
    * Azure Blob Storage (within your tenant)
    * Internal email system (for notifications)

===== Initial Setup =====

Once the appliance is deployed:

  - Access the Chipmunk web portal.
  - Configure your environment settings, including:
    * Azure Blob Storage credentials (SAS URL)
    * Database connection details
    * Archive and retention policies

  - Configure Entra ID (Azure AD) Application and grant necessary API permissions (see below).
  - Use the Chipmunk web portal to verify system status and complete the setup.

===== Configuring Microsoft Graph API Access =====

Chipmunk requires access to Microsoft 365 user data for archiving.  
To enable this, you must create an Azure AD App Registration and grant the following permissions.

This allows Chipmunk to connect securely and archive data from Exchange Online and OneDrive.

==== Creating the Azure AD Application ====

1. Go to the **Azure Portal → Azure Active Directory → App registrations**.
2. Click **New Registration** and follow the prompts to create your application.
3. Once created, note down the:
    * **Application (client) ID**
    * **Tenant ID**
    * **Client Secret** (if required)

You will enter these details in the Chipmunk web portal under Settings.

==== Required API Permissions ====

After registering the app, grant the following Microsoft Graph API permissions.

=== Exchange Archiving Permissions ===

  * Mail.Read
  * Mail.Send
  * Calendars.Read
  * Contacts.Read
  * Directory.Read.All
  * User.Read.All
  * Group.Read.All

=== OneDrive Archiving Permissions ===

  * Files.Read.All
  * Sites.Read.All
  * User.Read.All
  * Directory.Read.All

==== Granting Admin Consent ====

Once the permissions are added, make sure to:

  * Click **Grant Admin Consent** to authorise the app for all users in the organisation.

This will allow Chipmunk to access the required data when accounts are disabled and archiving begins.

===== Installation Complete =====

Once the above steps are finished, Chipmunk is ready for configuration through the web portal to set Azure Blob Storage, Azure AI and Chipmunk settings.