Merge branch 'master' into M-Series-Docs-Refresh

Author: tonyriv3

config.toml

@@ -59,7 +59,7 @@ enable = true
 
   # (Optional, default static/brand.svg) Set the path to a logo for the Geekdoc
   # relative to your 'static/' folder.
-  geekdocLogo = "/images/truenas_open_storage-logo-full-color-rgb.png"
+  geekdocLogo = "/images/TrueNAS_Open_Enterprise_Storage.png"
 
   # (Optional, default false) Render menu from data file im 'data/menu/main.yaml'.
   geekdocMenuBundle = false

content/SCALE/GettingStarted/Migrate/ComponentNaming.md

@@ -37,4 +37,8 @@ SCALE still labels NVMe drives with a numeric value.
 TrueNAS CORE identifies bonded interfaces or link aggregations with **lagg** followed by a number (lagg1).
 TrueNAS SCALE uses **bond** followed by a number (bond1).
 
+{{<include file="/static/includes/addcolumnorganizer.md">}}
+
 See the [TrueNAS Systems](https://www.truenas.com/docs/hardware/) section for lists of the default port names for each platform.
+
+

content/SCALE/GettingStarted/Migrate/MigratePrep.md

@@ -34,6 +34,7 @@ CORE Enterprise customers are encouraged to contact Support for assistance with
    CORE systems at the latest 13.0 release can use the [iso upgrade](#migrating-using-an-iso-file-to-upgrade) method to migrate to SCALE.
 
 2. Migrate [GELI-encrypted pools](https://www.truenas.com/docs/core/coretutorials/storage/pools/storageencryption/#geli-pool-migrations) to a non-GELI-encrypted pool before upgrading from CORE 12.0x or earlier releases!
+   If you do not migrate from GELI to ZFS encryption before upgrading to CORE 13.0-Ux or migrating to SCALE you permanently lose access to the data in the GELI encrypted pool(s).
 
 3. Verify the root user is not locked.
    Go to **Accounts > Users**, select the root user and click **Edit** to view current settings and confirm **Lock User** is not selected.
@@ -66,7 +67,12 @@ CORE Enterprise customers are encouraged to contact Support for assistance with
 
    <input type="checkbox"> Data protection tasks - Write down or take screenshots of replication, periodic snapshot, cloud sync, or other task settings to reconfigure these in SCALE if you want to duplicate these tasks.
 
-5. Write down or take screenshots of your network configuration information.
+5. Remove all CORE SMB auxiliary parameter settings before migrating to SCALE. 
+   As of 23.10 SCALE COBIA, the SMB **Auxiliary Parameters** option is no longer available in the UI.
+   Attempting to migrate with these settings can result in broken SMB shares post upgrade that require access to the CLI to fix.
+   We recommend removing these unsupported settings before migrating from CORE to SCALE.
+
+6. Write down or take screenshots of your network configuration information.
    Capture the global network settings, interfaces (LAGG, VLAN, bridge settings), static IP addresses, and aliases.
 
    FreeBSD and Linux use different nomenclature for network interfaces, bridges, LAGGs, and VLANs.
@@ -79,14 +85,14 @@ CORE Enterprise customers are encouraged to contact Support for assistance with
    If there are issues after a clean install of SCALE from an <file>iso</file> file or you are not using DHCP for network and interface configuration, use the information from your CORE settings to configure your SCALE network settings and to reconfigure your static IPs or aliases.
       {{< include file="/static/includes/NetworkInstallRequirementsSCALE.md" >}}
 
-6. Migrate the deprecated S3 MinIO service (if in use). See [services deprecated in SCALE](#migrating-from-deprecated-services).
+7. Migrate the deprecated S3 MinIO service (if in use). See [services deprecated in SCALE](#migrating-from-deprecated-services).
    This is a lengthy process depending on the amount of data stored while using the S3 service.
    Read and follow instructions in [Migrating MinIO Data from CORE to SCALE](https://www.truenas.com/docs/solutions/miniocoretoscale/)!
    Make sure S3 MinIO data is backed up as a precaution. The migration process from the S3 service requires first [migrating to the MinIO plugin in TrueNAS CORE](https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/plugins/minioplugin/#migrating-from-s3-service-to-minio-plugin), migrating from CORE to SCALE, then installing the SCALE MinIO app and importing S3 data.
 
-7. Back up any critical data.
+8. Back up any critical data.
 
-8. Download your [system configuration file](https://www.truenas.com/docs/core/coretutorials/systemconfiguration/usingconfigurationbackups/) and a [debug file](https://www.truenas.com/docs/core/uireference/system/advanced/).
+9. Download your [system configuration file](https://www.truenas.com/docs/core/coretutorials/systemconfiguration/usingconfigurationbackups/) and a [debug file](https://www.truenas.com/docs/core/uireference/system/advanced/).
    After updating to the latest publicly-available release of CORE and making any changes to CORE user accounts or any other settings download these files and keep them in a safe place and where you can access them if you need to revert to CORE with a clean install using the CORE <file>iso</file> file.
 
 After completing the steps that apply to your CORE system listed above, download the [SCALE ISO file](https://www.truenas.com/download-tn-scale/) and save it to your computer.
@@ -180,4 +186,4 @@ To grant access to a specific user (and group) other than using the default admi
 Note the UID and GID for this new user to enter in the application configuration screen.
 
 After disabling the WebDAV service and clearing any existing share configurations from the **Shares > WebDAV** screen in Bluefin, install the **WebDAV** application to recreate your shares using the CORE service settings from your notes. Use the **webdav** user and group in control, and the UID and GID (**666**) in the application.
-{{< /expand >}}
+{{< /expand >}}

content/SCALE/GettingStarted/SCALEReleaseNotes.md

@@ -49,8 +49,8 @@ More details are available from [Software Releases]({{< relref "/TrueNASUpgrades
 * TrueNAS SCALE is an appliance built from specific Linux packages.
   Attempting to update SCALE with `apt` or methods other than the SCALE web interface can result in a nonfunctional system.
 
-* All auxiliary parameters can change between TrueNAS major versions due to security and development changes.
-  We recommend removing all auxiliary parameters from TrueNAS configurations before upgrading.
+* All auxiliary parameters can experience changes between TrueNAS major versions due to security and development changes.
+  We recommend removing all auxiliary parameters from TrueNAS configurations before upgrading as these settings can result in SMB share failures after an upgrade.
 
 * {{< include file="/static/includes/UpgradeClearCache.md" >}}
 

content/SCALE/SCALETutorials/Credentials/DirectoryServices/ConfigIDmapSCALE.md

@@ -28,6 +28,8 @@ Users can click **Add** in the **Idmap** widget to configure backends or click o
 
 TrueNAS automatically generates an Idmap after you configure AD or LDAP.
 
+{{<include file="/static/includes/addcolumnorganizer.md">}}
+
 ## Adding an ID Map
 
 From the **Directory Services** screen, click **Show** to the right of **Advanced Settings** and then click **Confirm** to close the warning dialog.

content/SCALE/SCALETutorials/Credentials/DirectoryServices/ConfigKerberosSCALE.md

@@ -30,6 +30,8 @@ Users can configure Kerberos realms by navigating to **Directory Services** and
 
 Enter the realm and key distribution (KDC) names, then define the admin and password servers for the realm.
 
+{{<include file="/static/includes/addcolumnorganizer.md">}}
+
 Click **Save**. 
 
 ## Kerberos Keytabs

content/SCALE/SCALETutorials/Credentials/ManageLocalUsersSCALE.md

@@ -27,6 +27,8 @@ To see user accounts, go to **Credentials > Local Users**.
 
 TrueNAS hides all built-in users (except root) by default. Click the toggle **Show Built-In Users** to see all built-in users.
 
+{{<include file="/static/includes/addcolumnorganizer.md">}}
+
 ## Creating an Admin User Account
 
 {{< include file="/static/includes/AddAdminUserAccount.md" >}}

content/SCALE/SCALETutorials/DataProtection/CloudSyncTasks/CloudSyncTaskGoogleDrive.md

@@ -65,6 +65,8 @@ To add a cloud sync task, go to **Data Protection > Cloud Sync Tasks** and click
 
 See **Using Scripting and Environment Variables** for more information on [environment variables]({{< relref "/SCALE/SCALETutorials/DataProtection/CloudSyncTasks/_index.md" >}}).
 
+{{<include file="/static/includes/addcolumnorganizer.md">}}
+
 ### Working with Google Created Content
 
 {{< include file="/static/includes/GoogleDriveBadPermissions.md" >}}

content/SCALE/SCALETutorials/DataProtection/CreatingVMwareSnapshots.md

@@ -88,6 +88,8 @@ Virtual machines must be running for TrueNAS to include them in VMWare snapshots
 
 To configure TrueNAS SCALE to create VMWare snapshots, go to **Data Protection** and click the **VMware Snapshot Integration** button in the **Periodic Snapshot Tasks** widget to open the **VMWare Snapshots** screen.
 
+Note that you can organize information in the columns of the table(s) below by clicking on each column title. This allows you to toggle the information between a descending an ascending order.
+
 {{< trueimage src="/images/SCALE/DataProtection/vmwaresnapshottask.png" alt="VMware Snapshot Integration" id="VMware Snapshot Integration" >}}
 
 Click the **Add** button to configure the VMWare Snapshot Task.

content/SCALE/SCALETutorials/DataProtection/Replication/AdvancedReplication/ReplicationWithEncryptionSCALE.md

@@ -108,6 +108,8 @@ This saves some time when creating multiple replication tasks between the same t
 
 {{< include file="/static/includes/ReplicationScheduleAndRetentionSteps.md" >}}
 
+{{<include file="/static/includes/addcolumnorganizer.md">}}
+
 ### Configure a New SSH Connection
 
 {{< include file="/static/includes/ReplicationConfigNewSSHConnection.md" >}}

content/SCALE/SCALETutorials/DataProtection/Replication/LocalReplicationSCALE.md

@@ -62,3 +62,5 @@ Saving changes to the configuration creates a new replication task without alter
       To make it easier to find the snapshot, give it name easy for you to identify. For example, a replicated task named *dailyfull* for a full file system snapshot taken daily.
 
 {{< include file="/static/includes/ReplicationScheduleAndRetentionSteps.md" >}}
+
+{{<include file="/static/includes/addcolumnorganizer.md">}}

content/SCALE/SCALETutorials/DataProtection/SMARTTestsSCALE.md

@@ -102,6 +102,8 @@ Start the S.M.A.R.T. service. Go to **System Settings > Services** and scroll do
 If you have not configured the S.M.A.R.T. service yet, while the service is stopped, click <i class="material-icons" aria-hidden="true" title="Configure">edit</i> to open the service configuration form. See [Services S.M.A.R.T. Screen]({{< relref "SMARTServicesScreen.md" >}}) for more information on service settings.
 Click **Save** to save settings and return to the **Services** screen.
 
+{{<include file="/static/includes/addcolumnorganizer.md">}}
+
 {{< expand "RAID controllers?" "v" >}}
 Disable the S.M.A.R.T. service when a RAID controller controls the disks.
 The controller monitors S.M.A.R.T. separately and marks disks as a **Predictive Failure** on a test failure.

content/SCALE/SCALETutorials/DataProtection/ScrubTasksSCALE.md

@@ -20,6 +20,8 @@ TrueNAS generates a default scrub task when you create a new pool and sets it to
 
 ![ScrubTaskDefaultSCALE](/images/SCALE/DataProtection/scrubtaskpriority.png "Default Scrub Task")
 
+{{<include file="/static/includes/addcolumnorganizer.md">}}
+
 ## Adjusting Scrub/Resilver Priority
 
 {{< include file="/static/includes/ResilverPriority.md" >}}

content/SCALE/SCALETutorials/Datasets/CreatingSnapshots.md

@@ -66,3 +66,5 @@ You can also click the **Manage Snapshots** link on the **Data Protection** widg
 5. (Optional) Select **Recursive** to include child datasets with the snapshot.
 
 6. Click **Save** to create the snapshot.
+
+{{<include file="/static/includes/addcolumnorganizer.md">}}

content/SCALE/SCALETutorials/Datasets/ManageSnapshotsSCALE.md

@@ -84,3 +84,5 @@ Click **Confirm** to activate the **Rollback** button.
 ## Browsing a Snapshot Collection
 
 {{< include file="/static/includes/BrowsingSnapshotCollections1.md" >}}
+
+{{<include file="/static/includes/addcolumnorganizer.md">}}

content/SCALE/SCALETutorials/Network/Interfaces/SettingUpBridge.md

@@ -22,3 +22,5 @@ A bridge can also be used to allow a VM configured on TrueNAS to communicate wit
 {{< include file="/static/includes/BeforeYouBridge.md" >}}
 
 {{< include file="/static/includes/NetworkBridgeSCALE.md" >}}
+
+{{<include file="/static/includes/addcolumnorganizer.md">}}

content/SCALE/SCALETutorials/Shares/AFPMigration.md

@@ -37,6 +37,8 @@ To make the migrated AFP share accessible, start the SMB service.
 
 ![MigratedAFPShareSCALE](/images/SCALE/Shares/MigratedAFPShareSCALE.png "Migrated AFP Share")
 
+{{<include file="/static/includes/addcolumnorganizer.md">}}
+
 ## Connecting Migrated Shares
 
 Since AFP shares migrate to SMB in SCALE, you must use SMB syntax to mount them.

content/SCALE/SCALETutorials/Shares/AddingNFSShares.md

@@ -118,6 +118,8 @@ To begin sharing, click the <span class="material-icons">more_vert</span> on the
 Or you can go to **System Settings > Services**, locate **NFS**, and click the toggle to running.
 Select **Start Automatically** if you want NFS to activate when TrueNAS boots.
 
+{{<include file="/static/includes/addcolumnorganizer.md">}}
+
 {{< hint type=note >}}
 The NFS service does not automatically start on boot if all NFS shares are encrypted and locked.
 {{< /hint >}}

content/SCALE/SCALETutorials/Shares/MixedModeShares.md

@@ -175,6 +175,8 @@ See [Permissions]({{< relref "PermissionsScale.md" >}}) for more information on
 
 After setting the dataset permission, connect to the share.
 
+{{<include file="/static/includes/addcolumnorganizer.md">}}
+
 ### Connecting to a Multiprotocol Share
 After creating and configuring the shares, connect to the mulit-protocol share using either SMB or NFS protocols from a variety of client operating systems including Windows, Apple, FreeBSD, and Linux/Unix systems.
 

content/SCALE/SCALETutorials/Shares/SMB/AddSMBHomeShare.md

@@ -7,14 +7,27 @@ tags:
 - smb
 ---
 
+{{< hint type=important title="Legacy Feature" >}}
+SMB Home Shares are a legacy feature for organizations looking to maintain existing SMB configurations.
+They are not recommended for new deployments.
+
+Future TrueNAS SCALE releases can introduce instability or require configuration changes affecting this legacy feature.
+{{< /hint >}}
+
 ## Setting Up SMB Home Shares
-TrueNAS offers the **Use as Home Share** option, found in the **Add SMB** and **Edit SMB** screen **Advanced Options** settings in the **Other Options** section, for organizations or SMEs that want to use a single SMB share to provide a personal directory to every user account.
+The **Use as Home Share** option, found in the **Add SMB** and **Edit SMB** screen **Advanced Options** settings in the **Other Options** section, is an available option for organizations or SMEs that want to use a single SMB share to provide a personal directory to every user account.
 
 With home shares, each user is given a personal home directory when connecting to the share.
 These home directories are not accessible by other users.
 You can use only one share as the home share, but you can create as many non-home shares as you need or want.
 
-Creating an SMB home share requires configuring the system storage and joining Active Directory.
+<!-- Place holders for future tutorials/links below. Update with links to appropriate procedures as part of PD-1252 -->
+Other options for configuring individual user directories include:
+* Configure a single share on the TrueNAS and provision individual user directories on the client OS. 
+* Create a single SMB share and configure the ACL so that users can create individual directories on the share that inherit write access for the user and grant read access the administrator.
+* Create an SMB share using the **Private SMB datasets and shares** preset that can create per-user datasets under the umbrella of a single share when users access the share.
+
+Creating an SMB home share requires configuring the system storage and provisioning local users or joining Active Directory.
 
 ### Adding Local Share Users
 Go to **Credentials > Local Users** and click **Add**.
@@ -26,7 +39,23 @@ By default, the user **Home Directory** title comes from the user account name a
 
 If existing users require access to the home share, go to **Credentials > Local Users** and edit an existing account.
 
-Adjust the user home directory to the appropriate dataset and give it a name to create their own directory.
+Adjust the user home directory to the appropriate dataset and give it a name to create its own directory.
+
+{{< hint type="important" title="Home Directory Known Impacts" >}}
+{{< include file="/static/includes/24.04HomeDirectory.md" >}}
+
+{{< expand "Why the change?" "v" >}}
+TrueNAS uses the `pam_mkhomdir` PAM module in the pam_open_session configuration file to automatically create user home directories if they do not exist.
+`pam_mkhomedir` returns `PAM_PERM_DENIED` if it fails to create a home directory for a user, which eventually turns into a pam_open_session() failure.
+This does not impact other PAM API calls, for example, `pam_authenticate()`.
+
+TrueNAS SCALE does not include the customized version of `pam_mkhomedir` used in TrueNAS CORE that specifically avoided trying to create the `/nonexistent` directory. This led to some circumstances where users could create the `/nonexistent` directory on SCALE versions before 24.04.
+
+Starting in SCALE 24.04 (Dragonfish), the root filesystem of TrueNAS is read-only, which prevents `pam_mkhomdir` from creating the `/nonexistent` directory in cases where it previously did.
+This results in a permissions error if `pam_open_session()` is called by an application for a user account that has **Home Directory** set to **/nonexistent**.
+{{< /expand >}}
+{{< /hint >}}
+
 
 ### Adding Share Users with Directory Services
 
@@ -62,17 +91,17 @@ Set the **Purpose** to **No presets**, then click **Advanced Options**.
 Scroll down to **Other Options** and set **Use as Home Share**.
 Click **Save**.
 
-Enable the **SMB** service when prompted to make the share is available on your network.
+Enable the **SMB** service when prompted to make the share available on your network.
 
 After saving the dataset, set the permissions.
 
 ### Setting Dataset Permissions
-After creating the share and dataset, you can edit permissions using either the **Edit** option on the **Permissions** widget for the dataset, or use the **Edit Filesystem ACL** option for the share on the **Windows (SMB) Share** widget to open the ACL edit screen for the share dataset.
+After creating the share and dataset, you can edit permissions using either the **Edit** option on the **Permissions** widget for the dataset or use the **Edit Filesystem ACL** option for the share on the **Windows (SMB) Share** widget to open the ACL edit screen for the share dataset.
 See [SMB Shares]({{< relref "ManageSMBShares.md" >}}) for more information on editing the share dataset permissions.
 
 Click on the new dataset. Scroll down to the **Permissions** widget and click **Edit**.
 
-Click the **Owner** dropdown and select the owner, the repeat for **Group**.
+Click the **Owner** dropdown and select the owner, then repeat for **Group**.
 Change the owning group to your Active Directory domain admins. Select **Apply Owner** and **Apply Group**.
 
 ![GroupDomainAdminsSCALE](/images/SCALE/Datasets/GroupDomainAdmins.png "Set the owning group to Domain Admins")

content/SCALE/SCALETutorials/Shares/iSCSI/AddingISCSIShares.md

@@ -284,3 +284,5 @@ Set iSCSI to start when TrueNAS boots up, go to **System Settings > Services** a
 ![iSCSISystemServicesSCALE](/images/SCALE/Shares/iSCSISystemServicesSCALE.png "Starting the iSCSI Service")
 
 Clicking the <i class="material-icons" aria-hidden="true" title="Configure">edit</i> returns to the options in **Shares > Block (iSCSI) Shares Targets**.
+
+{{<include file="/static/includes/addcolumnorganizer.md">}}

content/SCALE/SCALETutorials/Shares/iSCSI/IncreaseISCSIStorage.md

@@ -37,4 +37,6 @@ Click the <i class="material-icons" aria-hidden="true" title="Options">more_vert
 
 Enter a new size in **Filesize**.
 Enter the new value as an integer that is one or more multiples of the logical block size (default 512) larger than the current file size.
-Click **Save**.
+Click **Save**.
+
+{{<include file="/static/includes/addcolumnorganizer.md">}}

content/SCALE/SCALETutorials/SystemSettings/Advanced/ManageCronJobsSCALE.md

@@ -20,6 +20,8 @@ The **Cron Jobs** widget on the **System > Advanced** screen displays **No Cron
 
 ![AdvancedSettingsCronJobWidget](/images/SCALE/SystemSettings/AdvancedSettingsCronJobWidget.png "SCALE Advanced Settings Cron Job Widget")
 
+{{<include file="/static/includes/addcolumnorganizer.md">}}
+
 Click **Add** to open the **Add Cron Job** configuration screen and create a new cron job. If you want to modify an existing cron job, click anywhere on the item to open the **Edit Cron Jobs** configuration screen populated with the settings for that cron job.
 The **Add Cron Job** and **Edit Cron Job** configuration screens display the same settings.