software:squirrel:squirrel_global_settings
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| software:squirrel:squirrel_global_settings [2025/01/24 18:49] – support@smikar.com | software:squirrel:squirrel_global_settings [2025/08/28 15:08] (current) – [🧾 System Settings Explained] support@smikar.com | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | **Squirrel System Settings | + | ===== ⚙️ |
| - | ** | + | |
| - | Overview | + | |
| - | This document provides an overview and descriptions of the configurable settings within the Squirrel system. Each setting has a specific purpose related to data archiving, file management, and system configuration. | + | ==== 🔍 Overview ==== |
| - | Settings | + | |
| - | {{:software: | + | This document provides a detailed overview of the configurable system settings within the [[https://www.smikar.com/ |
| - | **//Do not change | + | > ⚠️ |
| + | > Do **not** modify any system | ||
| - | # Squirrel System Settings Documentation | + | {{: |
| - | ## Overview | + | ---- |
| - | This document provides an overview and descriptions of the configurable settings within the Squirrel system. Each setting has a specific purpose related to data archiving, file management, and system configuration. | + | ==== 🧾 System Settings Explained ==== |
| - | --- | + | Below is a list of all configurable settings, what they do, and how they should be used. |
| - | ## Settings | + | ^ **Setting Name** ^ **Value** ^ **Description** ^ |
| + | | `ArchivesDeleteAfter` | 0 (disabled) | Specify the amount of days to delete the archive file from Azure Blob storage. `0` = don’t delete. | | ||
| + | | `AutoIncludeNewSites` | No | Determine whether to automatically include new Sites in the archiving policy. | | ||
| + | | `AzureArchiveTierAfter` | 0 (disabled) | Number of days before moving files from their current storage tier to the Azure Archive tier for long-term storage. Set to `0` to disable. **Warning**: | ||
| + | | `Azure_Container` | squirrel-archive | Specify the Azure container name. | | ||
| + | | `Azure_ResourceGroup` |SQUIRREL-RG | Specify the Azure Resource Group. | | ||
| + | | `Azure_StorageName` | squirrel | Specify the Azure Storage Name. | | ||
| + | | `Azure_StorageTier` | cold | Specify the Azure Access Tier to be used for archive (`hot`, `cool`, or `cold`). | | ||
| + | | `BaseURL` | https:// | ||
| + | | `CompanyName` | company | Company name. | | ||
| + | | `Email_Alerts` | support@company.com | Customer email alerts. | | ||
| + | | `Email_Billing` | accounts@company.com | Customer billing email details. | | ||
| + | | `Exclude_Filetype` | .abc, .xyz | Do not archive files of these file extensions (comma separated). | | ||
| + | | `IntelligentAutoPolicy` | Disabled | AI-powered lifecycle policy monitors the environment and automatically adjusts the archive policy to ensure storage stays within licensed limits. Associated with `SharePoint_StorageLimit` and `SharePoint_StorageBuffer`. | | ||
| + | | `LastAccessed` | 0 (disabled) | Specify the number of days since a file was last accessed before it is eligible for archiving. | | ||
| + | | `LastModified` | 730 (2 years) | Specify the number of days since a file was last modified before it is eligible for archiving. | | ||
| + | | `MinFileSize` | 10240 | Do not archive files smaller than this size (bytes). | | ||
| + | | `MIP_ExcludedLabels` | MIP label1, MIP label2 | Do not archive files marked with these MIP labels (case-sensitive). Such files will be excluded from archiving. Comma-separated. | | ||
| + | | `OrphanedRestorePath` | https:// | ||
| + | | `SharePoint_StorageBuffer` | 20% | Specify the storage buffer to keep free within the licensed storage limits. Associated with Intelligent Auto Policy and `SharePoint_StorageLimit`. | | ||
| + | | `SharePoint_StorageLimit` | 10 | Specify the total SharePoint storage available under current Microsoft licensing (in TB). Used by the platform to manage archiving. | | ||
| + | | `VersionLimit` | 500 | Specify the maximum number of versions to archive along with the file. `0` = skip version archiving. | | ||
| + | | `Wildcard_exclusion` | | Do not archive files if the filepath contains any of the following values (separated by commas). | | ||
| - | ^ <20%> **Setting Name** ^ <20%> **Value** ^ <60%> **Description** ^ | + | ---- |
| - | | <20%> ArchiveDays | <20%> Set a number value that will help you achieve how much data you would like archived. 0(zero) turns this setting off | <60%> Specifies the number of days of inactivity before a file is archived. | | + | |
| - | | <20%> Azure_AccessTier | <20%> Type in the access tier for your Azure Storage. Options include hot, cool, or cold. | <60%> Specifies the Azure Blob Storage Access Tier to be used for archiving. | + | |
| - | | <20%> Azure_Container | <20%> Input your Azure Storage Container name. | <60%> Specifies the Azure container name where files will be stored. | | + | |
| - | | <20%> Azure_ResourceGroup | <20%> Input Azure Resource Group Name | <60%> Specifies the Azure resource group associated with your Azure Blob storage. | | + | |
| - | | <20%> Azure_StorageName | <20%> Input Azure Storage Account Name | <60%> Specifies the Azure storage account name for the archive. | | + | |
| - | | <20%> AzureDeleteBlobAfterDays | <20%> Input a numerical number | <60%> Specifies the number of days before an archived file is deleted from Azure blob storage. A value of 0 means no files will be deleted. | | + | |
| - | | <20%> baseurl | <20%> Input the URL of your Squirrel Environment. (e.g. https:// | + | |
| - | | <20%> billing_address | <20%> Your Company Address | <60%> Specifies the billing address of the customer. | | + | |
| - | | <20%> company_name | <20%> Customer Name | <60%> Specifies the name of the customer/ | + | |
| - | | <20%> Email_Alerts | <20%> support@customer.com, | + | |
| - | | <20%> Email_Billing | <20%> accounts@customer.com | <60%> Specifies the email address for billing-related notifications. | | + | |
| - | | <20%> Exclude_filetype | <20%> .abc, .xyz | <60%> Specifies file types to exclude from archiving. Extensions are separated by commas. | | + | |
| - | | <20%> isMovedwithStub | <20%> 0 | <60%> Determines whether to update the archive record if a stub or folder is moved. Default setting is 0 (do not move the archive). | | + | |
| - | | <20%> isRetainedAfterDelete | <20%> 1 | <60%> Determines whether to retain an archived file if the stub or folder is deleted. Default setting is 1 (retain). | | + | |
| - | | <20%> MIP_enabled | <20%> 1 | <60%> Enables or disables Microsoft Information Protection (MIP) filtering. 1 enables MIP. | | + | |
| - | | <20%> MIP_excluded_labels | <20%> MIP label1, MIP label2 | <60%> Specifies MIP labels to exclude from archiving. Exact, case-sensitive matches only. | | + | |
| - | | <20%> ModifiedDays | <20%> 730 | <60%> Specifies the number of days of modification inactivity before a file is archived. | | + | |
| - | | <20%> Orphaned_restore_path | <20%> https:// | + | |
| - | | <20%> shipping_address | <20%> Customer Name 123 Smith Street SharePointVille, | + | |
| - | | <20%> StubType | <20%> HTML | <60%> Specifies whether the stub should be in HTML or URL format. This setting should not be changed after the initial deployment. | | + | |
| - | --- | + | ==== ✅ Best Practices ==== |
| - | ## Conclusion | + | - Always |
| - | + | - When in doubt, consult [support@smikar.com](mailto: | |
| - | This document | + | - Do **not** edit core settings like `baseurl` after deployment without SmiKar’s assistance. |
| + | ---- | ||
software/squirrel/squirrel_global_settings.1737704941.txt.gz · Last modified: 2025/01/24 18:49 by support@smikar.com