Differences

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

--- software:squirrel:squirrel_global_settings [2025/02/03 14:26] – 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 Documentation
+===== ⚙️ 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:squirrel:global_settings.png?400|}}
+This document provides a detailed overview of the configurable system settings within the [[https://www.smikar.com/squirrel/|Squirrel]] archiving platform. Each setting plays a specific role in managing data archiving behavior, file lifecycle policies, storage destinations, and user environment configuration.
-**//Do not change settings of Squirrel without refering to this page, or even better talking to your Squirrel Represtentative from SmiKar.
+> ⚠️ **Important:**
-In correct settings may impact system functionality and are at your own risk.//**
+> Do **not** modify any system settings unless you’ve consulted this guide — or preferably, your **SmiKar representative**. Incorrect settings may impact system functionality and are changed **at your own risk**.
-**Squirrel System Settings Documentation**
+{{:software:squirrel:settings.png?400|}}
-**Overview**
+----
+==== 🧾 System Settings Explained ====
-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.
+Below is a list of all configurable settings, what they do, and how they should be used.
----
+^ **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**: Files in Azure Archive Blob tier may take up to 24 hours to rehydrate. |
+| `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://company.smikar.com/ | Base URL for the company’s Squirrel site. Used for the URL creation process. |
+| `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://company.sharepoint.com/sites/orphaned/restore | Specify a location to restore orphaned files if the original location no longer exists. |
+| `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). |
-**Settings**
+----
-^ Setting Name ^ Value ^ Description ^
-| ArchiveDays | Set a number value that will help you achieve how much data you would like archived. 0(zero) turns this setting off | Specifies the number of days of inactivity before a file is archived. |
-| Azure_AccessTier | Type in the access tier for your Azure Storage. Options include hot, cool, or cold. | Specifies the Azure Blob Storage Access Tier to be used for archiving.  |
-| Azure_Container | Input your Azure Storage Container name. | Specifies the Azure container name where files will be stored. |
-| Azure_ResourceGroup | Input Azure Resource Group Name | Specifies the Azure resource group associated with your Azure Blob storage. |
-| Azure_StorageName | Input Azure Storage Account Name | Specifies the Azure storage account name for the archive. |
-| AzureDeleteBlobAfterDays | Input a numerical number | 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. |
-| baseurl | Input the URL of your Squirrel Environment. (e.g. https://squirreldemo.smikar.com/) | Base URL for the company's Squirrel site, used for URL creation. This will be provided by SmiKar. |
-| billing_address | Your Company Address | Specifies the billing address of the customer. |
-| company_name | Customer Name | Specifies the name of the customer/company. |
-| Email_Alerts | support@customer.com, admin@customer.com | Specifies the email addresses to receive system alerts. |
-| Email_Billing | accounts@customer.com | Specifies the email address for billing-related notifications. |
-| Exclude_filetype | .abc, .xyz | Specifies file types to exclude from archiving. Extensions are separated by commas. |
-| isMovedwithStub | 0 | Determines whether to update the archive record if a stub or folder is moved. Default setting is 0 (do not move the archive). |
-| isRetainedAfterDelete | 1 | Determines whether to retain an archived file if the stub or folder is deleted. Default setting is 1 (retain). |
-| MIP_enabled | 1 | Enables or disables Microsoft Information Protection (MIP) filtering. 1 enables MIP. |
-| MIP_excluded_labels | MIP label1, MIP label2 | Specifies MIP labels to exclude from archiving. Exact, case-sensitive matches only. |
-| ModifiedDays | 730 | Specifies the number of days of modification inactivity before a file is archived. |
-| Orphaned_restore_path | https://companyname.sharepoint.com/sites/orphaned/restore | Specifies the location to restore orphaned files if the original location no longer exists. |
-| shipping_address | Customer Name 123 Smith Street SharePointVille, VIC | Specifies the shipping address of the customer. |
-| StubType | HTML | Specifies whether the stub should be in HTML or URL format. This setting should not be changed after the initial deployment. |
+==== ✅ Best Practices ====
+- Always document changes made to system settings for future reference or support queries.
+- When in doubt, consult [support@smikar.com](mailto:support@smikar.com) before making changes.
+- Do **not** edit core settings like `baseurl` after deployment without SmiKar’s assistance.
+----