Differences

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

--- software:squirrel:squirrel_global_settings [2025/01/24 18:49] – support@smikar.com
+++ software:squirrel:squirrel_global_settings [2025/03/26 13:20] (current) – 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. In correct settings may impact system functionality and are at your own risk.//**
+> ⚠️ **Important:**
+> 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:global_settings.png?400|}}
-## 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 ====
-## Settings
+Below is a list of all configurable settings, what they do, and how they should be used.
-^ <20%> **Setting Name** ^ <20%> **Value** ^ <60%> **Description** ^
+^ **Setting Name** ^ **Value** ^ **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. |
+| `ArchiveDays` | Number (e.g., 180) | Number of days since a file was last accessed before it’s archived. Set to `0` to disable. |
-| <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.  |
+| `ModifiedDays` | Number (e.g., 730) | Number of days since a file was last modified before it's eligible for archiving. |
-| <20%> Azure_Container | <20%> Input your Azure Storage Container name. | <60%> Specifies the Azure container name where files will be stored. |
+| `Azure_AccessTier` | `hot`, `cool`, or `cold` | Specifies the **Azure Blob Storage access tier** used for archived files. |
-| <20%> Azure_ResourceGroup | <20%> Input Azure Resource Group Name | <60%> Specifies the Azure resource group associated with your Azure Blob storage. |
+| `Azure_Container` | Text (e.g., `squirrel-archive`) | Name of the Azure container where archived files are stored. |
-| <20%> Azure_StorageName | <20%> Input Azure Storage Account Name | <60%> Specifies the Azure storage account name for the archive. |
+| `Azure_ResourceGroup` | Text | The name of the Azure Resource Group tied to your storage. |
-| <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. |
+| `Azure_StorageName` | Text | The name of the Azure Storage Account used by Squirrel. |
-| <20%> baseurl | <20%> Input the URL of your Squirrel Environment. (e.g. https://squirreldemo.smikar.com/) | <60%> Base URL for the company's Squirrel site, used for URL creation. This will be provided by SmiKar. |
+| `AzureDeleteBlobAfterDays` | Number | Number of days before archived files are automatically deleted from Azure. Set to `0` to disable deletion. |
-| <20%> billing_address | <20%> Your Company Address | <60%> Specifies the billing address of the customer. |
+| `baseurl` | URL (e.g., `https://squirrel.yourcompany.com`) | Base URL for your Squirrel deployment. Provided by SmiKar. |
-| <20%> company_name | <20%> Customer Name | <60%> Specifies the name of the customer/company. |
+| `StubType` | `HTML` or `URL` | Determines the format of the stub file. **Should not be changed** after deployment. |
-| <20%> Email_Alerts | <20%> support@customer.com, admin@customer.com | <60%> Specifies the email addresses to receive system alerts. |
+| `Orphaned_restore_path` | SharePoint URL | Path used to restore files if the original location no longer exists. |
-| <20%> Email_Billing | <20%> accounts@customer.com | <60%> Specifies the email address for billing-related notifications. |
+| `isMovedwithStub` | `0` or `1` | Whether Squirrel updates the archive record if a stub or folder is moved. `0 = off`, `1 = on`. |
-| <20%> Exclude_filetype | <20%> .abc, .xyz | <60%> Specifies file types to exclude from archiving. Extensions are separated by commas. |
+| `isRetainedAfterDelete` | `0` or `1` | Determines whether Squirrel retains archived data if the stub or folder is deleted. `1 = retain`, `0 = delete`. |
-| <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). |
+| `MIP_enabled` | `0` or `1` | Enables Microsoft Information Protection (MIP) label filtering. `1 = enabled`. |
-| <20%> isRetainedAfterDelete | <20%> 1 | <60%> Determines whether to retain an archived file if the stub or folder is deleted. Default setting is 1 (retain). |
+| `MIP_excluded_labels` | Comma-separated labels | MIP labels to exclude from archiving. **Case-sensitive**. |
-| <20%> MIP_enabled | <20%> 1 | <60%> Enables or disables Microsoft Information Protection (MIP) filtering. 1 enables MIP. |
+| `Exclude_filetype` | `.ext1, .ext2` | File types to exclude from archiving (comma-separated extensions). |
-| <20%> MIP_excluded_labels | <20%> MIP label1, MIP label2 | <60%> Specifies MIP labels to exclude from archiving. Exact, case-sensitive matches only. |
+| `company_name` | Your Company Name | Sets your organization’s name within the Squirrel portal. |
-| <20%> ModifiedDays | <20%> 730 | <60%> Specifies the number of days of modification inactivity before a file is archived. |
+| `billing_address` | Full Address | Address used for billing purposes. |
-| <20%> Orphaned_restore_path | <20%> https://companyname.sharepoint.com/sites/orphaned/restore | <60%> Specifies the location to restore orphaned files if the original location no longer exists. |
+| `shipping_address` | Full Address | Address used for shipping or invoicing documentation. |
-| <20%> shipping_address | <20%> Customer Name 123 Smith Street SharePointVille, VIC | <60%> Specifies the shipping address of the customer. |
+| `Email_Alerts` | Email list | List of emails to receive system alerts and notifications. |
-| <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. |
+| `Email_Billing` | Email address | Email address to receive billing-related notifications. |
----
+----
-## Conclusion
+==== ✅ Best Practices ====
-This document provides detailed information on the configurable settings available in the Squirrel system, ensuring proper configuration and maintenance of the archiving process.
+- 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 `StubType` or `baseurl` after deployment without SmiKar’s assistance.
+----