Merge pull request truenas#1454 from truenas/DOCS-3317-BluefinDocs

DOCS-3317: Bluefin Docs branch
powernap · Dec 13, 2022 · 6452977 · 6452977
2 parents 89c2d7a + 129436b
commit 6452977
Show file tree

Hide file tree

Showing 401 changed files with 3,108 additions and 8,287 deletions.
diff --git a/content/Archive.md b/content/Archive.md
@@ -3,6 +3,20 @@ title: "Documentation Archive"
 aliases:
   - /additional-topics/legacy/fn-legacy-docs/release-notes/fn-11.3-u2/
   - /core/notices/scrubresilveradjustments/
+  - /releasenotes/scale/22.02.1/
+  - /releasenotes/scale/22.02.0.1/
+  - /releasenotes/scale/22.02.0/
+  - /releasenotes/scale/22.02-rc.2/
+  - /releasenotes/scale/22.02-rc.1-2/
+  - /releasenotes/scale/22.02-rc.1-1/
+  - /releasenotes/scale/22.02-rc.1/
+  - /releasenotes/scale/21.08-beta.2/
+  - /releasenotes/scale/21.08-beta.1/
+  - /releasenotes/scale/21.06-beta.1/
+  - /releasenotes/scale/21.04-alpha.1/
+  - /releasenotes/scale/21.02-alpha.1/
+  - /releasenotes/scale/20.12-alpha/
+  - /releasenotes/scale/20.10-alpha/
 ---
 
 Welcome to the Documentation Archive!
@@ -13,7 +27,14 @@ Welcome to the Documentation Archive!
 All documentation provided here is end-of-life (EoL) and no longer receives *any* updates.
 {{< /hint >}}
 
-## TrueNAS (Unified)
+## TrueNAS SCALE
+
+{{< expand "TrueNAS SCALE 22.02 (Angelfish)" "v" >}}
+Release notes for each minor release of 22.02 Angelfish are included in the archived docs.
+<a href="https://www.truenas.com/docs/files/SCALE22.02Docs.pdf">TrueNAS SCALE 22.02 (Angelfish)</a>
+{{< /expand >}}
+
+## TrueNAS CORE
 
 {{< hint warning >}}
 **12.0 NVDIMM Alert**

diff --git a/content/CORE/_index.md b/content/CORE/_index.md
@@ -38,7 +38,7 @@ It can also be provided with Enterprise-grade support from iXsystems.
 The current major version of CORE/Enterprise is **13.0**.
 The content in this section documents this version.
 Documentation for previous major versions is available in the [Documentation Archive](/archive).
-This includes the [latest 12.0 release notes](_includes/corereleasenotes/12.0/12.0u8.1/).
+This includes the [latest 12.0 release notes](/_includes/corereleasenotes/12.0/12.0u8.1/).
 
 ## Documentation Sections
 

diff --git a/content/References/ACLPrimer.md b/content/References/ACLPrimer.md
@@ -5,7 +5,7 @@ weight: 9
 
 {{< toc >}}
 
-[TrueNAS SCALE brings full ACL compatibility]({{< relref "/SCALE/SCALETutorials/Storage/Pools/PermissionsSCALE.md" >}}) between Windows and Linux with NFSv4 ACLs on ZFS and eases the challenges of integrating Unix servers in Windows environments.
+[TrueNAS SCALE brings full ACL compatibility]({{< relref "PermissionsSCALE.md" >}}) between Windows and Linux with NFSv4 ACLs on ZFS and eases the challenges of integrating Unix servers in Windows environments.
 
 ## ACL Overview
 
@@ -57,6 +57,8 @@ TrueNAS administrators should also use NFSv4 ACLs if their organization requires
 * NFSv4 can operate alongside CIFS, allowing organizations that use UNIX-based processing systems features to use Windows-based clients. 
 * NFSv4 can also cooperate with CIFS to bypass NFS's 16 group limitation by generating NFS credentials based on Unix *and* Windows groups.
 
+Users should use NFSv4 ACLs when they intend to have nested groups within an SMB share. Since users and nested groups may have different permissions for directories, the NFSv4 Traverse permission can enable users to connect to and move through directories that their nested group may not have read or write access.
+
 ### When to use POSIX ACLs
 
 TrueNAS administrators should use POSIX ACLs when their organization's data backup target does not support native NFSv4 ACLs. Since the Linux platform used POSIX for a long time, many backup products that access the server outside the SMB protocol can't understand or preserve native NFSv4 ACLs.

diff --git a/content/References/SMB.md b/content/References/SMB.md
@@ -20,12 +20,6 @@ Windows 7 clients support server-side copying with [Robocopy](https://docs.micro
 
 [SMB Tips and Tricks](https://www.truenas.com/community/resources/smb-tips-and-tricks.15/) shows helpful hints for configuring and managing SMB networking.
 
-This video explains the process of setting up ACLs with the new UI in FreeNAS 11.3:
-{{< youtube mCfX4sqDmzs >}}
-
-Tom from Lawrence Systems explains setting SMB ACLs in TrueNAS Core 12.0 in this video:
-{{< youtube R-5jbDTCsOE >}}
-
 Another helpful reference is [Methods For Fine-Tuning Samba Permissions](https://www.truenas.com/community/threads/methods-for-fine-tuning-samba-permissions.50739/).
 
 {{< hint warning >}}
@@ -37,6 +31,8 @@ Standard configurations of Windows XP and some configurations of later clients l
 [Security guidance for NTLMv1 and LM network authentication](https://support.microsoft.com/en-us/help/2793313/security-guidance-for-ntlmv1-and-lm-network-authentication) has information about the security implications and ways to enable NTLMv2 on those clients.
 If changing the client configuration is not possible, NTLMv1 authentication can be enabled by selecting the **NTLMv1 auth** option in the SMB service configuration screen.
 
+{{< include file="/_includes/SMBShareMSDOSalert.md" type="page" >}}
+
 To view all active SMB connections and users, enter `smbstatus` in the TrueNAS **Shell**.
 
 Most configuration scenarios require each user to have their own user account and to authenticate before accessing the share.

diff --git a/content/SCALE/GettingStarted/FirstTimeLogin.md b/content/SCALE/GettingStarted/FirstTimeLogin.md
@@ -111,9 +111,9 @@ Users can also use the iXsystems home page to access their customer portal and c
 {{< include file="/content/_includes/DirectoryServicesMonitor.md" type="page" >}}
 
 {{< /expand >}}
-{{< expand "Task Manager" "v" >}}
+{{< expand "Jobs" "v" >}}
 
-{{< include file="/content/_includes/TaskManagerScale.md" type="page" >}}
+{{< include file="/content/_includes/Jobs.md" type="page" >}}
 
 {{< /expand >}}
 {{< expand "Alerts" "v" >}}
@@ -159,18 +159,11 @@ See [Email Screens]({{< relref "/SCALE/SCALEUIReference/TopToolbar/Alerts/EmailS
 {{< /expand >}}
 
 {{< expand "Settings" "v" >}}
-The **Settings** <span class="material-icons">account_circle</span> icon button has options for passwords, web interface preferences, API Keys, and TrueNAS information.
+The **Settings** <span class="material-icons">account_circle</span> icon button has options for passwords, API Keys, and TrueNAS information.
 {{< expand "Change Password" >}}
 
 {{< include file="/content/_includes/ChangeLoggedInUserPassword.md" type="page" >}}
 
-{{< /expand >}}
-{{< expand "Preferences" "v" >}}
-Click on **Preferences** <span class="material-icons">settings_applications</span> to select general preferences for the system that include changing the display color theme and other display options.
-
-![WebUIPreferencesScreen](/images/SCALE/22.02/WebUIPreferencesScreen.png "Web Interface Preferences")
-
-See [Web Interface Preferences Screen]({{< relref "/SCALE/SCALEUIReference/TopToolbar/Settings/WebUIPreferences.md" >}}) for more information on settings.
 {{< /expand >}}
 {{< expand "API Keys" "v" >}}
 Click on **API Keys** <span class="material-icons">laptop</span> to add API keys that identify outside resources and applications without a principal. 

diff --git a/content/SCALE/GettingStarted/Install/ConsoleSetupMenuScale.md b/content/SCALE/GettingStarted/Install/ConsoleSetupMenuScale.md
@@ -44,6 +44,7 @@ The menu provides these options:
 Console setup menu options can change with software updates, service agreements, etc.
 
 {{< hint ok >}}
+
 During boot, TrueNAS attempts to connect to a DHCP server from all live interfaces.
 If it receives an IP address, the Console setup menu displays it under **The web user interface is at:** so you can access the Web UI.
 {{< /hint>}}
@@ -83,7 +84,12 @@ For home users, use 8.8.8.8 as the DNS nameserver address. This allows you to ac
 
 ## Changing the Root Password
 
-Type **2** while in the Console setup menu. Type the new root user password and then re-enter the new password.
+SCALE has implemented rootless login, making the admin user the default account. Change the admin user password in the UI.
+
+{{< hint warning >}}
+The Reset root password option in the console menu is useless if the admin password is enabled and the root user password is disabled in the **Edit User** screen. 
+Disabling a password in the UI prevents the user from logging in with it. 
+{{< /hint >}}
 
 {{< hint warning >}}
 Changing the root password disables 2FA (Two-Factor Authentication).

diff --git a/content/SCALE/GettingStarted/Install/InstallingSCALE.md b/content/SCALE/GettingStarted/Install/InstallingSCALE.md
@@ -14,7 +14,7 @@ tags:
 
 After you [download](https://www.truenas.com/download-tn-scale/) the <file>.iso</file> file, you can start installing TrueNAS SCALE!
 
-This article describes verifying the <file>.iso</file> file and installing SCALE using that file, and selecting the type of installation as either on physical hardware or a virtual machine (VM).
+This article describes verifying the <file>.iso</file> file and installing SCALE using that file, and selecting the type of installation as either on [physical hardware](#installing-on-physical-hardware) or a [virtual machine (VM)](#installing-on-a-virtual-machine).
 
 ## ISO Verification
 The iXsystems Security Team cryptographically signs TrueNAS <file>.iso</file> files so that users can verify the integrity of their downloaded file.
@@ -63,6 +63,7 @@ You need an OpenPGP encryption application for this method of ISO verification.
 4. Go back to the browser page that has the **PGP Public key**. 
    Open and manually confirm that the key is issued for `IX SecTeam <[email protected]>` (iX Security Team) on October 15, 2019 and is signed by an iXsystems account.
 {{< /expand >}}
+
 ### SHA256 Verification
 SHA256 verification uses the checksum to validate/verify the file.
 {{< expand "Click here for the verification process." "v" >}}
@@ -80,6 +81,10 @@ Different checksum values indicate a corrupted installer file that you should no
 
 ## Installing SCALE
 You can install SCALE on either physical hardware or a virtual machine.
+
+{{< hint warning >}}
+Prior to starting the update process, confirm that the system storage has enough space to handle the update. The update stops if there is insufficient space for it to finish.
+{{< /hint >}}
 
 ### Installing on Physical Hardware 
 
@@ -106,15 +111,16 @@ Enter command `dd status=progress if=path/to/.iso of=path/to/USB` in the CLI.
 
 If this results in a permission denied error, use command `sudo dd` with the same parameters and enter the administrator password.
 {{< /expand >}}
-#### Installing on Physical Hardware From Device Media
+
+#### Installing From the Device Media
 
 Before you begin:
 
 * Locate the hotkey defined by the manufacturer of your motherboard to uses in this process.
 * Disable SecureBoot if your system supports it so or set it to **Other OS** so you can boot to the install media.
 
-With the installer added to a device (CD or USB), you can now install TrueNAS SCALE onto the desired system.
-{{< expand "Physical Hardware Install Instructions" "v" >}}
+With the installer added to a device (CD or USB), you can now install TrueNAS SCALE onto the desired system using the TrueNAS installer.
+
 Insert the install media and reboot or boot the system.
 At the motherboard splash screen, use the hotkey defined by your motherboard manufacturer to boot into the motherboard UEFI/BIOS.
 
@@ -128,8 +134,9 @@ Select the install device as the boot drive, exit, and reboot the system.
 If the USB stick is not shown as a boot option, try a different USB slot.
 Which slots are available for boot differs by hardware.
 
+#### Using the TrueNAS Installer Console Setup 
 After the system boots into the installer, follow these steps.
-
+{{< expand "TrueNAs Installer Console Setup Instructions" "v" >}}
 1. Select **Install/Upgrade**.
 
    ![SCALEInstallUpgrade](/images/SCALE/SCALEInstallMainScreen.png "SCALE Install Main Screen")
@@ -151,11 +158,16 @@ After the system boots into the installer, follow these steps.
 
    ![InstallPartition](/images/CORE/12.0/InstallPartitionScreen.png "Install Partition Screen")
 
-4. Next, set a password for the TrueNAS administrative account, named `root` by default.
+4. Next, set a password for the TrueNAS administrative account. 
+   SCALE has implemented rootless login. Create an admin account and password. The system retains root as a fallback but it is no longer the default.
    This account has full control over TrueNAS and is used to log in to the web interface.
    Set a strong password and protect it.
 
-   ![InstallPassword](/images/CORE/12.0/InstallPasswordScreen.png "Install Password Screen")
+   ![SCALEInstallerConsoleSetupAdminAccount](/images/SCALE/22.12/SCALEInstallerConsoleSetupAdminAccount.png "Admin User Screen")
+
+   Next, enter a password for the new admin user.
+
+   ![SCALEInstallerConsoleSetupAdminPassword](/images/SCALE/22.12/SCALEInstallerConsoleSetupAdminPassword.png "Install Password Screen")
 
 5. After following the steps to install, reboot the system and remove the install media.
 
@@ -173,10 +185,9 @@ If the system does not boot into TrueNAS SCALE, there are several things you can
   Be very careful to specify the correct USB stick when using a wipe utility!
 {{< /expand >}}
 {{< /expand >}}
+
 ### Installing on a Virtual Machine 
-{{< expand "Installation Tutorial Video" "v" >}}
-{{< embed-video name="scaleangelfishvminstall" >}}
-{{< /expand >}}
+
 Because TrueNAS SCALE is built and provided as an <file>.iso</file> file, it works on all virtual machine solutions (VMware, VirtualBox, Citrix Hypervisor, etc).
 This section describes installing on a VM using [VMware Workstation Player](https://www.vmware.com/products/workstation-player/workstation-player-evaluation.html) on Windows.
 
@@ -220,6 +231,7 @@ For most hypervisors, the procedure for creating a TrueNAS VM is the same.
 
 4. After rebooting into TrueNAS, install VM tools if applicable for your VM, and if they exist for Debian 11, or ensure they loaded on boot.
 {{< /expand >}}
+
 #### Example VMWare Player 15.5 Installation
 This example describes installing TrueNAS SCALE using VMWare Player 15.5.
 {{< expand " Click here for more information." "v" >}}
@@ -250,10 +262,11 @@ Open VMware Player and click **Create a New Virtual Machine** to enter the New V
 
 5. Power on the machine after creation if desired. Select **Power on this virtual machine after creation**.
 {{< /expand >}}
-#### Add Virtual Disks
+
+#### Adding Virtual Disks
 After installing SCALE on a virtual machine (VM), add virtual disks to the VM. You need a minimum of two disks, 16 GB each. 
 One disk is for the boot environment the other for data storage.
-{{< expand "Adding Virtual Disks" "v" >}}
+{{< expand "Click Here for More Information" "v" >}}
 1. After creating the virtual machine, select it from the virtual machine list and click **Edit virtual machine settings**.
 
 2. Click **Add...** and select **Hard Disk**. Select **SCSI** as the virtual disk type.
@@ -268,6 +281,7 @@ One disk is for the boot environment the other for data storage.
 Repeat this process until enough disks are available for TrueNAS to create ideal storage pools. This depends on your specific TrueNAS use case. 
 See [Pool Creation]({{< relref "PoolCreate.md" >}}) for descriptions of the various pool ("vdev") types and layouts. 
 {{< /expand >}}
+
 #### Using the TrueNAS Installer 
 Just as with installing SCALE on physical hardware, you complete the install in the VM by booting into the TrueNAS installer.
 {{< expand "Using the TrueNAS Installer in a Virtual Machine" "v" >}}
@@ -290,7 +304,11 @@ The machine starts and boots into the TrueNAS installer.
    This account has full control over TrueNAS and is used to log in to the web interface.
    Set a strong password and protect it.
 
-   ![InstallVMPassword](/images/CORE/12.0/InstallVMPasswordScreen.png "Install VM Password Screen")
+   ![SCALEInstallerConsoleSetupAdminAccount](/images/scale/22.12/SCALEInstallerConsoleSetupAdminAccount.png "Admin User Screen")
+
+   Next, enter a password for the new admin user.
+
+   ![SCALEInstallerConsoleSetupAdminPassword](/images/SCALE/22.12/SCALEInstallerConsoleSetupAdminPassword.png "Install Password Screen")
 
 5. Select **Boot via BIOS**.
 

diff --git a/content/SCALE/GettingStarted/Install/SetUpSharing.md b/content/SCALE/GettingStarted/Install/SetUpSharing.md
@@ -13,6 +13,8 @@ tags:
 After setting up storage on your TrueNAS, it is time to begin sharing data!
 There are several sharing solutions available on SCALE, but in this article we discuss the most common. 
 
+{{< include file="/_includes/SMBShareMSDOSalert.md" type="page" >}}
+
 ## Sharing Data Methods
 TrueNAS SCALE provides four types of sharing methods, but this article only discusses three:
 
@@ -24,40 +26,51 @@ TrueNAS SCALE provides four types of sharing methods, but this article only disc
 
 To set up SMB sharing:
 
-1. Create a dataset with **Share Type** set to **SMB**. Go to **Storage > Pools** 
+1. Create a dataset with **Share Type** set to **SMB**: Go to **Datasets** and click on the **Add Dataset** button. 
 
-   a. Go to **Storage > Pools** and click on the <i class="fa fa-ellipsis-v" aria-hidden="true" title="Options"></i> and click **Add Dataset**.
+      ![AddDatasetSCALE](/images/SCALE/22.12/AddDatasetSCALE.png "Add Dataset Widget")
 
-   b. Enter a name and select **SMB** in the **Share Type** field.
+      The **Add Dataset** menu displays on the right side of the screen.
+
+      Enter a **Parent path** and **Name** for the SMB share.
 
-   c. Click **Save**.
+      ![AddDatasetSCALEMenu1](/images/SCALE/22.12/AddDatasetSCALEMenu1.png "Add Dataset Top Menu")
+
+      Select the **Share Type** as **SMB** from the dropdown list.
+
+      ![AddDatasetSCALEMenu2](/images/SCALE/22.12/AddDatasetSCALEMenu2.png "Add Dataset Bottom Menu")
+
+      Click **Save**.
 
 2. Create the TrueNAS user accounts with **Samba Authentication** set.
 
    a. Go to **Credentials > Local Users** and click **Add** to create users. 
 
-      ![LocalUserAddUser](/images/SCALE/22.02/LocalUserAddUser.png "Local User Add User")
+      ![AddUserIdentificationSettings](/images/SCALE/22.12/AddUserIdentificationSettings.png "Add User Identification Settings")
+
+      ![AddUserUserIDAndGroupsSettings](/images/SCALE/22.12/AddUserUserIDAndGroupsSettings.png "Add User User Id an Groups Settings")
 
    b. Enter the values in each required field, and then verify the checkmark for **Samba Authentication** exists.
-
-      ![LocalUserAddUser2](/images/SCALE/22.02/LocalUserAddUser2.png "Local User Verify Samba Authentication")
+      
+      ![AddUserDirPermsAuthSettings](/images/SCALE/22.12/AddUserDirPermsAuthSettings.png "Add User Directories, Permissions and Authentication Settings")
 
    c. Click **Save**.
 
 3. Edit the dataset permissions to set the **Select an ACL Preset** to **Open**.
 
-   a. Go to **Storage > Pools** and click on the <i class="fa fa-ellipsis-v" aria-hidden="true" title="Options"></i> for the dataset, and select **View Permissions**. 
-      The **View Permissions** widget for the selected dataset displays on the right side of the screen.
-
-      ![ViewDatasetPermissionsWidgett](/images/SCALE/22.02/ViewDatasetPermissionsWidget.png "View Dataset Permissions Widget")
+   a. Go to **Datasets**. Select the name of the SMB share you created. Scroll down to the **Permissions** widget on the right side of the screen. 
 
-   b. Click on the <span class="material-icons">edit</span> edit icon to display the **Edit ACL** screen. 
+      ![EditDatasetSMBPermissions](/images/SCALE/22.12/EditDatasetSMBPermissions.png "Edit Dataset SMB Permissions")
+
+      Click the **Edit** button to edit the permissions.
 
-      ![EditACLScreen](/images/SCALE/22.02/EditACLScreen.png "EditACLScreen")
+      ![EditACLSMBShare1SCALE](/images/SCALE/22.12/EditACLSMBShare1SCALE.png "Edit ACL SMB Share")
 
-   c. Select **Use ACL Preset**. The **Select a preset ACL** dialog displays. Select **NFS4_OPEN** from the dropdown list and then click **Continue**.
+   b. Select **Use ACL Preset**. The **Select a preset ACL** dialog displays. Select **NFS4_OPEN** from the dropdown list.
 
-      ![SelectPresetACLNFS4OPEN](/images/SCALE/22.02/SelectPresetACLNFS4OPEN.png "Select Preset ACL NFS4_OPEN")
+      ![UseACLPresetSCALE](/images/SCALE/22.12/UseACLPresetSCALE.png "Select Preset ACL NFS4_OPEN")
+
+   c. Click **Continue**.
 
    d. Click **Save Access Control List**.
 
@@ -91,9 +104,9 @@ To set up SMB sharing:
 
 To set up NFS sharing:
 
-1. Create a dataset with **Share Type** set to **Generic**. Go to **Storage > Pools** 
+1. Create a dataset with **Share Type** set to **Generic**:  
 
-   a. Go to **Storage > Pools** and click on the <i class="fa fa-ellipsis-v" aria-hidden="true" title="Options"></i> and click **Add Dataset**.
+   a. Go to **Datasets** and click on the **Add Dataset** button.
 
    b. Enter a name and select **Generic** in the **Share Type** field.