PD-1252 / 24.04 / Pd 1252 update/replace smb home shares content (by …

…micjohnson777) (#3321) * Empty commit to create PR on github. You should reset it * PD-1252 / 25.04 / Pd 1252 update/replace smb home shares content (#3158) * PD-1252 Update SMB Shares index This commit updates the /shares/SMB/_index.md file with new information on the Private SMB Datasets and Shares preset, fixes style issues, and clarifies other content. It makes initial and minor edits to the Home Shares article * PD-1252 Update SMB Home Share Tutorial This commit updates the content and screenshots in the AddSMBHomeShare.md tutorial to show setting up the dataset, share, ACL preset, and adding the user home directory to use the *private* dataset, which is the alternative to using home shares. * PD-1252 Update SMB Screen This commit updates the Other Options screenshot and adds Additional Parameters String to the list of setting options. * PD-1252 Fix Open Expand This commit adds the close expand shortcode to the tutorial /shares/smb/_index.md file. * PD-1252 Fix Broken Links * PD-1252 Fix Broken Link * PD-1252 Fix broken links to AddSMBHomeShare.md * Update content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md Co-authored-by: DjP-iX <[email protected]> * Update content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md Co-authored-by: DjP-iX <[email protected]> * Update _index.md Added Service back to the heading on line 261 * Update content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md Co-authored-by: DjP-iX <[email protected]> * Update content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md Co-authored-by: DjP-iX <[email protected]> * Update content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md Co-authored-by: DjP-iX <[email protected]> * Update content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md Co-authored-by: DjP-iX <[email protected]> * Update AddSMBHomeShare.md Clarify line 19 and 78 * PD-1502 / None / Pd 1502 update smb share purpose presets descriptions (#3173) * Update _index.md * Update SMBSharesScreens.md * Create SMBPurposePresets.md * PD-1512 Fix Style issue This commit fixes the bold emphasis issue in the Edit Filesystem ACL Screen section. --------- Co-authored-by: DjP-iX <[email protected]> (cherry picked from commit 7d8de1b) --------- Co-authored-by: MicJ <[email protected]> Co-authored-by: MicJ <[email protected]> Co-authored-by: Tim Moore <[email protected]>
truenas · Dec 9, 2024 · 147ed01 · 147ed01
1 parent 76133d1
commit 147ed01
Show file tree

Hide file tree

Showing 10 changed files with 203 additions and 115 deletions.
diff --git a/content/SCALETutorials/Shares/SMB/AddSMBHomeShare.md b/content/SCALETutorials/Shares/SMB/AddSMBHomeShare.md
diff --git a/content/SCALETutorials/Shares/SMB/_index.md b/content/SCALETutorials/Shares/SMB/_index.md
diff --git a/content/SCALEUIReference/Shares/SMBSharesScreens.md b/content/SCALEUIReference/Shares/SMBSharesScreens.md
@@ -94,17 +94,7 @@ The **Basic Options** settings in this section also display in the **Advanced Op
 #### Purpose Setting Options
 This table details the options found on the **Purpose** dropdown list.
 
-{{< truetable >}}
-| Setting | Description |
-|---------|-------------|
-| **No presets** | Select  to retain control over all **Advanced Options** settings.|
-| **Default share parameters** | The default option when you open the **Add SMB** screen and to use for any basic SMB share. |
-| **Basic time machine share** | Select to set up a basic time machine share. |
-| **Multi-User time machine** | Select to set up a multi-user time machine share. |
-|  **Multi-Protocol (NFSv3/SMB) shares**| Select for multi-protocol (NFSv3/SMB) shares. |
-| **Private SMB Datasets and Shares** | Select to use private SMB datasets and shares. |
-| **SMB WORM. Files become read-only via SMB after 5 minutes** | The **SMB WORM** preset only impacts writes over the SMB protocol. Before deploying this option in a production environment, the user should determine whether the feature meets their requirements. |
-{{< /truetable >}}
+{{< include file="/static/includes/SMBPurposePresets.md" >}}
 
 ### Advanced Options Settings
 Click **Advanced Options** to display settings made available or locked based on the option selected in **Purpose**.
@@ -157,6 +147,7 @@ The **Other Options** settings include improving Apple software compatibility, Z
 | **Enable SMB2/3 Durable Handles** | Select to allow using open file handles that can withstand short disconnections. Support for POSIX byte-range locks in Samba is also disabled. We do not recommend this option when configuring multi-protocol or local access to files. |
 | **Enable FSRVP** | Select to enable support for the File Server Remote VSS Protocol ([FSVRP](https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-fsrvp/dae107ec-8198-4778-a950-faa7edad125b)). This protocol allows remote procedure call (RPC) clients to manage snapshots for a specific SMB share. The share path must be a dataset mount point. Snapshots have the prefix `fss-` followed by a snapshot creation timestamp. A snapshot must have this prefix for an RPC user to delete it. |
 | **Path Suffix** | Appends a suffix to the share connection path. Use to provide individualized shares on a per-user, per-computer, or per-IP address basis. Suffixes can contain a macro. See the [smb.conf](https://www.samba.org/samba/docs/current/man-html/smb.conf.5.html) manual page for a list of supported macros. The connect path must be preset before a client connects. |
+| **Additional Parameters String** | Shows a string of parameters associated with the share preset selected, or if no preset, enter additional smb4.conf parameters not covered by the TrueNAS API. |
 {{< /truetable >}}
 
 #### Advanced Options Presets
@@ -211,7 +202,7 @@ These settings configure new ACL entries for the selected SMB share and apply th
 
 ## Edit Filesystem ACL Screen
 The **Edit Filesystem ACL** option opens the **Edit ACL** screen for the dataset the share uses.
-See [**Edit ACL Screen]({{< relref "EditACLScreens.md" >}}) more information on the settings found on this screen.
+See [**Edit ACL Screen**]({{< relref "EditACLScreens.md" >}}) more information on the settings found on this screen.
 
 {{< trueimage src="/images/SCALE/Shares/SMBACLEditor.png" alt="SMB ACL Editor" id="SMB ACL Editor" >}}
 
@@ -234,4 +225,7 @@ The **SMB Status** screen has four tabs with information related to SMB shares:
 **Column** displays a dropdown list of options for the selected tab to customize the information included on the screen.
 
 Click **Sharing** or **SBM** on the top breadcrumb to open the selected screen.
-The breadcrumb displays when you access the SMB Status screen from the **System Settings > Services SMB** row.
+
+The breadcrumb displays when you access the SMB Status screen from the **System > Services SMB** row.
+
+{{< include file="/static/includes/addcolumnorganizer.md" >}}
diff --git a/static/images/SCALE/Shares/AddPrivateSMBShare.png b/static/images/SCALE/Shares/AddPrivateSMBShare.png
diff --git a/static/images/SCALE/Shares/AddPrivateSMBShareAdvancedOptions.png b/static/images/SCALE/Shares/AddPrivateSMBShareAdvancedOptions.png
diff --git a/static/images/SCALE/Shares/AddSMBAdvancedOtherSettings.png b/static/images/SCALE/Shares/AddSMBAdvancedOtherSettings.png
diff --git a/static/images/SCALE/Shares/SetACLPresetForPrivateDataset.png b/static/images/SCALE/Shares/SetACLPresetForPrivateDataset.png
diff --git a/static/images/SCALE/Shares/SetUserHomeDirectoryToPrivate.png b/static/images/SCALE/Shares/SetUserHomeDirectoryToPrivate.png
diff --git a/static/includes/ChangeBuiltin-UserACL.md b/static/includes/ChangeBuiltin-UserACL.md
@@ -16,5 +16,4 @@ To change permissions for the **builtin_users** group, go to **Datasets**, selec
 5. Select **Basic** in the **Permissions** area then select the level of access you want to assign in the **Permissions** field.
    For more granular control, select **Advanced** then select on each permission option to include.
 
-6. Click **Save Access Control List** to add the ACE item or save changes.
-7. 
+6. Click **Save Access Control List** to add the ACE item or save changes. 
diff --git a/static/includes/SMBPurposePresets.md b/static/includes/SMBPurposePresets.md
@@ -0,0 +1,13 @@
+&NewLine;
+
+{{< truetable >}}
+| Setting | Description |
+|---------|-------------|
+| **No presets** | Select  to retain control over all **Advanced Options** settings. This option gives users the flexibility to manually configure SMB parameters. |
+| **Default share parameters** | The default option when you open the **Add SMB** screen and to use for any basic SMB share. These settings provide a baseline configuration that ensures compatibility and functionality, and allow users to set up shares with commonly implemented options and behaviors. |
+| **Basic time machine share** | Select to set up a basic time machine share. This provides a centralized location for users to store and manage system backups. |
+| **Multi-User time machine** | Select to set up a multi-user time machine share. This option allows multiple users to use TrueNAS as a centralized backup solution while simultaneously ensuring that each backup users make are kept separate and secure from one another.  |
+|  **Multi-Protocol (NFSv3/SMB) shares**| Select for multi-protocol (NFSv3/SMB) shares. Choosing this option allows NFS and SMB users to access TrueNAS at the same time. |
+| **Private SMB Datasets and Shares** | Select to create a share that maps to a path determined by the username of the authenticated user. TrueNAS creates a unique, private dataset matching the user name. |
+| **SMB WORM. Files become read-only via SMB after 5 minutes** | The **SMB WORM** preset only impacts writes over the SMB protocol. Before deploying this option in a production environment, determine whether the feature meets your requirements. Employing this option, ensures data written to the share cannot be modified or deleted, thus increasing overall data integrity and security. |
+{{< /truetable >}}