Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PD-1252 / 25.04 / Pd 1252 update/replace smb home shares content #3158

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
0134455
PD-1252 Update SMB Shares index
micjohnson777 Oct 23, 2024
06a96b8
PD-1252 Update SMB Home Share Tutorial
micjohnson777 Oct 24, 2024
b647a3b
Merge branch 'master' into PD-1252-Update/Replace-SMB-Home-Shares-Con…
micjohnson777 Oct 24, 2024
797fb5d
PD-1252 Update SMB Screen
micjohnson777 Oct 24, 2024
778d22f
PD-1252 Fix Open Expand
micjohnson777 Oct 24, 2024
26ce4f2
PD-1252 Fix Broken Links
micjohnson777 Oct 24, 2024
7373095
PD-1252 Fix Broken Link
micjohnson777 Oct 24, 2024
b8f767f
PD-1252 Fix broken links to AddSMBHomeShare.md
micjohnson777 Oct 24, 2024
3692060
Update content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md
micjohnson777 Oct 29, 2024
8c2773e
Update content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md
micjohnson777 Oct 29, 2024
8c17602
Update _index.md
micjohnson777 Oct 29, 2024
f20a83f
Update content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md
micjohnson777 Oct 29, 2024
74f9256
Update content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md
micjohnson777 Oct 29, 2024
ea4683f
Update content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md
micjohnson777 Oct 29, 2024
bdb6ecc
Update content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md
micjohnson777 Oct 29, 2024
19da56e
Update AddSMBHomeShare.md
micjohnson777 Oct 29, 2024
fc14163
PD-1502 / None / Pd 1502 update smb share purpose presets description…
DjP-iX Oct 30, 2024
eb3d60d
Merge branch 'master' into PD-1252-Update/Replace-SMB-Home-Shares-Con…
micjohnson777 Nov 5, 2024
f2aeec9
Merge branch 'master' into PD-1252-Update/Replace-SMB-Home-Shares-Con…
micjohnson777 Nov 7, 2024
4fc4110
Merge branch 'master' into PD-1252-Update/Replace-SMB-Home-Shares-Con…
DjP-iX Nov 8, 2024
637ab96
Merge branch 'master' into PD-1252-Update/Replace-SMB-Home-Shares-Con…
micjohnson777 Nov 13, 2024
7463281
PD-1512 Fix Style issue
micjohnson777 Nov 13, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
174 changes: 115 additions & 59 deletions content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md

Large diffs are not rendered by default.

114 changes: 65 additions & 49 deletions content/SCALE/SCALETutorials/Shares/SMB/_index.md

Large diffs are not rendered by default.

17 changes: 4 additions & 13 deletions content/SCALE/SCALEUIReference/Shares/SMBSharesScreens.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,17 +103,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. 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 use private SMB datasets and shares. This setting enables users to personlize storage management and access control while maintaining data confidentiality. |
| **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 >}}
{{< 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**.
Expand Down Expand Up @@ -166,6 +156,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
Expand Down Expand Up @@ -220,7 +211,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" >}}

Expand All @@ -246,4 +237,4 @@ 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 > Services SMB** row.

{{< include file="/static/includes/addcolumnorganizer.md" >}}
{{< include file="/static/includes/addcolumnorganizer.md" >}}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/SCALE/Shares/AddSMBAdvancedOtherSettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions static/includes/ChangeBuiltin-UserACL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
13 changes: 13 additions & 0 deletions static/includes/SMBPurposePresets.md
Original file line number Diff line number Diff line change
@@ -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 >}}
Loading