Differences

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

--- software:squirrel:squirrel_global_settings [2025/01/24 18:11] – 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
-**//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.//**
+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.
-<WRAP center round box 100%>
-^ <20%>Setting Name ^ <40%>Value ^ <40%>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 Stoage 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 not 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. |
-</WRAP>
+> ⚠️ **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**.
+{{:software:squirrel:global_settings.png?400|}}
+----
+==== 🧾 System Settings Explained ====
+Below is a list of all configurable settings, what they do, and how they should be used.
+^ **Setting Name** ^ **Value** ^ **Description** ^
+| `ArchiveDays` | Number (e.g., 180) | Number of days since a file was last accessed before it’s archived. Set to `0` to disable. |
+| `ModifiedDays` | Number (e.g., 730) | Number of days since a file was last modified before it's eligible for archiving. |
+| `Azure_AccessTier` | `hot`, `cool`, or `cold` | Specifies the **Azure Blob Storage access tier** used for archived files. |
+| `Azure_Container` | Text (e.g., `squirrel-archive`) | Name of the Azure container where archived files are stored. |
+| `Azure_ResourceGroup` | Text | The name of the Azure Resource Group tied to your storage. |
+| `Azure_StorageName` | Text | The name of the Azure Storage Account used by Squirrel. |
+| `AzureDeleteBlobAfterDays` | Number | Number of days before archived files are automatically deleted from Azure. Set to `0` to disable deletion. |
+| `baseurl` | URL (e.g., `https://squirrel.yourcompany.com`) | Base URL for your Squirrel deployment. Provided by SmiKar. |
+| `StubType` | `HTML` or `URL` | Determines the format of the stub file. **Should not be changed** after deployment. |
+| `Orphaned_restore_path` | SharePoint URL | Path used to restore files if the original location no longer exists. |
+| `isMovedwithStub` | `0` or `1` | Whether Squirrel updates the archive record if a stub or folder is moved. `0 = off`, `1 = on`. |
+| `isRetainedAfterDelete` | `0` or `1` | Determines whether Squirrel retains archived data if the stub or folder is deleted. `1 = retain`, `0 = delete`. |
+| `MIP_enabled` | `0` or `1` | Enables Microsoft Information Protection (MIP) label filtering. `1 = enabled`. |
+| `MIP_excluded_labels` | Comma-separated labels | MIP labels to exclude from archiving. **Case-sensitive**. |
+| `Exclude_filetype` | `.ext1, .ext2` | File types to exclude from archiving (comma-separated extensions). |
+| `company_name` | Your Company Name | Sets your organization’s name within the Squirrel portal. |
+| `billing_address` | Full Address | Address used for billing purposes. |
+| `shipping_address` | Full Address | Address used for shipping or invoicing documentation. |
+| `Email_Alerts` | Email list | List of emails to receive system alerts and notifications. |
+| `Email_Billing` | Email address | Email address to receive billing-related notifications. |
+----
+==== ✅ 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 `StubType` or `baseurl` after deployment without SmiKar’s assistance.
+----