diff --git a/content/CORE/API/_index.md b/content/CORE/API/_index.md deleted file mode 100644 index 7d47aca658..0000000000 --- a/content/CORE/API/_index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "API Reference" -redirect: "https://www.truenas.com/docs/core/13.0/api/" -description: "Describes how to access the API documentation in TrueNAS 13." -geekdocCollapseSection: true -weight: 160 -aliases: - - /api/rest.html - - /api/websocket.html -related: false ---- - -TrueNAS API documentation is available from the web interface by clicking ** > API Keys > DOCS**. - -![SettingsAPIKeys](/images/CORE/Settings/SettingsAPIKeysDocsButton.png "API Docs location") - -Alternately, append `/api/docs/` to your TrueNAS hostname or IP address in a browser to go directly to the API documentation. - -For convenience, static builds of the current 2.0 API documentation stored on the Docs Hub: -* [Websocket Protocol](/api/core_websocket_api.html) -* [RESTful](/api/core_rest_api.html) - -## CORE Documentation Sections - -{{< include file="/static/includes/COREDocsSections.md" >}} diff --git a/content/CORE/COREPrint.md b/content/CORE/COREPrint.md deleted file mode 100644 index 1f56306065..0000000000 --- a/content/CORE/COREPrint.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "⎙ Download or Print" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/printview/" -description: "View all CORE Documentation in a single page that can be downloaded or printed." -weight: 1 -no_print: "true" -related: false ---- - \ No newline at end of file diff --git a/content/CORE/CORETutorials/CORETutorialsPrint.md b/content/CORE/CORETutorials/CORETutorialsPrint.md deleted file mode 100644 index c287564d18..0000000000 --- a/content/CORE/CORETutorials/CORETutorialsPrint.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "⎙ Download or Print" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/printview/" -description: "View all CORE tutorials as a single html file suitable for download or print." -weight: 1 -no_print: "true" -related: false ---- - - \ No newline at end of file diff --git a/content/CORE/CORETutorials/ChangingDefaultShell.md b/content/CORE/CORETutorials/ChangingDefaultShell.md deleted file mode 100644 index 07482dc041..0000000000 --- a/content/CORE/CORETutorials/ChangingDefaultShell.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Changing the Default Shell" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/changingdefaultshell/" -description: "Describes how to change the default shell on TrueNAS CORE." -weight: 30 -Aliases: -- /core/uireference/shell/ -- /core/coretutorials/usingshell/ -- /core/administration/shell/ -tags: -- shell -- users ---- - -The default shell for an account is the environment that user accesses in a local or SSH session. -The default shell for a new installation is `zsh`. - -You can change the default shell in **Accounts > Users**. -1. Click for the root user and click **Edit**. - - ![AccountsUsersEditRootShell](/images/CORE/Accounts/AccountsUsersEditRootShell.png "Shell Options") - -2. Choose the desired shell from the **Shell** dropdown list and click **SAVE**. - **Shell** options are: - - {{< include file="archive/COREshellOptions.md" >}} diff --git a/content/CORE/CORETutorials/CommunityGuides/ACLPermissionsJails.md b/content/CORE/CORETutorials/CommunityGuides/ACLPermissionsJails.md deleted file mode 100644 index 71eb50ca39..0000000000 --- a/content/CORE/CORETutorials/CommunityGuides/ACLPermissionsJails.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "Setting ACL Permissions for Jailed Applications" -redirect: "https://www.truenas.com/docs/core/13.3/coretutorials/communityguides/aclpermissionsjails/" -description: "Describes how to configure ACL permissions for jailed applications on TrueNAS CORE." -geekdocCollapseSection: true -weight: 20 -tags: -- corecommunityguides ---- - -Various Plugin jails require permissions to access datasets. - -Unless otherwise modified, a dataset is owned by the user **root** and group **wheel**. -Jailed processes like Plex run as their own user. -As a result, a default installation of the Plex plugin cannot read or write any datasets and thus cannot access media files stored in those datasets. -The TrueNAS user must explicitly configure dataset permissions to allow the plugin to use the dataset. - -## Creating a Dataset Access Control List - -To create a dataset Access Control List (ACL) for an application, you need to obtain the Application user ID. -For example, the Plex ID is **972**. - -Other popular Plugin user IDs include: - -* Radarr = **352** -* Sonarr = **351** -* Transmission = **921** -* Sabnzbd = **350** - -To create an ACL for a dataset, log in to the UI and go to **Storage > Pools**. -Click the three dot icon and select **Edit Permissions**. -Click the **Add ACL Item** button to create a new entry. -New entries appear at the bottom of the list of existing ACL items. - -Continuing with Plex as our example, we would enter the following: - -``` -Who: User -User: 972 (Don't worry if it says "Could not find a username for this ID") -ACL Type: Allow -Permissions Type: -Basic Permissions: Read -Flags Type: Basic -Flags: Inherit -``` - -![StoragePoolsPermissionsPlexPermissions](/images/CORE/Storage/StoragePoolsPermissionsPlexPermissions.png "Storage Pools Permissions Plex Permissions") - -If files already exist in the dataset, click the **Apply permissions recursively** checkbox and click **Save**. diff --git a/content/CORE/CORETutorials/CommunityGuides/ETCHostsPersistence.md b/content/CORE/CORETutorials/CommunityGuides/ETCHostsPersistence.md deleted file mode 100644 index 1cd30118a8..0000000000 --- a/content/CORE/CORETutorials/CommunityGuides/ETCHostsPersistence.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "/etc/hosts IP Persistence" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/communityguides/etchostspersistence/" -description: "Describes the process of mapping host or domain names on TrueNAS CORE." -weight: 5 -tags: -- corecommunityguides ---- - -## Description - -Domain Name resolution is the process of mapping host or domain names, such as `mytruenas` or `truenas1.mycompany.com`, to their associated IP addresses. -This is done by a variety of methods. -The quickest method is to read entries in the **hosts** file, which is a local text file containing a list of IP addresses mapped to domain/host names. -Every operating system (OS) that communicates through the TCP/IP protocol has a **hosts** file. - -The **hosts** file can speed up name resolution when a DNS server is not available on the local network. -A DNS server runs networking software that allows it to join the Domain Name System. -This is the standard service used on the Internet for name resolution. -When adding entries to a TrueNAS system **hosts** file, use the TrueNAS web interface to save the entries directly to the configuration database. -Do *not* edit the **hosts** file directly, as any changes are overwritten by the configuration database during reboot. - -## Errors - -{{< expand "I’m trying to use NFS, SSH, and FTP, but I keep receiving reverse DNS or timeout errors." "v" >}} -The fastest domain name resolution method is for the operating system to read the **hosts** file, but if there are no matching entries in the **hosts** file, a DNS server is queried instead. -This is a slower process as the OS has to find the DNS server, send it a query, and wait for an answer. -Timeout errors are common for some network protocols, such as SSH, FTP and NFS, as their connection requests can time out before a DNS server replies. -To speed up name resolution, add entries for commonly used hosts to the **hosts** file. - -### Fix - -To add an entry to the **hosts** file, use a browser to log in to your TrueNAS web interface and follow these steps: - -1. Go to **Network > Global Configuration**. -2. Scroll down to the **Host name database** field and add an entry for the TrueNAS system in the format *IP_address space hostname*. -3. Click **Save**. -{{< /expand >}} diff --git a/content/CORE/CORETutorials/CommunityGuides/LegacyReplication.md b/content/CORE/CORETutorials/CommunityGuides/LegacyReplication.md deleted file mode 100644 index 878b27b898..0000000000 --- a/content/CORE/CORETutorials/CommunityGuides/LegacyReplication.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "Legacy Engine (11.3) Replication" -redirect: "https://www.ixsystems.com/documentation/freenas/11.3-U5/FreeNAS-11.3-U5-User-Guide_screen.pdf" -description: "Describes legacy replication on FreeNAS or TrueNAS 11.3." -weight: 10 -tags: -- corecommunityguides ---- - -{{< hint type=note >}} -This article only applies to FreeNAS or TrueNAS version 11.3. -The **Legacy** replication option in this version provides compatibility with the replication engine used in FreeNAS/TrueNAS 11.2 and earlier. -{{< /hint >}} - -Creating a legacy replication requires creating an SSH connection to the remote system and snapshots generated by a periodic snapshot task. - -## Process Summary - -* Create SSH connection to remote system in **System > SSH Connections** -* Create a periodic snapshot task of the source datasets in **Tasks > Periodic Snapshot Tasks** -* Go to **Tasks > Replication Tasks** and open the advanced creation screen. - * Set **Transport** to **LEGACY** - * Select SSH connection to remote system - * Choose source datasets related to the periodic snapshot task - * Set a target location on the remote system - -## Creating a Legacy Engine Replication - -1. Go to **Tasks > Replication Tasks** and click **ADD**. -2. Select **Advanced Replication**. -3. Select **LEGACY** for the replication **Transport** method to reorganize the screen for the relevant options. - - ![ReplicationLegacyOptions](/images/CORE/Tasks/TasksReplicationLegacy.png "Legacy Replication Options") - -4. Choose the SSH connection to a remote system that stores replicated snapshots. -5. Select the source datasets on the local system using the file browser or manually enter the dataset paths into the field. - To also replicate snapshots of child datasets, set **Recursive**. -6. To choose the replication target, open the file browser and select the dataset to store snapshots. - Entering a path to a new dataset creates that target dataset in the defined file path. -7. The remaining options allow defining how long to keep replicated snapshots, compressing data before replication, and setting a bandwidth limit on the transfer. diff --git a/content/CORE/CORETutorials/CommunityGuides/LegacySMBACLs.md b/content/CORE/CORETutorials/CommunityGuides/LegacySMBACLs.md deleted file mode 100644 index 6c80a56245..0000000000 --- a/content/CORE/CORETutorials/CommunityGuides/LegacySMBACLs.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Setting SMB ACLs on Legacy FreeNAS systems" -redirect: "https://www.ixsystems.com/documentation/freenas/11.3-U5/FreeNAS-11.3-U5-User-Guide_screen.pdf" -description: "Describes how to configure SMB ACLs on legacy FreeNAS or TrueNAS released before 12.0." -weight: 20 -tags: -- corecommunityguides ---- - -{{< hint type=note >}} -This article only applies to versions of FreeNAS or TrueNAS released before 12.0 -{{< /hint >}} - -TrueNAS uses [Samba](https://www.samba.org/) to share pools using the Microsoft SMB protocol. -SMB is built into the Windows and macOS operating systems and most Linux and BSD systems pre-install an SMB client to provide support for the SMB protocol. - -The SMB protocol supports many different types of configuration scenarios, ranging from simple to complex. -The complexity of the scenario depends on several factors: - -* Client operating system types and versions connecting to the share. -* When the network has an active Windows server. -* Active Directory is in use. - -Depending on the specific authentication requirements, it can be necessary to create or import user and group accounts into FreeNAS/TrueNAS. diff --git a/content/CORE/CORETutorials/CommunityGuides/OpenVPN.md b/content/CORE/CORETutorials/CommunityGuides/OpenVPN.md deleted file mode 100644 index c8c3f9cb3d..0000000000 --- a/content/CORE/CORETutorials/CommunityGuides/OpenVPN.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -title: "Configuring a 3rd Party VPN service on TrueNAS" -redirect: "https://www.truenas.com/docs/files/CORE12.0Docs.pdf" -description: "Describes how to configure OpenVPN client on TrueNAS 12.0." -geekdocCollapseSection: true -weight: 20 -tags: -- corecommunityguides ---- - -TrueNAS includes the ability to run OpenVPN. -This is a short tutorial to configure the OpenVPN client on TrueNAS 12.0. - -{{< hint type=note >}} -Many VPN services are provided by 3rd parties that are unaffiliated with iXsystems. -Please verify compatibility and pricing with your provider before integrating with TrueNAS. -{{< /hint >}} - - - -Prerequisite: An OpenVPN server running with a similar configuration to these configuration file settings: - -{{< expand "Example OpenVPN Configuration File" "v" >}} -``` -dev tun -persist-tun -persist-key -cipher AES-128-CBC -auth SHA512 -tls-client -client -resolv-retry infinite -remote vpn.domain.org 1194 udp -lport 0 -verify-x509-name "vpn.domain.org " name -auth-user-pass -remote-cert-tls server -comp-lzo adaptive - - ------BEGIN CERTIFICATE----- -MIIFgNGGD2bjNiJRSeJfugreDJkqhgh57w0BER8GFADBrMtMwEQYJYRRDEwuPcGVu -UW+LBmf6rq+7zqi4UH+f+zB566FOpEwwSjEGA1UETMBEAxMKT3BlblZQTi1DQTEL -... -9Iw5MNx9phXRlZjwMX0L3pteGKNUNJlmgQZSjI1ZNw7K3CZsIB47QFwalqkGFqGr -L0nObyspUxbcdqZVO/vbo3hFjNqVPjqkO4bP94G7D6w+W0ZHF6TXPmScvo2c9XVs -qnpyhawELAHtDy3keG1Hf/A+D6nTGMUb5+7E9Lw9WS+M1B6jrE ------END CERTIFICATE----- - - ------BEGIN CERTIFICATE----- -MIIGGTCCBAGgIBgAwIBABqhkiG9TANBgkw0BABKJZMQsFADwEQYDIEAZEwcGpPVy -iSFcYvI0l24r3zcIF836KryNpb1FKFaYzFszG3bCVSIp9LwVDrz1irMahq/W43Zb -... -D3kash6QiMfbVoxts2TEGMw18tz3ptf5R9QuGAILlfdZbVC9i0hj2wZvIMXZ+MDu -zwjY8zVQnfyxT9gc2rYwZTx057ldXZRqds7H2znKzIDZC9iu+UrQzCmq+s/YXUjy -KyLQVgOUIT6n2vyGuikiOvUczf1S8E8MBZtrvhM= ------END CERTIFICATE----- - - ------BEGIN PRIVATE KEY----- -MIIJQgkqhkiG9IBADANBgw0BAASCQEFACSwgkoAwggEAAQCAoIC71VfhS9wOaSNJ -DCBpBfPtUc6iMzeezb0Dld1TGNmbujIAqOdmcnikE87lnQXA+w1ZIwKouFx2b7zr -... -6IEehZNciHpOU8zGE1RSNH1mqQKT6t0pK7hjGhlbZRsHmE8tGy7aBQi9z38pkunR -M7Dird0Be9Ua6r90+lDczcggzwzHTZ== ------END PRIVATE KEY----- - -key-direction 1 - -# -# 2048 bit OpenVPN static key -# ------BEGIN OpenVPN Static key V1----- -31201c2093539a034a3549b8f109f7a0 -... -c0224e25d9ed3d2b562e94bed507fcac ------END OpenVPN Static key V1----- - -``` -{{< /expand >}} - -## Installing the Certificate Authority - -1. Open **System > CA**. -2. Add a new certificate authority. - - ![CertAuthorityAdd](/images/UserProvided/CertAuthorityAdd.png "Cert Authority Add") - - Give it a name (example: `VPN_CA`) and select **Import CA** as the **Type**. - - ![CertAuthorityImportCA](/images/UserProvided/CertAuthorityImportCA.png "Cert Authority Import CA") - -3. Copy and paste the certificate from the configuration file. - The certificate is found between the tags **** and **** of the OpenVPN config file. - - ![CertAuthorityImportCACertificate](/images/UserProvided/CertAuthorityImportCACertificate.png "Cert Authority Import CA Certificate") - -## Installing the Certificate - -1. Open **System > Certificate**. -2. Add a certificate. - - ![CertificateAdd](/images/UserProvided/CertificateAdd.png "Certificate Add") - -3. Give it a name (example: `VPN`) and select **Import Certificate** as the Type. -4. Copy and paste the certificate found in the OpenVPN config file between the tags **** and ****. -5. Copy and paste the key between the tags **** and **** from the configuration file. - - ![CertificateAddDetails](/images/UserProvided/CertificateAddDetails.png "Certificate Add Details") - -## Configure OpenVPN Service - -With a CA and Certificate created, we can configure the VPN connection next. - -![CertandCAAdded](/images/UserProvided/CertandCAAdded.png "Cert and CA Added") - -1. Go to the **Services** page and find the **OpenVPN Client** entry. -2. Click the   to configure the service. - - ![OpenVPNServiceEdit](/images/UserProvided/OpenVPNServiceEdit.png "OpenVPN Service Edit") - -3. Choose the certificate and Root CA previously installed. -4. Port the remaining parameters found in the OpenVPN configuration file. -5. **Additional parameters** stores options from the configuration files, like the TLS key for authentication or user login/password. - - ![OpenVPNServiceConfigure](/images/UserProvided/OpenVPNServiceConfigure.png "OpenVPN Service Configure") - -## Start the Service - -1. Go to the **Services** page and find the OpenVPN service. -2. Toggle the service to start it. If desired, select the **Start Automatically** checkbox to have the service start each time the system boots. - - ![OpenVPNServiceStart](/images/UserProvided/OpenVPNServiceStart.png "OpenVPN Service Start") - -3. Test if the connection is working using `curl ifconfig.me` in a terminal. - It returns the IP from the VPN connection and not from the local connection. - Turn the OpenVPN client service on and off to see the difference. - -Logs of the OpenVPN client are in **/var/log/messages** and **/var/log/daemon**. diff --git a/content/CORE/CORETutorials/CommunityGuides/_index.md b/content/CORE/CORETutorials/CommunityGuides/_index.md deleted file mode 100644 index fd802b0356..0000000000 --- a/content/CORE/CORETutorials/CommunityGuides/_index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Community Guides" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/communityguides/" -description: "Additional tutorials written by the TrueNAS Community about TrueNAS CORE configuration and use cases." -geekdocCollapseSection: true -weight: 30 -related: false ---- - -Because TrueNAS is both Open Source and complicated, the massive user community often creates recommendations for specific hardware or environments. -User-created recommendations can be added in this location, but be aware these are provided "as-is" and are not officially supported by iXsystems, Inc. - -
- -## Contents - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/CORETutorials/DirectoryServices/ActiveDirectory.md b/content/CORE/CORETutorials/DirectoryServices/ActiveDirectory.md deleted file mode 100644 index ceacfb614f..0000000000 --- a/content/CORE/CORETutorials/DirectoryServices/ActiveDirectory.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "Setting Up Active Directory" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/directoryservices/activedirectory/" -description: "Provides information on how to configure Active Directory (AD) on your TrueNAS." -weight: 10 -aliases: /core/directoryservices/activedirectory/ -tags: -- activedirectory ---- - -The Active Directory (AD) service shares resources in a Windows network. AD provides authentication and authorization services for the users in a network. This eliminates the need to recreate the user accounts on TrueNAS. - -Domain users and groups in local ACLs are accessible after joining AD. Setting up shares acts as a file server. -Joining an AD domain configures the Privileged Access Manager (PAM). This allows domain users to log on via SSH or authenticate to local services. - -It is possible to configure AD services on Windows. Or on Unix-like operating systems running [Samba version 4](https://wiki.samba.org/index.php/Setting_up_Samba_as_an_Active_Directory_Domain_Controller#Provisioning_a_Samba_Active_Directory). - -To configure a connection, you need to know the following items: -* Determine the Active Directory domain controller domain. -* Make sure you have the account credentials for that system. - -## Preparation - -Preparing the following before configuring Active Directory helps ensure the connection process. - -### Time Synchronization -Active Directory relies on [Kerberos](https://tools.ietf.org/html/rfc1510), a time-sensitive protocol. -During the domain join process, the AD domain controller with the [PDC Emulator FSMO Role](https://support.microsoft.com/en-us/help/197132/active-directory-fsmo-roles-in-windows) is added as the preferred NTP server. - -You can change NTP server settings in **System > NTP Servers** if necessary. - -In a default AD environment, the local system time must be in sync with the AD domain controller time. Their times cannot differ from each other by more than 5 minutes. Use an external time source when configuring a virtualized domain controller. TrueNAS creates an **Alert** if the system time gets out of sync with the AD domain controller time. - -The following options apply to time synchronization in TrueNAS: - -* Go to **System > General** and make sure the value in **Timezone** matches the AD Domain Controller. - -![SystemGeneralTimezoneOptions](/images/CORE/System/SystemGeneralTimezoneOptions.png "Timezone Options") - -* Select either local time or universal time in the system BIOS. - -## Connect to the Active Directory Domain - -To connect to Active Directory, go to **Directory Services > Active Directory**. Enter the AD **Domain Name** and account credentials. -Select **Enable** to attempt to join the AD domain immediately after saving the configuration. - -![DirectoryServicesActiveDirectoryExample](/images/CORE/DirectoryServices/DirectoryServicesActiveDirectoryExample.png "Active Directory Example") - -The preconfigured defaults are generally suitable. Advanced options are available for fine-tuning the AD configuration. Click **ADVANCED OPTIONS** to access extra options. - -Click **REBUILD DIRECTORY SERVICE CACHE** to resync the cache if it becomes out of sync. Or if fewer users than expected are available in the permissions editors. - -{{< expand "I don't see any AD information!" "v" >}} -After configuring the Active Directory service, there can be a delay. TrueNAS can take a few minutes to populate the AD information. -To check the AD join progress, open the **Task Manager** in the upper-right corner. -TrueNAS displays any errors during the join process in the **Task Manager**. -{{< /expand >}} - -When the import completes, AD users and groups become available. These have basic dataset permissions or an [Access Control List (ACL)]({{< relref "/CORE/CORETutorials/Storage/Pools/Permissions.md" >}}). Enabled is the default status for the TrueNAS cache. - -Joining AD adds default [Kerberos]({{< relref "/CORE/CORETutorials/DirectoryServices/Kerberos.md" >}}) realms and generates a default `AD_MACHINE_ACCOUNT` keytab. -TrueNAS automatically begins using this default keytab. TrueNAS removes any administrator credentials stored in the TrueNAS configuration file. - -## Related Services: FTP Access - -The recommendation is to use SFTP over FTP. But joined systems do allow FTP access. Keep these caveats in mind: -* Authentication uses *DOMAIN\username* as the user name by default. -* A user home directory needs to exist before joining. -* You cannot add an AD user to the FTP group. Enable local user auth for FTP instead. -* An existing samba homes share created in the GUI is set as the *template homedir* for AD users. This means that AD user home directories are set inside that path. - Proper permissions are vital. -* There are no guarantees about how `proftpd` handles ACLs. -* AD users can have populated homedir information in their LDAP schema. The admin (or `pam_mkhomedir`) must ensure that these paths exist. -* When the admin is pulling home directories from their LDAP schema, take an extra step of caution. Ensure that users aren't writing files to the boot device. - -## Troubleshooting - -Resync the cache if it becomes out of sync. Or if fewer users than expected are available in the permissions editors. Go to **Directory Services > Active Directory > REBUILD DIRECTORY SERVICE CACHE**. - -If you are using Windows Server with 2008 R2 or older, try the following options: - -Create a **Computer** entry on the Windows server Organizational Unit (OU). When creating this entry, enter the TrueNAS host name in the name field. Make sure it is the same name as the one set in the **Hostname** field in **Network > Global Configuration**. Must match the **NetBIOS alias** from **Directory Services > Active Directory > Advanced Options**. - diff --git a/content/CORE/CORETutorials/DirectoryServices/Kerberos.md b/content/CORE/CORETutorials/DirectoryServices/Kerberos.md deleted file mode 100644 index 355b595be9..0000000000 --- a/content/CORE/CORETutorials/DirectoryServices/Kerberos.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "Setting Up Kerberos" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/directoryservices/kerberos/" -description: "Use the Kerberos screen to configure Kerberos realms and keytabs on your TrueNAS." -weight: 40 -aliases: /core/directoryservices/kerberos/ -tags: -- kerberos ---- - -[Kerberos](https://web.mit.edu/kerberos/) is a web authentication protocol that uses strong cryptography. It proves the identity of both client and server over an insecure network connection. - -Kerberos uses *realms* and *keytabs* to authenticate clients and servers. -A Kerberos realm is an authorized domain that a Kerberos server can use to authenticate a client. -Kerberos keytabs allow systems and clients to join an Active Directory or LDAP. Keytabs make it possible to join without entering a password. - -TrueNAS allows configuring both Kerberos realms and keytabs. - -## Kerberos Realms - -Your network must contain a Key Distribution Center (KDC) to add a realm. -Users can configure Kerberos realms. Go to **Directory Services** > Kerberos Realms** and click **ADD**. -By default, TrueNAS creates a Kerberos realm for the local system. - -![DirectoryServicesKerberosRealmsAdd](/images/CORE/DirectoryServices/DirectoryServicesKerberosRealmsAdd.png "Directory Services Kerberos Realms Add") - -Enter the **Realm** name and click **SUBMIT**. - -See [Kerberos Screens]({{< relref "/CORE/UIReference/DirectoryServices/KerberosScreens.md" >}}) for more information on Kerberos screens and settings. - -## Kerberos Keytabs - -Kerberos keytabs allow systems and clients to join an Active Directory or LDAP. Keytabs make it possible to join without entering a password. -A [keytab (key table)](https://web.mit.edu/kerberos/krb5-devel/doc/basic/keytab_def.html) is a file that stores encryption keys for various authentication scenarios. -With keytabs, the TrueNAS system database benefits from this security feature. It does not store the Active Directory or LDAP administrator account password. This could be a security risk in some environments. - -When using a keytab, create and use a less privileged account to perform any required queries. -The TrueNAS system database stores the password for that account. - -### Create Keytab on Windows Server for Active Directory - -To create the keytab on a Windows Server system, open a command prompt and use the [`ktpass`](https://techjogging.com/create-keytab-file-for-kerberos-authentication-in-windows.html) command: - -`ktpass -princ USERNAME@REALM.COM -pass PASSWORD -crypto ENCRYPTION TYPE -ptype KRB5_NT_PRINCIPAL -kvno 0 -out c:\PATH\KEYTABNAME.KEYTAB` where `USERNAME@REALM.COM` is the Windows Server user and principal name written in the format `username@KERBEROS.REALM`. -The Kerberos realm is typically in all caps, but the Kerberos realm case should match the realm name. -Refer to [this note](https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/ktpass#BKMK_remarks) about using `/princ` for more details. - -`PASSWORD` is the Windows Server user password. - -`ENCRYPTION TYPE` is the cryptographic type you want to use. Setting `ENCRYPTION TYPE` to `ALL` allows using all supported cryptographic types. -Users can specify each key instead of ALL: -* **DES-CBC-CRC** is used for compatibility. -* **DES-CBC-MD5** is used for compatibility and adheres more closely to the MIT implementation. -* **RC4-HMAC-NT** uses 128-bit encryption. -* **AES256-SHA1** uses AES256-CTS-HMAC-SHA1-96 encryption. -* **AES128-SHA1** uses AES128-CTS-HMAC-SHA1-96 encryption. - -Specifying cryptographic types creates a keytab with enough privileges to grant tickets. - -`PATH\KEYTABNAME.KEYTAB` is the path where you want to save the keytab and the name you want it to have. - -{{< expand "Example ktpass Command" "v" >}} - -`ktpass -princ admin@WINDOWSSERVER.NET -pass Abcd1234! -crypto ALL -ptype KRB5_NT_PRINCIPAL -kvno 0 -out c:\kerberos\freenas.keytab` -{{< /expand >}} -### Add Windows Keytab to TrueNAS - -After generating the keytab, add it to the TrueNAS system in **Directory Services > Kerberos Keytabs > Add Kerberos Keytab**. - -To instruct the Active Directory service to use the keytab, go to **Directory Services > Active Directory** and click **Advanced Options**. Select the installed keytab using the **Kerberos Principal** dropdown list. - -When using a keytab with Active Directory, **username** and **userpass** in the keytab should match the **Domain Account Name** and **Domain Account Password** fields in **Directory Services > Active Directory**. - -To instruct LDAP to use a principal from the keytab, go to **Directory Services > Active Directory**. Click **Advanced Options**, then select the installed keytab using the **Kerberos Principal** dropdown list. diff --git a/content/CORE/CORETutorials/DirectoryServices/LDAP.md b/content/CORE/CORETutorials/DirectoryServices/LDAP.md deleted file mode 100644 index 9e178dc15a..0000000000 --- a/content/CORE/CORETutorials/DirectoryServices/LDAP.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "Setting Up LDAP" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/directoryservices/ldap/" -description: "Use the LDAP screen to configure Lightweight Directory Access Protocol (LDAP) server settings on your TrueNAS." -weight: 20 -aliases: /core/directoryservices/ldap/ -tags: -- ldap ---- - -Lightweight Directory Access Protocol (LDAP) is an open and cross-platform protocol. It is often used to centralize authentication. TrueNAS includes an [Open LDAP](https://www.openldap.org/) client for accessing information from an LDAP server. An LDAP server provides directory services for finding network resources. This includes finding users and their associated permissions. - -{{< expand "Does LDAP work with SMB?" "v" >}} -LDAP authentication for SMB shares is not enabled. To enable, first determine if LDAP authentication for SMB shares is a requirement. If so, configure the LDAP directory and populate it with Samba attributes. The most popular script for performing this task is `smbldap-tools`. The LDAP server must support SSL/TLS. Import the certificate for the LDAP server CA. Non-CA certificates are not currently supported. -{{< /expand >}} - -## Integrating an LDAP Server with TrueNAS - -To integrate an LDAP server with TrueNAS, go to **Directory Services > LDAP**. - -![DirectoryServicesLDAP](/images/CORE/DirectoryServices/DirectoryServicesLDAP.png "LDAP Options") - -Enter any LDAP server host names or IP addresses. -Separate entries with an empty space. -Entering more than one host name or IP address creates an LDAP failover priority list. - -{{< expand "What does this do?" "v" >}} -If a host does not respond, the system tries the next host in the list until it establishes a new connection. -{{< /expand >}} - -Enter the **Base DN**. -This is the top level of the LDAP directory tree used when searching for resources. -For example, `dc=test,dc=org`. - -Enter the **Bind DN**. -This is the administrative account name on the LDAP server. -For example, `cn=Manager,dc=test,dc=org`. - -Enter the **Bind Password**. -This is the password associated with the account in **Bind DN**. - -The final basic option is **Enable**. -Clearing the **Enable** checkbox disables the LDAP configuration without deleting it. Enable it at a later time without reconfiguring the options. - -To make further changes to the LDAP configuration, click **ADVANCED OPTIONS**. - -See [LDAP Screen]({{< relref "/CORE/UIReference/DirectoryServices/LDAPScreen.md" >}}) for information on basic and advanced option settings. - -See [Kerberos]({{< relref "/CORE/CORETutorials/DirectoryServices/Kerberos.md" >}}) for more information on using Kerberos. - -To configure LDAP certificate-based authentication for the LDAP provider to sign, see [Certificate Signing Requests]({{< relref "CORE/CORETutorials/SystemConfiguration/CreatingCAsandCertificates/CreatingCertificates.md" >}}). - -{{< hint type=important >}} -Support for LDAP **Samba Schema** is deprecated in TrueNAS 13.0 or later. -Users with LDAP and SMB shares configured should begin to migrate legacy Samba domains to Active Directory. -{{< /hint >}} - -Select **Samba Schema** if SMB shares need LDAP authentication and the LDAP server is already configured with Samba attributes. If selected, specify the type of schema from the **Schema** dropdown list. diff --git a/content/CORE/CORETutorials/DirectoryServices/NIS.md b/content/CORE/CORETutorials/DirectoryServices/NIS.md deleted file mode 100644 index 0af2595df3..0000000000 --- a/content/CORE/CORETutorials/DirectoryServices/NIS.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "Setting up NIS" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/directoryservices/nis/" -description: "Use the NIS screen to configure Network Information System (NIS) on your TrueNAS." -weight: 30 -aliases: /core/directoryservices/nis/ -tags: -- nis -- ldap ---- - -NIS ([Network Information Service](https://www.oreilly.com/library/view/practical-unix-and/0596003234/ch14s01.html)) is a client–server directory service protocol. It assists in distributing system configuration data between computers on a network. This data can include user and host names. - -{{< expand "What exactly does this do?" "v" >}} -A NIS system maintains and distributes a central directory. This central directory contains user and group information. It also contains other text-based tables of information. These tables can include host names and e-mail aliases. -In FreeBSD, the file /etc/passwd contains the list of users. The file /etc/shadow contains the authentication hashes. NIS adds another global user list to identify users on any NIS domain client. -{{< /expand >}} - -{{< hint type=important >}} -NIS is limited in scalability and security. -For modern networks, [LDAP]({{< relref "LDAP.md" >}}) has replaced NIS. -{{< /hint >}} - -To configure NIS, go to **Directory Services > NIS**. - -![DirectoryServicesNIS](/images/CORE/DirectoryServices/DirectoryServicesNIS.png) - -Enter the **NIS Domain** name and list any **NIS Servers** (host names or IP addresses). -Press Enter to separate server entries. -Configure the remaining options as needed: - -* **Secure Mode** : Select to have [ypbind(8)](https://www.freebsd.org/cgi/man.cgi?query=ypbind) refuse to bind to any NIS server not running as *root* on a TCP port over **1024**. -* **Manycast** : Select for `ypbind` to bind to the fastest responding server. -* **Enable** : Leave the checkbox clear to disable the configuration without deleting it. - -Click **SAVE** to save configuration settings. - -Click **REBUILD DIRECTORY SERVICE CACHE** to resync the cache if it becomes out of sync. Or if fewer users than expected are available in the permissions editors. diff --git a/content/CORE/CORETutorials/DirectoryServices/_index.md b/content/CORE/CORETutorials/DirectoryServices/_index.md deleted file mode 100644 index 60f89358fb..0000000000 --- a/content/CORE/CORETutorials/DirectoryServices/_index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Directory Services" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/directoryservices/" -description: "Accessing Directory Services on your TrueNAS" -geekdocCollapseSection: true -weight: 100 -tags: -- activedirectory -- ldap -- nis -- kerberos -related: false ---- - -{{< children depth="2" sort="Weight" description="true" >}} diff --git a/content/CORE/CORETutorials/Getting Support.md b/content/CORE/CORETutorials/Getting Support.md deleted file mode 100644 index 24cb12ee1a..0000000000 --- a/content/CORE/CORETutorials/Getting Support.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: "Getting Support" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/getting-support/" -description: "Describes different options for getting support for TrueNAS CORE." -weight: 16 -aliases: - - /core/system/support - - /_includes/createdebugcore/ -tags: -- support ---- - - -There are several options to get support for your TrueNAS installation. -TrueNAS CORE users can engage with the TrueNAS community to answer questions and resolve issues. TrueNAS Enterprise hardware customers can also access the fast and effective support directly provided by iXsystems. - -TrueNAS CORE users are welcome to report bugs and vote for or suggest new TrueNAS features in the project Jira instance. -Have questions? We recommend searching through the software documentation and community resources for answers. - -## Reporting a Bug - -If you encounter a bug or other issue while using TrueNAS, create a bug report in the [TrueNAS Jira Project](https://ixsystems.atlassian.net/projects/NAS/). -The web interface provides a form to report issues without logging out. -We recommend searching the project first to see if another user already reported the issue. -You must have [a Jira account](https://ixsystems.atlassian.net/secure/Signup!default.jspa) to create a bug ticket. - -To report an issue using the web interface, go to **System > Support**. - -{{< trueimage src="/images/CORE/System/UIBugReport.png" alt="Writing a Bug Report" id="Writing a Bug Report" >}} - -Enter your Jira **Username** and **Password** to verify your account credentials and unlock the **SUBMIT** button. -The **Category** dropdown has a large number of options. -Choose the category that best fits where you encountered the issue. - -Attaching a debug file and screenshot(s) to your bug ticket is generally recommended to help find the bug and speed up response. -Select **Attach Debug** to automatically generate a new debug and privately attach it to the issue. -Private debug attachments are only visible to iXsystems engineering staff. - -Keep the **Subject** brief and informative. -Having a short, descriptive subject allows the community to easily find and respond to your issue. -The **Description** should contain more details about the problem. -We recommend keeping the description less than three paragraphs and including any steps to reproduce the issue. - -### Creating a Debug File -{{< include file="/static/includes/CreateDebugCORE.md" >}} - -## Suggesting New Features - -{{< include file="/static/includes/CreateFeatureRequest.md" >}} - -## TrueNAS Community - -{{< include file="/static/includes/CommunityForums.md" >}} - -## Social Media - -You are always welcome to network with other TrueNAS users using the various social media platforms! - -* [Reddit](https://www.reddit.com/r/truenas/) -* [X (Formerly Twitter)](https://twitter.com/TrueNAS) -* [LinkedIn](https://www.linkedin.com/groups/3903140/) -* [Facebook](https://www.facebook.com/truenascommunity) - -## TrueNAS Enterprise - -{{< enterprise >}} -Proactive Support and the Contact Support options below are only available on TrueNAS Enterprise licensed systems. -Contact the [iXsystems Sales Team](mailto:sales@ixsystems.com) to inquire about purchasing TrueNAS Enterprise licenses. -{{< /enterprise >}} - -In addition to all the TrueNAS CORE support options, TrueNAS Enterprise customers who purchase hardware from iXsystems can receive assistance from iXsystems if an issue occurs. - -Silver and Gold level Support customers can also enable Proactive Support on their hardware to automatically notify iXsystems if an issue occurs. -To find more details about the different Warranty and Service Level Agreement (SLA) options available, see https://www.ixsystems.com/support/. - -### Production System Reporting - -Once the system is ready to be in production, update the status by checking the **This is a production system** checkbox and click the **Update Status** button. This will send an email to iXsystems declaring that the system is in production. TrueNAS has an option to include a debug with the email that could assist support in the future. - -### Configuring Proactive Support - -Proactive Support notifies iXsystems by email whenever hardware conditions on the system require attention. -This feature is available to iXsystems Silver and Gold Support customers. - -{{< trueimage src="/images/CORE/System/SystemSupportProactiveEnterprise.png" alt="Proactive Support: Enterprise" id="Proactive Support: Enterprise" >}} - -Be sure to add valid email addresses and phone numbers for the contacts to be quickly notified of any issues. - -You can also toggle automatic iXsystems support alerts in the system console menu with `/etc/netcli`. -Failover must be disabled in TrueNAS High Availability systems before this option can be toggled. -To administratively disable failover in the web interface, go to **System > Failover**. - -### Filing a Support Ticket - -TrueNAS Enterprise customers can file tickets directly with iXsystems Support by going to **System > Support**. - -{{< trueimage src="/images/CORE/System/SystemSupportContactEnterprise.png" alt="Support Contact: Enterprise" id="Support Contact: Enterprise" >}} - -Be sure to enter a valid **Email** and **Phone** number. -iXsystems Support uses this information to quickly respond to and resolve the issue. -You can also indicate the system's current use and identify how critical the issue is to system usability. - -We recommend always attaching a debug and screenshots to help speed up diagnosing and resolving the issue. -Select **Attach Debug** to automatically generate a new debug and privately attach it to the issue. -Private debug attachments are only visible to iXsystems engineering staff. - -An informative **Subject** and **Description** that briefly describes the problem and if there are any steps to reproduce the issue is also helpful. - -Clicking **SUBMIT** generates and sends the support ticket to iXsystems. -This process can take several minutes while information is collected and sent. -TrueNAS sends an email alert if ticket creation fails while Proactive Support is active. - -After the creating the new ticket, TrueNAS displays the ticket URL for viewing or updating with more information. -You must have an [iXsystems Support](https://support.ixsystems.com/) account to view the ticket. -Click the URL to log in or register with the support portal. -Use the same email address submitted with the ticket when registering. - -## Contacting iXsystems Support - -{{< include file="/static/includes/iXsystemsSupportContact.md" >}} diff --git a/content/CORE/CORETutorials/JailsPluginsVMs/Jails/AccessingJailsUsingSSH.md b/content/CORE/CORETutorials/JailsPluginsVMs/Jails/AccessingJailsUsingSSH.md deleted file mode 100644 index d3c288da2f..0000000000 --- a/content/CORE/CORETutorials/JailsPluginsVMs/Jails/AccessingJailsUsingSSH.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: "Accessing Jails Using SSH" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/jails/accessingjailsusingssh/" -description: "Describes how to access Jails using SSH in TrueNAS CORE." -weight: 20 -tags: -- jails ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -## Accessing a Jail Using SSH - -You must enable the ssh daemon [sshd(8)](https://www.freebsd.org/cgi/man.cgi?query=sshd) in a jail to allow SSH access to that jail from another system. - -The jail **STATE** must be up before the **SHELL** option is available. - -### Starting a Jail - -When the jail is not up, start it by clicking **Jails** > and then the jail , then click **START** for the desired jail. -Click , then **SHELL** to open a shell inside the jail: - -``` -FreeBSD 11.1-STABLE (FreeNAS.amd64) #0 0ale9f753(freenas/11-stable): FriApr 6 04:46:31 UTC 2018 - -Welcome to FreeBSD! - -Release Notes, Errata: https://www.FreeBSD.org/releases/ -Security Advisories: https://www.FreeBSD.org/security/ - -FreeBSD FAQ: https://www.FreeBSD.org/faq/ -Questions List: https://lists.FreeBSD.org/mailman/listinfo/freebsd-questions/ -FreeBSD Forums: https://forums.FreeBSD.org/ - -Documents installed with the system are in the /usr/local/share/doc/freebsd/ -directory, or can be installed later with: pkg install en-freebsd-doc -For other languages, replace "en" with a language code like de or fr. - -Show the version of FreeBSD installed: freebsd-version ; uname -a -Please include that output and any error messages when posting questions. -Introduction to manual pages: man man -FreeBSD directory layout: man hier - -Edit /etc/motd to change this login announcement. -root@jailexamp:~ # -``` - -You can also enter a jail shell from the root shell. -Open shell and enter the command `iocage console jailname`. - -Enable sshd: - -``` -sysrc sshd_enable="YES" -sshd_enable: NO -> YES -``` - -Start the SSH daemon: `service sshd start`. -The first time the service runs, the jail RSA key pair is generated and the key fingerprint is displayed. -Add a user account with `adduser` and follow the prompts. -Enter accepts the default value. -Users that require root access must also be a member of the `wheel` group. -Enter `wheel` when prompted to `invite user into other groups`? - -``` -root@jailexamp:~ # adduser -Username: jailuser -Full name: Jail User -Uid (Leave empty for default): -Login group [jailuser]: -Login group is jailuser. Invite jailuser into other groups? []: wheel -Login class [default]: -Shell (sh csh tcsh git-shell zsh rzsh nologin) [sh]: csh -Home directory [/home/jailuser]: -Home directory permissions (Leave empty for default): -Use password-based authentication? [yes]: -Use an empty password? (yes/no) [no]: -Use a random password? (yes/no) [no]: -Enter password: -Enter password again: -Lock out the account after creation? [no]: -Username : jailuser -Password : ***** -Full Name : Jail User -Uid : 1002 -Class : -Groups : jailuser wheel -Home : /home/jailuser -Home Mode : -Shell : /bin/csh -Locked : no -OK? (yes/no): yes -adduser: INFO: Successfully added (jailuser) to the user database. -Add another user? (yes/no): no -Goodbye! -root@jailexamp:~ -``` - -After creating the user, set the jail root password to allow users to use `su` to gain superuser privileges. -To set the jail root password, use `passwd`. -Nothing echoes back when using `passwd`: - -``` -root@jailexamp:~ # passwd -Changing local password for root -New Password: -Retype New Password: -root@jailexamp:~ # -``` - -Finally, test that the user can successfully `ssh` into the jail from another system and gain superuser privileges. -In this example, a user named `jailuser` uses `ssh` to access the jail at *192.168.2.3*. -The host RSA key fingerprint must be verified the first time a user logs in. - -``` -ssh jailuser@192.168.2.3 -The authenticity of host '192.168.2.3 (192.168.2.3)' can't be established. -RSA key fingerprint is 6f:93:e5:36:4f:54:ed:4b:9c:c8:c2:71:89:c1:58:f0. -Are you sure you want to continue connecting (yes/no)? yes -Warning: Permanently added '192.168.2.3' (RSA) to the list of known hosts. -Password: -``` - -Every jail has its own user accounts and service configuration. -These steps must be repeated for each jail that requires SSH access. diff --git a/content/CORE/CORETutorials/JailsPluginsVMs/Jails/InstallingJailSoftware.md b/content/CORE/CORETutorials/JailsPluginsVMs/Jails/InstallingJailSoftware.md deleted file mode 100644 index aa59d52bc9..0000000000 --- a/content/CORE/CORETutorials/JailsPluginsVMs/Jails/InstallingJailSoftware.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -title: "Installing Software" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/jails/installingjailsoftware/" -description: "Describes how to install software using Jails in TrueNAS CORE." -weight: 20 -Aliases: /core/applications/jails/software/ -tags: -- jails -- plugins ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -A jail is created with no software aside from the core packages installed as part of the selected version of FreeBSD. -To install software into a jail, go to the **Jails** screen and expand the jail entry. -Start the jail, then after the jail boots, click **> SHELL**. - -![JailsShellExample](/images/CORE/Jails/JailsShellExample.png "Jail Shell") - -## Installing FreeBSD Packages - -The quickest and easiest way to install software inside the jail is to install a FreeBSD package. -FreeBSD packages are precompiled and contain all the binaries and a list of dependencies required for the software to run on a FreeBSD system. - -A huge amount of software has been ported to FreeBSD. -Most of that software is available as packages. -One way to find FreeBSD software is to use the search bar at [FreshPorts.org](https://www.freshports.org/). - -After finding the name of the desired package, use the `pkg install` command to install it. -For example, to install the **audiotag** package, enter `pkg install audiotag`. -When prompted, press y to complete the installation. -Messages show the download and installation status. - -{{< expand "Confirming the Installation" >}} -A successful installation is confirmed by querying the package database: - -``` -pkg info -f audiotag -audiotag-0.19_1 -Name: audiotag -Version: 0.19_1 -Installed on: Fri Nov 21 10:10:34 PST 2014 -Origin: audio/audiotag -Architecture: freebsd:9:x86:64 -Prefix: /usr/local -Categories: multimedia audio -Licenses: GPLv2 -Maintainer: ports@FreeBSD.org -WWW: https://github.com/Daenyth/audiotag -Comment: Command-line tool for mass tagging/renaming of audio files -Options: - DOCS: on - FLAC: on - ID3: on - MP4: on - VORBIS: on -Annotations: - repo_type: binary - repository: FreeBSD -Flat size: 62.8KiB -Description: Audiotag is a command-line tool for mass tagging/renaming of audio files - it supports the vorbis comment, id3 tags, and MP4 tags. -WWW: https://github.com/Daenyth/audiotag -``` -{{< /expand >}} -{{< expand "Showing what the Package Installed" >}} - -To show what was installed by the package: - -``` -pkg info -l audiotag -audiotag-0.19_1: -/usr/local/bin/audiotag -/usr/local/share/doc/audiotag/COPYING -/usr/local/share/doc/audiotag/ChangeLog -/usr/local/share/doc/audiotag/README -/usr/local/share/licenses/audiotag-0.19_1/GPLv2 -/usr/local/share/licenses/audiotag-0.19_1/LICENSE -/usr/local/share/licenses/audiotag-0.19_1/catalog.mk -``` -{{< /expand >}} -In FreeBSD, third-party software is always stored in /usr/local to differentiate it from the software that came with the operating system. -Binaries are almost always located in a subdirectory called bin or sbin and configuration files in a subdirectory called etc. - -## Compiling FreeBSD Ports - -Compiling a port is another option. Compiling ports offer these advantages: - -* Some ports, but not every port, have an available package. This is usually due to licensing restrictions or known, unaddressed security vulnerabilities. -* Sometimes the package is out-of-date and a feature is needed that only became available in the newer version. -* Some ports provide compile options that are not available in the pre-compiled package. These options are used to add or remove features or options. - -Compiling a port has these disadvantages: - -* It takes time. Depending upon the size of the application, the amount of dependencies, the speed of the CPU, the amount of RAM available, and the current load on the TrueNAS system, the time needed can range from a few minutes to a few hours or even to a few days. -* If the port does not provide any compile options, it saves time and preserves the TrueNAS system resources to use the `pkg install` command instead. The [FreshPorts.org](https://www.freshports.org/) listing shows whether a port has any configurable compile options. - -![AudiotagDetails](/images/CORE/AudiotagDetails.png "Audio Tag Details") - -### Audiotag Port Information - -Packages are built with default options. -Ports let the user select options. - -You must install the FreeBSD Ports Collection in the jail before ports can be compiled. -Inside the jail, use the `portsnap` command utility. -This command downloads the ports collection and extracts it to the /usr/ports/ directory of the jail: - -``` -portsnap fetch extract -``` - -To install additional software at a later date, make sure the ports collection is updated with `portsnap fetch update`. - -To compile a port, `cd` into a subdirectory of /usr/ports/. -The entry for the port at FreshPorts provides the location to `cd` into and the `make` command to run. -This example compiles and installs the *audiotag* port: - -``` -cd /usr/ports/audio/audiotag -make install clean -``` - -The configure screen displays the first time this command is run. - -![JailsShellAudiotagInstall](/images/CORE/Jails/JailsShellAudiotagInstall.png "AudioTag Configuration") - -### Audiotag Port Configuration Options - -This port has several configurable options: DOCS, FLAC, ID3, MP4, and VORBIS. -Selected options are shown with a `*`. - -Use the arrow keys to select an option and press spacebar to toggle the value. -Press Enter when satisfied with the options. -The port begins to compile and install. - -After options are selected, the configuration screen does not normally display again. -Use `make config` to display the screen and change options before rebuilding the port with `make clean install clean`. - -Many ports depend on other ports. -Those other ports also have configuration screens that are shown before compiling begins. -It is a good idea to watch the compile until it finishes and the command prompt returns. - -Installed ports are registered in the same package database that manages packages. -The `pkg info` command determines which ports installed. - -## Starting Installed Software - -After packages or ports are installed, you must configure and stare them. -Configuration files are usually in /usr/local/etc or a subdirectory of it. -Many FreeBSD packages contain a sample configuration file as a reference. -Take some time to read the software documentation to learn which configuration options are available and which configuration files require editing. - -Most FreeBSD packages that contain a startable service include a startup script that is automatically installed to /usr/local/etc/rc.d/. -After the configuration is complete, test starting the service by running the script with the onestart option. -For example, when openvpn is installed in a jail, these commands verify that the service has started: - -``` -/usr/local/etc/rc.d/openvpn onestart -Starting openvpn. - -/usr/local/etc/rc.d/openvpn onestatus -openvpn is running as pid 45560. - -sockstat -4 -USER COMMAND PID FD PROTO LOCAL ADDRESS FOREIGN ADDRESS -root openvpn 48386 4 udp4 *:54789 *:* -``` - -If it produces an error: - -``` -/usr/local/etc/rc.d/openvpn onestart -Starting openvpn. -/usr/local/etc/rc.d/openvpn: WARNING: failed to start openvpn -``` - -Enter `tail /var/log/messages` to see any error messages if an issue is found. -Most startup failures are related to a misconfiguration in a configuration file. - -After verifying that the service starts and is working as intended, add a line to /etc/rc.conf to start the service automatically when the jail is started. -The line to start a service always ends in `_enable="YES"` and typically starts with the name of the software. -For example, this is the entry for the *openvpn* service: - -`openvpn_enable="YES"` - -When in doubt, the startup script shows the line to put in /etc/rc.conf. -This is the description in /usr/local/etc/rc.d/openvpn: - -``` -# To run additional instances link this script to something like -# % ln -s openvpn openvpn_foo - -# and define additional openvpn_foo_* variables in one of -# /etc/rc.conf, /etc/rc.conf.local or /etc/rc.conf.d /openvpn_foo - -# -# Below NAME should be substituted with the name of this script. By default -# it is openvpn, so read as openvpn_enable. If you linked the script to -# openvpn_foo, then read as openvpn_foo_enable etc. -# -# The following variables are supported (defaults are shown). -# You can place them in any of -# /etc/rc.conf, /etc/rc.conf.local or /etc/rc.conf.d/NAME -# -# NAME_enable="NO" -# set to YES to enable openvpn -``` - -The startup script also indicates if any additional parameters are available: - -``` -# NAME_if= -# driver(s) to load, set to "tun", "tap" or "tun tap" -# -# it is OK to specify the if_ prefix. -# -# # optional: -# NAME_flags= -# additional command line arguments -# NAME_configfile="/usr/local/etc/openvpn/NAME.conf" -# --config file -# NAME_dir="/usr/local/etc/openvpn" -# --cd directory -``` diff --git a/content/CORE/CORETutorials/JailsPluginsVMs/Jails/ManagingJails.md b/content/CORE/CORETutorials/JailsPluginsVMs/Jails/ManagingJails.md deleted file mode 100644 index eaf8413364..0000000000 --- a/content/CORE/CORETutorials/JailsPluginsVMs/Jails/ManagingJails.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "Managing Jails" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/jails/managingjails/" -description: "Describes how to manage Jails in TrueNAS CORE." -weight: 10 -aliases: /core/applications/jails/manage/ -tags: -- jails -- plugins ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -The **Jails** screen displays a list of jails installed on your system. - -![Jails](/images/CORE/Jails/Jails.png "Jails List") - -Jail status messages and command output are stored in /var/log/iocage.log. - -## Applying Operations to Multiple Jails - -Operations can be applied to multiple jails by selecting those jails with the checkboxes on the left. -After selecting one or more jails, icons display which can be used on the selected jails: - - starts jails - - stops jails - - updates jails - - deletes jails - -To see more information such as **IPV4**, **IPV6**, jail **TYPE**, and whether it is a **TEMPLATE** or **BASEJAIL** click **>** to expand a jail. -Additional options for that jail also display. - -For more information on jail options, see [Jails]({{< relref "/CORE/CORETutorials/JailsPluginsVMs/Jails/_index.md" >}}). - -## Modifying Jail IP Addresses - -{{< hint type=important >}} -To modify the IP address information for a jail, click the for the jail and then **EDIT** instead of issuing the networking commands directly from the command line of the jail. -This ensures changes are saved and survive a jail or TrueNAS reboot. -{{< /hint >}} diff --git a/content/CORE/CORETutorials/JailsPluginsVMs/Jails/SettingUpJailStorage.md b/content/CORE/CORETutorials/JailsPluginsVMs/Jails/SettingUpJailStorage.md deleted file mode 100644 index b925989eb2..0000000000 --- a/content/CORE/CORETutorials/JailsPluginsVMs/Jails/SettingUpJailStorage.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: "Setting Up Jail Storage" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/jails/settingupjailstorage/" -description: "Describes how to set up jail storage in TrueNAS CORE." -weight: 30 -aliases: /core/applications/jails/storage/ -tags: -- jails -- plugins ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -Jails can be given access to an area of storage outside of the jail that is configured on the TrueNAS system. -It is possible to give a FreeBSD jail access to an area of storage on the TrueNAS system. -This is useful for applications or plugins that store large amounts of data or if an application in a jail needs access to data stored on the TrueNAS system. -For example, the Transmission plugin that stores data using BitTorrent. -Add the TrueNAS external storage using the [mount_nullfs(8)](https://www.freebsd.org/cgi/man.cgi?query=mount_nullfs) mechanism, which links data that resides outside of the jail as a storage area within a jail. - -Stop the jail before adding a mount point. A jail must have a **STATE** of **down** before adding a new mount point. -Click and for the jail to change the jail to the down state. - -To add storage, click on the to expand the jail, then click on **MOUNT POINTS**. -The **MOUNT POINT** screen lists all of the currently defined mount points. - -Click on **Actions** and select **Add** on the **Mount Point** screen to add storage to a jail. - -![Jails Mountpoint Add](/images/CORE/Jails/JailMountpointAdd.png "Jails Mountpoint Add") - -Browse to the **Source** and **Destination** mount points (paths to the datasets), where: - -* **Source** is the directory or dataset on the TrueNAS system you give the jail access to. This is the dataset you create for this purpose. - - TrueNAS creates the directory if it does not exist. - This directory must reside outside of the pool or dataset the jail uses. - This is why it is recommended to create a separate dataset to store jails. - The dataset holding the jails is always separate from any datasets used for storage on the TrueNAS system. - -* **Destination** is an existing and empty directory (listed on the screen) within the jail to link to the **Source** storage area. This is the directory you want to use. - - Add a backslash **/** and a name to the end of the path to allow TrueNAS to create a new directory. - New directories created must be within the jail directory structure. For example, the path is **/mnt/iocage/jails*/*jailname*/root/*new-directory***. - -{{< expand "Creating a Mount Point in an SSH Session" "v" >}} -Using the same example above, you can create a mount point from an SSH session by entering the following commands: - -Create the new directory with command: - -iocage exec jailname mkdir -p /new-directory - -then create the mount point with command: - -iocage fstab -jail jailname /mnt/iocage/jails/jailname/root /new-directory -{{< /expand >}} - -After adding or creating storage, it displays on the **Mount Points** screen for that jail. - -![Jails Mountpoint Example](/images/CORE/Jails/JailMountpointExample.png "Jails Mountpoint Example") - -Storage automatically mounts as it is created. -Mounting a dataset does not automatically mount child datasets inside it. -Each dataset is a separate file system, so child datasets must each have separate mount points. - -### Dataset Permissions and Mount Points -Storage is typically added because the user and group account associated with an application installed inside of a jail needs to access data stored on the TrueNAS system. -Before selecting the **Source**, it is important to ensure that the permissions of the selected directory or dataset grant permission to the user or group account inside the jail. -This is not the default, as the users and groups created inside a jail are separate from the users and groups created on the TrueNAS system. - -### Typical Adding Jail Storage Workflow -Here is a typical workflow for adding jail storage: - -1. Determine the name of the user and group account used by the application. - For example, the installation of the Transmission application automatically creates a user account and group account each named *transmission*. - When in doubt, check the files /etc/passwd (to find the user account) and /etc/group (to find the group account) inside the jail. - - Typically, the user and group names are similar to the application name. - Also, the UID and GID are usually the same as the port number used by the service. - A *media* user and group (GID *8675309*) are part of the base system. - Having applications run as this group or user makes it possible to share storage between multiple applications in a single jail, between multiple jails, or even between the host and jails. - -2. Create a user account and group account that match the user and group names used by the jail application on the TrueNAS system. - -3. Decide if the jail needs access to existing data or if a new storage area should be created. - - If the jail needs to access existing data, [edit the permissions]({{< relref "/CORE/CORETutorials/Storage/Pools/Permissions.md" >}}) of the pool or dataset so the user and group accounts have read and write access. - When multiple applications or jails need access to the same data, create a new group and add each new user account to that group. - - If you are setting aside a new storage area for that jail or application, [create a dataset]({{< relref "/CORE/CORETutorials/Storage/Pools/Datasets.md" >}}). - Edit the dataset permissions so the user and group account has the desired read and write access. - -4. Use the jail , then click **MOUNT POINTS**. - Next click on **ACTIONS** and select **Add**, then browse to select the data source and the jail mount destination paths. - -To prevent writes to the storage, select **Read-Only**. - -### Deleting a Mount Point -Click and then **Delete** to delete the storage. - -### Adding Pointers to Datasets (Directories) -{{< hint type=important >}} -Remember that added storage is just a pointer to the selected storage directory on the TrueNAS system. -It does not copy that data to the jail. -Files that are deleted from the **Destination** directory in the jail are also deleted from the **Source** directory on the TrueNAS system. -However, removing the jail storage entry only removes the pointer. -This leaves the data intact but no longer accessible to the jail. -{{< /hint >}} - -If you want to access data stored in a dataset from a directory in the plugin, add a jail mount point from the host dataset to the plugin directory. Remember to stop the jail before adding mount points, and when finished, start the jail again. -For example, the host path */mnt/tank/all-media* wants to see what is in the */media* directory for the plugin, then create a mount point to add */mnt/tank/all-media* in the */media* directory to see the files in the host dataset *all-media*. -Do this for each dataset you want to see in a jail. -Make sure the user and group permissions are set to allow what the plugin expects. diff --git a/content/CORE/CORETutorials/JailsPluginsVMs/Jails/_index.md b/content/CORE/CORETutorials/JailsPluginsVMs/Jails/_index.md deleted file mode 100644 index f004871261..0000000000 --- a/content/CORE/CORETutorials/JailsPluginsVMs/Jails/_index.md +++ /dev/null @@ -1,228 +0,0 @@ ---- -title: "Jails" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/jails/creatingjails/" -description: "Information on creating jails, and articles related to jails, plugins and virtual machines in TrueNAS CORE." -geekdocCollapseSection: true -aliases: - - /core/applications/jails/create/ - - /core/coretutorials/jailspluginsvms/jails/creatingjails/ - - /core/applications/jails/ -weight: 10 -related: false -tags: -- jails -- plugins ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -*Jails* are a lightweight, operating-system-level virtualization. -One or multiple services can run in a jail, isolating those services from the host TrueNAS system. -The main differences between a user-created jail and a plugin are that plugins are preconfigured and usually provide only a single service. - -{{< expand "Why use a Jail instead of a VM?" "v" >}} -By default, jails run the [FreeBSD](https://www.freebsd.org/) operating system. -These jails are independent instances of FreeBSD. -The jail uses the host hardware and runs on the host kernel, avoiding most of the overhead usually associated with virtualization. -The jail installs FreeBSD software management utilities so FreeBSD packages or ports can be installed from the jail command line. -This allows compiling FreeBSD ports and installing FreeBSD packages from the command line of the jail. -{{< /expand >}} - -It is important to understand that users, groups, installed software, and configurations within a jail are isolated from both the TrueNAS host operating system and any other jails running on that system. - -The ability to create multiple jails offers flexibility regarding software management. -For example, an administrator can choose to provide application separation by installing different applications in each jail, to create one jail for all installed applications, or to mix and match how software is installed into each jail. - -## Setting Jail Storage - -You must create a [data storage pool]({{< relref "/CORE/CORETutorials/Storage/Pools/_index.md" >}}) before using jails. -Make sure the pool has enough storage for all of the intended jails. -The **Jails** screen displays a message and the **CREATE POOL** button if a pool does not exist on the TrueNAS system. - -If pools exist, but one is not chosen to use with jails or plugins, a dialog displays prompting you to choose a pool. Select a pool and click **CHOOSE**. - -To select a different pool for jail and plugin storage, click the icon, then select a different pool from the dropdown list. - -TrueNAS uses [iocage](https://github.com/iocage/iocage) for jail and plugin management. -Jails and downloaded FreeBSD release files are stored in a dataset named **iocage**. - -{{< expand "About the iocage Dataset" "v" >}} -The [iocage](https://iocage.readthedocs.io/en/latest/index.html) dataset, automatically uses the first pool that is not a root pool for the TrueNAS system. -It should have at least 10 GiB of free space (recommended), and cannot be located on a share. - -A defaults.json file contains the default settings used when a new jail is created. -The file is created automatically when not already present. -When the file is present but corrupted, iocage shows a warning and uses default settings from memory. - -Each new jail installs into a new child dataset of the **iocage** dataset. -For example, with the **iocage/jails** dataset in *pool1*, a new jail called *jail1* installs into a new dataset named ***pool1*/iocage/jails/*jail1***. -Go to **Storage > Pools**, click on the **iocage** dataset to expand it, then click on **Jails** to see jail datasets added for a new a jail from the **Jails** wizard screen or for a plugin jail from the add plugin wizard screen. - -FreeBSD releases are fetched as a child dataset into the /iocage/download dataset. -This dataset is then extracted into the **/iocage/releases** dataset to use in jail creation. -Go to **Storage > Pools**, click on the **iocage** dataset to expand it, then click on **download** to see releases added from the **Jails** wizard screen. -You can then remove the dataset in /iocage/download without affecting the availability of fetched releases or an existing jail. - -The **iocage** datasets on activated pools are independent of each other and do not share any data. - -iocage jail configs are stored in /mnt/*poolname*/iocage/jails/*jailname*. -When iocage is updated, the config.json configuration file is backed up as /mnt/*poolname*/iocage/jails/*jailname*/config_backup.json. -You can rename the backup file to config.json to restore previous jail settings. -{{< /expand >}} - -See [Setting Up Jail Storage]({{< relref "SettingUpJailStorage.md" >}}) for more information on jail storage and mount points. - -## Creating Jails - -TrueNAS has two options to create a jail, the jail **Wizard** or **ADVANCED JAIL CREATION**. -The jail **Wizard** provides the simplest process to create and configure a new jail. The **ADVANCED JAIL CREATION** alternate method has every possible configurable jail option. -See [Jails Screen]({{< relref "JailsScreens.md" >}} for more information on jails screens and configuration settings. - -To add a new jail, go to **Jails** then click **ADD**. The **Wizard** opens. -To access the advanced configuration option, click **ADVANCED JAIL CREATION** at the bottom of the **Wizard** screen. We recommend only advanced users with very specific use applications use this method to create a jail. - -Enter a name for the jail. Names can contain letters, numbers, periods (.), dashes (-), and underscores (_). - -Select the jail type. **Default (Clone Jail)** or **Basejail**. -Clone jails are clones of the specified FreeBSD release. -They are linked to that release, even if they are upgraded. -Basejails mount the specified release directories as nullfs mounts over the jail directories. Basejails are not linked to the original release when upgraded. - -Specify the release to use. Options are **12.4-RELEASE** or **13.2-RELEASE**. -Jails can run FreeBSD versions up to the same version as the host TrueNAS system. Newer releases are not shown. -Versions of FreeBSD are downloaded the first time they are used in a jail. -Additional jails created with the same version of FreeBSD are created faster because the download is already completed. - -![JailsAddName](/images/CORE/Jails/JailsAddName.png "Jails Add Name") - -Click **Next** to display the **Configure Networking** wizard screen with a simplified list of networking options. - -![JailsAddNetworking](/images/CORE/Jails/JailsAddNetworking.png "Jails Add Networking") - -{{< expand "Jail Supported Networking Options" "v" >}} -Jails support several different networking solutions: - -* **VNET** adds a virtual network interface to the jail. - - This interface can select NAT, DHCP, or static jail network configurations. - Since VNET provides the jail with an independent networking stack, it can broadcast an IP address, which is required by some applications. - -* **NAT** ([Network Address Translation](https://tools.ietf.org/html/rfc2663)) uses the TrueNAS IP address and selects a unique port for the jail to use. - - VNET is required when NAT is selected. - -* **DHCP Autoconfigure IPv4** sets the jail receive its IP address from a DHCP server. - -Configure networking by entering values in either the **IPv4 Address** or **IPv6 Address** fields. -You can configure any combination of these fields. -Multiple interfaces are supported for IPv4 and IPv6 addresses. -To add more interfaces and addresses, click **ADD**. - -Setting **IPv4 Default Router** and **IPv6 Default Router** to **auto** automatically configures these values. -You must select **VNET** to enable the **IPv4 Default Router** field. -When manually configuring IP addresses and if no interface is selected, TrueNAS automatically assigns the given jail IP address to the current active interface of the host system. - -You can [configure a jail without network settings](#creating-a-jail-without-networking). - -Selecting a proxy in the TrueNAS network settings also configures new jails to use the proxy settings, except when performing DNS lookups. -Make sure a firewall is properly configured to maximize system security. - -{{< hint type=important >}} -When pairing the jail with a physical interface, edit the network interface and select **Disable Hardware Offloading**. -This prevents a network interface reset when the jail starts. -{{< /hint >}} -{{< /expand >}} - -{{< expand "Additional VMware Requirements" "v" >}} - -{{< include file="/static/includes/VirtualMachinesJailNetworking.md" >}} -{{< /expand >}} - -Click **NEXT** to view a summary of the chosen jail options. -Click **SUBMIT** to create the new jail. After a few moments, the new jail is added to the **Jails** screen list. - -### Advanced Jail Creation - -From the **Jails** screen click on **ADD** to open the **Wizard**, then click on **ADVANCED JAIL CREATION** at the bottom of the screen to open the **Advanced Jail Creation** form. - -![AdvancedJailCreationBasicProperties](/images/CORE/Jails/AdvancedJailCreationBasicProperties.png "Jails Add Advanced") - -Enter the jail name, type, and select the release just as in the **Name Jail and Choose FreeBSD Release Wizard** screen. - -Enter the networking settings leave all blank to create the jail without networking. - -Click on **Jail Properties** to enter the settings for a jail ruleset to follow, commands to run in the system or jail environment, add a jail user, set allow or deny SYSV IPC message, shared memory, or semaphore primitives. -You can also add VNET interfaces and other jail settings on this screen. - -Click on **Network Properties** to add interfaces, host names, domain names, and resolver addresses, disable IPv4 or IPv6 source address selection for the jail in favor of the primary IPv4 or IPv6 address of the jail (only available when the jail is not configured to use VNET). -You can also set the IPv4 or IPv6 IP address to inherit or restrict access to all system addresses or stop the jail from using either IPv4 or IPv6 entirely. -You can configure MAC address settings. - -Click **Custom Properties** to add the priority for the jail at boot time, jail host ID, set up the jail as a template. -You can add system host time to synchronize time between the jail and host, enabling ZFS jailing inside the jail, define a dataset to be jailed and to be fully handed over to a jail, enter a mount point for the **jail_zfs_dataset**, configure tun settings, and add other local host, IP host name, and IPV6 autoconfigure settings. - -Click **SAVE** to add the jail and return to the **Jails** screen. - -## Creating a Jail without Networking -You can create a usable jail without any networking by entering only the required **Jail Name**, selecting the **Jail Type**, and **Release**. -To create a jail without networking, leave all network checkboxes cleared and fields empty to initialize the jail without any networking abilities. - -To add networking to the jail after creation, go to **Jails**, click the for the jail, then click **Edit**. -Configure the network settings in the **Basic Properties** area when the jail needs to communicate over the local network or out to the internet. - -If you are an experienced user you can access additional advanced configuration settings in the **Network Properties**, and **Custom Properties** sections. - -For more information on the configuration screens, see [Jails Screens]({{< relref "/CORE/UIReference/JailsPluginsVMs/JailsScreens.md" >}}). - -### Creating a Template Jail - -A *template jail* is a jail using the basejails type and customized with other software that can efficiently create other jails with the same configuration. - -To create a template jail go to **Jails**, click **ADD** then click **ADVANCED JAIL CREATION** at the bottom of the **Wizard** screen, then: - -1. Create a jail to use as a template. - - a. Enter a name for the jail template, select **Basejail** as the **Jail Type**, and select the release from the **Release** dropdown. - - b. Configure the other jail setting you want to save in the template. - - c. Click **SAVE** to create the template and add this jail to the iocage/templates folder and list of available releases. - -2. Start this new jail, then click **Shell** to install the custom software packages. - See [Installing Jail Software]({{< relref "InstallingJailSoftware.md" >}}) for more information on customizing your jail template. - -3. Click **SAVE**. - -4. Click **Stop** to stop the jail. - -5. Click **Edit** to open the **Edit Advanced Jail Creation** screen and make the jail a template. - - a. Click on **Custom Properties** to show that section, then select **Template**. - - b. Click **Save**. - -The new template jail shows on the **Releases** dropdown list. - -6. Add a new jail from the template. - - a. Click **ADD** to open the **Wizard**. - - b. Enter a name, select **Default (Clone Jail)**, then select the name of the template from the **Releases** dropdown list. - - c. Click **NEXT** to enter networking settings. - - d. Click **NEXT** to review your settings and if satisfied with the settings, click **SUBMIT** to add the jail. - - You can select the **Advanced Jail Creation** option if you want to enter any other advanced settings not included in the template. - -You must use the **ADVANCED JAIL CREATION** screens to create the basejail you want to use as a template. -If you use the **Wizard** to create the basejail, then edit it to make it a template, any new jails created from this template do not start. - -
- -## Jails Articles -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/CORETutorials/JailsPluginsVMs/Plugins/CreatingCustomPlugin.md b/content/CORE/CORETutorials/JailsPluginsVMs/Plugins/CreatingCustomPlugin.md deleted file mode 100644 index ec617318fd..0000000000 --- a/content/CORE/CORETutorials/JailsPluginsVMs/Plugins/CreatingCustomPlugin.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -title: "Custom Plugins" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/plugins/creatingcustomplugin/" -description: "Describes how to configure plugins on TrueNAS CORE." -weight: 30 -Aliases: /core/applications/plugins/createplugin/ -tags: -- plugins ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -Plugins are a technology for easily and securely deploying 3rd party applications directly on TrueNAS storage systems. -The web interface allows users to deploy, start, stop, and update applications, along with configuration tasks such as assigning storage to them. -Plugins are popular for content, security, development, collaboration, and backup applications for home and business use. - -{{< expand "Plugin Technology" "v" >}} -[Jails](https://docs.freebsd.org/en/books/handbook/jails/) form the core of TrueNAS plugins. -Jails are the FreeBSD container technology and are: -* resource efficient -* secure -* flexible with networking infrastructure - -Additionally, TrueNAS integrates the [iocage](https://github.com/iocage/iocage) application for its jail container management framework. - -Each of the most popular TrueNAS plugins such as Plex Media Server, NextCloud, and SyncThing begin as FreeBSD ports: [multimedia/plexmediaserver/](https://www.freshports.org/multimedia/plexmediaserver/), [deskutils/nextcloudclient/](https://www.freshports.org/deskutils/nextcloudclient/), and [net/syncthing/](https://www.freshports.org/net/syncthing/) respectively. -These install to a FreeBSD system using the command `pkg` package manager. -For example, FreeBSD uses command `pkg install plexmediaserver` and then configures the application manually. -{{< /expand >}} - -This tutorial guides you through creating a custom plugin using the [SABnzbd](https://sabnzbd.org/) newsreader plugin as an example. -A plugin adds metadata that provides an installation source, reasonable defaults, and user interface elements such as an icon. -The components for the sabnzbd plugin are: - -* README.md: A popular convention for a file in markdown format for describing the project. -* sabnzbd.json: The JSON artifact file containing various plugin properties including an inventory of all other metadata components which might be in the same or a remote repository. -* overlay/: An optional directory containing the files to copy into the Jail. -* ui.json: A file containing the plugin management interface URL and port number. -* settings.json: An optional JSON file that contains variables used during plugin startup and for its configuration. -* sabnzbd.png: A .png image such as sabnzbd.png that displays in the TrueNAS plugins Index. It is used as the icon. -* post_install.sh: A shell script to run after jail creation to perform necessary configuration steps. It runs only once. - -## Requirements - -TrueNAS provides everything necessary for custom plugin development, but a FreeBSD system is also a good choice. The requirements are: - -* A TrueNAS or FreeBSD system running iocage (`iocage`). -* An internet connection and at least 1 GiB of available disk space. -* A publicly-accessible git repository (`git`), self-hosted or on a service like [GitHub](https://github.com/), [Gitea](https://gitea.io/en-us/) or [GitLab](https://about.gitlab.com/). You can run GitLab as its own plugin. -* A text editor such as vi, ee, or nano, all of which are available in TrueNAS. -* Basic knowledge of [FreeBSD](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/) and shell scripting. - -## Creating Each Component - -{{< hint type=important >}} -`//` and `#` comments are not supported in JSON. -Copy any examples from the files in the [Git repository](https://github.com/ix-plugin-hub) using raw mode. -{{< /hint >}} - -## Custom Plugin Files -{{< expand "Artifact File" "v" >}} -sabnzbd.json (artifact file) -``` -{ - "name": "sabnzbd", //The name of the Plugin and resulting Jail - "plugin_schema": "2", //The Plugin schema version - "release": "11.3-RELEASE", //FreeBSD version (not significantly newer than host) - "artifact": "https://github.com/ConorBeh/iocage-plugin-sabnzbd.git", //The Git repository containing the Plugin - "properties": { //Jail properties that can be overridden by the user - "nat": 1, - "nat_forwards": "tcp(8080:8080)" - }, - "pkgs": [ //FreeBSD packages to be installed, one per line - "sabnzbdplus", - ], - "packagesite": "https://pkg.FreeBSD.org/FreeBSD:11:amd64/latest", //The package site, latest, quarterly, or self-hosted - "fingerprints": { - "iocage-plugins": [ - { - "function": "sha256", - "fingerprint": "b0170035af3acc5f3f3ae1859dc717101b4e6c1d0a794ad554928ca0cbb2f438" //The checksum of the FreeBSD port - } - ] - }, - "revision": "0" //Internal version number -} -``` - -### Artifact File Properties - -These are commonly-used properties specified in the artifact file. -You can specify any supported [iocage property](https://www.freebsd.org/cgi/man.cgi?query=iocage&apropos=0&sektion=8&manpath=FreeBSD+11.3-RELEASE+and+Ports&arch=default&format=html). -Here are a few: - -* `nat`: Enables NAT to utilize the host IP address. -* `nat_forwards`: Required when NAT is enabled. Syntax: `< protocol >` ( `< jailport >:< hostport >` ) -* `dhcp`: Enables DHCP on the jail to allow it to automatically obtain an IP address. -* `allow_tun`: Allows the creation of a tun network device inside the jail, required for VPN connections. -* `allow_raw_sockets`: Allows the jail to create raw sockets. - -### Artifact Repository Options - -The official FreeBSD repository provides *latest* and *quarterly* branches. -The *latest* branch contains binary packages that are updated immediately, while the *quarterly* branch binaries are only updated every quarter, and are the default for FreeBSD releases. -The fingerprint remains the same for all official FreeBSD repositories. -If custom port build options are required, the preferred solution is to set up a custom [Poudriere](https://www.freebsd.org/doc/handbook/ports-poudriere.html) build server. -{{< /expand >}} -{{< expand "overlay/ File" "v" >}} - -The overlay/ is a directory of files copied into the jail after creation and before the execution of post_install.sh. -The layout of these files follows the same paths as in the root jail file system. -For example, a file placed in /overlay/usr/local/www/lighttpd/ inside the git repository goes into /usr/local/www/lighttpd in the jail. -This is very useful for providing pre-made configuration files, additional scripts, or even binaries that might not be available in the pkg repository. -{{< /expand >}} -{{< expand "ui.json File" "v" >}} - -This is a small JSON file containing the address of the WebUI and port. -Use the variable `%%IP%%` to automatically display the correct IP address. -Make sure to include any extra components in the URL following the domain name or IP address, for example /admin or /web/index. -{{< /expand >}} -{{< expand "settings.json File" "v" >}} - -A JSON file that is used when working with generated or user-specified data such as passwords or database names. -You can use these variables in post_install.sh. -In addition to these variables, you must also set the `servicerestart` command. -This command runs when a setting changes or the jail restarts, like a web server restart. -{{< /expand >}} -{{< expand "sabnzbd.png (Icon File)" "v" >}} - -A link to a .png file to display in the TrueNAS Plugins Index. -The image requires a transparent background and must be 128 pixel by 128 pixel square in size to produce quality results when resized. -{{< /expand >}} -{{< expand "post_install.sh File" "v" >}} - -A POSIX shell script that leverages all other files to automate plugin installation. -Simple plugins typically only have a few lines in this file, to enable and start a few services. -Note that iocage executes the file contents simultaneously, not line by line. -Remember to make the file executable before uploading it to the Git repository. - -To make the post_install.sh executable, enter command `chmod +x post_install.sh`. - -Common post-installation steps include: - -* Setting file and directory permissions -* Moving, copying, and editing configuration files -* Generating random passwords -* Adding a user and/or group -* Creating a database -{{< /expand >}} -{{< expand "/root/PLUGIN_INFO File" "v" >}} - -A text file with easily accessible information that clicking **Post Install Notes** can recall again from the web interface. -Inter information into this file using command `echo {information/notes} >> /root/PLUGIN_INFO` in post_install.sh, where *{information/notes}* is the relevant information about the plugin. -{{< /expand >}} - -## Git Repository Initialization - -Create and initialize a git repository and README for the plugin. -Use this naming schema `iocage-plugin-{PLUGIN_NAME}`, where *{PLUGIN_NAME}* is the name of the plugin. -For example, iocage-plugin-sabnzbd is the name of the Github repository in this example. - -Put all the necessary files and directories in the newly created artifact repository. -The necessary files are listed above. -Next, open a pull request to the [plugin hub index](https://github.com/ix-plugin-hub/iocage-plugin-index) that adds the artifact file, icon, and entry into the [INDEX](https://github.com/ix-plugin-hub/iocage-plugin-index/blob/master/INDEX) file. -Remember to put a link to your newly created artifact repository in the comments of the pull request. -This way a moderator can fork your repository and can make available in the community list of plugins. - -For guides on how to use Github, see [Github Guides](https://guides.github.com/). diff --git a/content/CORE/CORETutorials/JailsPluginsVMs/Plugins/MinIOPlugin.md b/content/CORE/CORETutorials/JailsPluginsVMs/Plugins/MinIOPlugin.md deleted file mode 100644 index 53a8e5a39b..0000000000 --- a/content/CORE/CORETutorials/JailsPluginsVMs/Plugins/MinIOPlugin.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "MinIO Plugin (Deprecated)" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/plugins/minioplugin/" -description: "Describes how to configure the MinIO plugin on TrueNAS CORE and gives migration instructions from the deprecated S3 built-in service. Deprecated content." -weight: 20 -tags: -- plugins -- s3 ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -{{< include file="/static/includes/S3Deprecation.md" >}} diff --git a/content/CORE/CORETutorials/JailsPluginsVMs/Plugins/PlexPlugin.md b/content/CORE/CORETutorials/JailsPluginsVMs/Plugins/PlexPlugin.md deleted file mode 100644 index 195ee0ed0f..0000000000 --- a/content/CORE/CORETutorials/JailsPluginsVMs/Plugins/PlexPlugin.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Plex Plugin" -redirect: "https://www.truenas.com/docs/core/13.3/coretutorials/jailspluginsvms/plugins/plexplugin/" -description: "Describes how to install the Plex application as a plugin on TrueNAS CORE." -weight: 20 -tags: -- apps -- plugins ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -This tutorial provides instructions on adding the community-favorite [Plex](https://www.plex.tv/) application as a plugin. -You need an account with Plex to complete these instructions. - -{{< include file="/static/includes/COREPlexPlugin.md" >}} \ No newline at end of file diff --git a/content/CORE/CORETutorials/JailsPluginsVMs/Plugins/_index.md b/content/CORE/CORETutorials/JailsPluginsVMs/Plugins/_index.md deleted file mode 100644 index 7edaed789c..0000000000 --- a/content/CORE/CORETutorials/JailsPluginsVMs/Plugins/_index.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: "Plugins" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/plugins/managingplugins/" -description: "How to install plugins in TrueNAS CORE, and more articles." -geekdocCollapseSection: true -weight: 20 -aliases: - - /core/applications/plugins/manageplugins/ - - /core/coretutorials/jailspluginsvms/plugins/managingplugins/ -tags: -- plugins ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -Plugins allow extending the built-in NAS services by installing additional software. -A *plugin* is a pre-packaged application that is installed into a [FreeBSD jail](https://docs.freebsd.org/en/books/handbook/jails/). -The plugin jail is limited to installing and using only the plugin software. - -{{< expand "Before getting started..." "v" >}} -1. Create a [data pool]({{< relref "/CORE/CORETutorials/Storage/Pools/_index.md" >}}) if one does not exist. - A pool must be available for plugin storage. -2. Verify the system is connected to the internet. -3. Go to **Network > Interfaces**, edit the intended plugin interface, and set **Disable Hardware Offloading**. -{{< /expand >}} - -## Installing a Plugin - -To see the plugin catalog, go to the **Plugins** screen. -{{< expand "First time in this menu?" "v" >}} -{{< include file="/static/includes/JailsPluginsFirstTime.md" markdown="true" >}} -{{< /expand >}} - -{{< trueimage src="/images/CORE/Plugins/PluginsList.png" alt="Plugins Catalog" id="Plugins Catalog" >}} -{{< expand "I don't see anything?" "v" >}} -If the catalog does not load: -1. Go to **Network > Global Configuration** and confirm the addresses entered in **Default Gateway** and **DNS Servers** are correct. -2. Connect to a shell session and enter `ping` followed by an Internet address. The output confirms the system is connected to the Internet. -{{< /expand >}} - -Plugins are organized into two collections: - -* [**iXsystems**](https://www.ixsystems.com/) maintained plugins. -* **Community** for open source plugins created and maintained by the TrueNAS community. - -By default, the **Plugins** screen shows the iXsystems-supported plugins. -To view the community-supported plugins, click on **Browse a Collection** and select **Community**. - -### Installation Options - -To install a plugin, click on the plugin icon, then **Install**. -This example shows installing [Tarsnap](https://www.tarsnap.com/), a popular backup solution. - -{{< trueimage src="/images/CORE/Plugins/PluginsTarsnapInstall.png" alt="Installing the Tarsnap Plugin" id="Installing the Tarsnap Plugin" >}} - -Enter a name for the plugin in **Jail Name** and adjust the networking settings as needed. - -Most plugins default to using [Network Address Translation (NAT)](https://datatracker.ietf.org/wg/nat/about/) for their Internet connection. -Select **DHCP** to use a dynamically-generated address. -Clear the **DHCP** checkbox to enter static IP addresses for the plugin jail or to select **NAT**. -Using **NAT** is recommended as it does not require manual configuration of multiple available IP addresses and prevents addressing conflicts on the network. - -Some plugins default to DHCP as their management utility conflicts with NAT. -Keep these plugins set to DHCP unless a manually configured IP address is preferred. - -Plugins can take several minutes to download and install. -A dialog confirms when the installation completes and shows any post-install notes. -You can view the post-install notes later by expanding the entry for the installed plugin in **Plugins** and clicking **Post Install Notes**. - -{{< expand "Troubleshooting" "v" >}} -If a plugin download or update fails with an unable to fetch an artifact or download a package error, you might need to investigate your networking environment. -Some home routers can have a security feature that prevent DHCP enabled plugins (or bridged devices with virtual MAC addresses) from resolving addresses. - -Also, sometimes additional DNS validation is required that is not supported by the router or the router has a caching resolver that is holding on to a stale record. -A couple of possible solutions are to hard reset your router to clear any stale records or try using an alternate DNS server for the plugin. -{{< /expand >}} - -### S3 Secret Keys - -If the plugin requires an S3 secret key, and you use a random password generation program, check the character string produced for disallowed characters. -The AWS secret key allows using upper and lowercase alphanumeric characters (a-z, A-Z, digits 0-9), and the exclamation point (!), hypen (-), underscore (_), period (.), asterisk (*), single quote ('), open parenthesis ((), and closed parenthesis ()) special characters. -If the random password includes other special characters it can result in failed authentication. - -## Post-Installation Configuration - -After a plugin is installed, the **Plugins** screen shows the added entry. - -{{< trueimage src="/images/CORE/Plugins/PluginsListWithInstalled.png" alt="Plugins List With Installed" id="Plugins List With Installed" >}} - -Click to manage the plugin state, update the plugin application, configure the plugin jail mount points to storage datasets, and, when supported, open a link to the management portal for the plugin application. - -Plugin jails are preconfigured and require very little tuning. -However, jail properties are available in the event a setting needs to change. -To update or reconfigure the plugin jail, go to the **Jails** screen and expand the entry for one of the plugin jails. -Click   and stop the jail before changing it. - -{{< trueimage src="/images/CORE/Plugins/PluginsInstalledOptions.png" alt="Installed Plugin Options" id="Installed Plugin Options" >}} - -## Removing a Plugin - -{{< hint type=warning >}} -Uninstalling a plugin destroys all datasets or snapshots that are associated with the plugin! - -Back up any important data stored in the plugin jail before deleting it! -{{< /hint >}} - -### Backing up Jail Data - -To find data stored in a jail, go to **Storage > Pools** and expand the entry for the pool that stores plugin and jail data. -Expand the **iocage** and **jails** datasets to find the plugin jail storage dataset. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsJailsDatasetLocation.png" alt="Storage Pools Jails Dataset Location" id="Storage Pools Jails Dataset Location" >}} - -One option to back up stored data is to create a [local replication]({{< relref "LocalReplication.md" >}}). -You can configure the replication task to run periodically and automatically back up new changes to the jail dataset. - -To convert a jail snapshot into a new storage dataset, go to **Storage > Snapshots** and find a snapshot of the jail dataset. - -{{< trueimage src="/images/CORE/Storage/StorageSnapshotsJailsLocation.png" alt="Storage Snapshots Jails Location" id="Storage Snapshots Jails Location" >}} - -Expand the snapshot entry, click , and define the path and name of the new dataset to create from the snapshot. -Then go to **Storage > Pools**, open the for the new dataset, and click **Promote Dataset**. - -### Uninstalling a Plugin - -To remove a plugin, go to **Plugins**, expand the installed plugin entry, and click . -Confirm the plugin removal by typing in the name of the plugin jail and selecting **Confirm**. - -{{< trueimage src="/images/CORE/Plugins/PluginsUninstall.png" alt="Plugins Uninstall" id="Plugins Uninstall" >}} - -Uninstalling can take a few moments while the plugin is deleted from both **Plugins** and **Jails**. -The plugin dataset also deletes from ***POOL*/iocage/jails/** and any jail snapshots from **Storage > Snapshots**. - -
- -## Contents - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/CORETutorials/JailsPluginsVMs/UpdateJailsPlugins.md b/content/CORE/CORETutorials/JailsPluginsVMs/UpdateJailsPlugins.md deleted file mode 100644 index c26e55bd64..0000000000 --- a/content/CORE/CORETutorials/JailsPluginsVMs/UpdateJailsPlugins.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "Updating Jails and Plugins" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/updatejailsplugins/" -description: "Describes how to update jails and plugins in TrueNAS CORE." -weight: 25 -tags: -- jails -- plugins ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -The **Jails** screen displays a list of jails installed on your system. - -![Jails](/images/CORE/Jails/Jails.png "Jails List") - -Plugins are created as a jail with specific software installed in that jail. -The update process for a jail and plugin is identical, while plugins have an additional step to update software installed inside the jail. - -## Jail Operating System Updates and Upgrades - -FreeBSD Jails are installed with a specific FreeBSD release, such as 12.3, 13.1, or 14.0. -These major releases can have numerous **patches** to address issues with the release before the next release is available. -**Updating** a jail applies the latest patch level to the installed FreeBSD release. -**Upgrading** a jail adjusts the Jail to use a newer FreeBSD release. - -Both updates and upgrades require the jail can connect to the **update.FreeBSD.org** mirrors. - -### Update a Jail - -To update a jail to the most current patch level of the installed FreeBSD release, go to **Jails** and find the installed jail. Click **>** to expand the jail and then click **Update**. -This does **not** change the installed FreeBSD release. -For example, a jail installed with **FreeBSD 11.2-RELEASE** can update to **p15** or the latest patch of 11.2, but not an 11.3-RELEASE-p# version of FreeBSD. - -### Upgrade a Jail - -Using **Upgrade** replaces the jail FreeBSD operating system with a new release of FreeBSD, such as taking a jail from FreeBSD 11.2-RELEASE to 11.3-RELEASE. -To upgrade a jail, stop it, open the shell and enter command iocage upgrade name -r release, where *name* is the plugin jail name and *release* is the desired FreeBSD release. -You might be prompted to approve additional FreeBSD component installation. - -The jail upgrade process can take a long time to download the FreeBSD release and apply it to a jail. -When the chosen FreeBSD release is already stored in the **iocage** dataset, the jail upgrade process is much faster. - -![UpgradeJail](/images/CORE/Jails/JailsUpgrade.png "Jail Upgrade Example") - -Jail status messages and command output are stored in /var/log/iocage.log. - -### Removing Unused FreeBSD Releases - -As a space saving measure, you can manually remove unused releases from the `/iocage/releases/` dataset after upgrading a jail. -The release must not be in use by any jail on the system. - -## Update Installed Plugin Software - -Updating software installed in a jail requires the jail communicate with the online **iocage** plugins repository servers. -The process involves opening a shell from within the running jail and using FreeBSD `pkg` commands to view and update the installed software. - -To update the installed software stored within a Plugin jail, go to **Jails** and expand the installed plugin jail. -Click **> SHELL** to open a command prompt from within the jail. - -Enter `pkg info` to see a list of all installed software. -This example shows the installed software from within the jail created when the **Minio** plugin was installed: - -![MinioJailpkg](/images/CORE/Jails/MinioJailpkg.png "Minio Jail Software") - -To update the installed software, enter pkg install name and replace *name* with the name returned from running `pkg info`. -The command checks if an update is available and prompts to proceed when the software can be updated. -This example shows attempting to update the minio software but no update was available. - -![MinioJailUpdateNone](/images/CORE/Jails/MinioJailUpdateNone.png "Minio Jail: no update available") diff --git a/content/CORE/CORETutorials/JailsPluginsVMs/VirtualMachines/SettingUpNPIV.md b/content/CORE/CORETutorials/JailsPluginsVMs/VirtualMachines/SettingUpNPIV.md deleted file mode 100644 index 758c70fec2..0000000000 --- a/content/CORE/CORETutorials/JailsPluginsVMs/VirtualMachines/SettingUpNPIV.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "Setting Up NPIV" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/virtualmachines/settingupnpiv/" -description: "Describes how to configure NPIV on TrueNAS CORE." -weight: 20 -tags: -- vm -- iscsi ---- - -## NPIV (N_Port ID Virtualization) - -NPIV allows the administrator to use switch zoning to configure each virtual port as if it was a physical port in order to provide access control. -This is important in an environment with a mix of Windows systems and virtual machines in order to prevent automatic or accidental reformatting of targets containing unrecognized file systems. -It can also be used to segregate data; for example, to prevent the engineering department from accessing data from the human resources department. -Refer to the switch documentation for details on how to configure zoning of virtual ports. - -## Creating NP Virtual Ports - -To create virtual ports on the TrueNAS system, go to **System > Tunables** and click **ADD**. -Enter these options: - -* **Variable** : `input hint.isp.X.vports`, replacing *X* with the number of the physical interface. -* **Value** : input the number of virtual ports to create. There cannot be more than 125 SCSI target ports, including all physical Fibre Channel ports, all virtual ports, and all configured combinations of iSCSI portals and targets. -* **Type** : make sure **loader** is selected. - -![SystemTunablesFibre](/images/CORE/System/SystemTunablesFibre.png "Virtual Ports for Fibre Channel") - -In the example shown: - -* Two physical interfaces are each assigned *4* virtual ports. - -* Two tunables are required, one for each physical interface. - -After the tunables are created, the configured number of virtual ports appears in **Sharing > Block Shares (iSCSI) > Fibre Channel Ports** screen so they can be associated with targets. -They are also advertised to the switch so zoning can be configured on the switch. - -After associating a virtual port with a target, add it to the **Target** tab of [Reporting]({{< relref "/CORE/UIReference/ReportingGraphs.md" >}}) so you can view its bandwidth usage. diff --git a/content/CORE/CORETutorials/JailsPluginsVMs/VirtualMachines/_index.md b/content/CORE/CORETutorials/JailsPluginsVMs/VirtualMachines/_index.md deleted file mode 100644 index e3ffccdb0d..0000000000 --- a/content/CORE/CORETutorials/JailsPluginsVMs/VirtualMachines/_index.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: "Virtual Machines" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/virtualmachines/creatingbasicvm/" -description: "Provides instructions on creating and managing a basic virtual machine, and lists other tutorials about virtual machines in TrueNAS CORE." -geekdocCollapseSection: true -weight: 30 -related: false -aliases: - - /core/applications/virtualmachines/basic/ - - /core/coretutorials/jailspluginsvms/virtualmachines/creatingbasicvm/ -tags: -- vm -- plugins ---- - -## Basic Virtual Machine Management - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -A *virtual machine* (VM) is an environment on a host computer that can be used as if it were a separate physical computer. -VMs can be used to run multiple operating systems simultaneously on a single computer. -Operating systems running inside a VM see emulated virtual hardware rather than the actual hardware of the host computer. -This provides more isolation than jails, but a VM consumes more system resources. - -{{< expand "What system resources do VMs require?" "v" >}} -A VM requires a portion of system RAM and a new zvol assigned to it. -While a VM is running, these resources are not available to the host computer or other VMs. - -TrueNAS VMs use the [bhyve](https://bhyve.org/) virtual machine software. -This type of virtualization requires an Intel processor with Extended Page Tables (EPT) or an AMD processor with Rapid Virtualization Indexing (RVI) or Nested Page Tables (NPT). -VMs cannot be created unless the host system supports these features. - -To verify that an Intel processor has the required features, open an SSH session or local console shell and run `grep VT-x /var/run/dmesg.boot`. -If the EPT and UG features are shown, this processor can use the bhyve VM software. - -To verify that an AMD processor has the required features, open and SSH session or local console shell and run `grep POPCNT /var/run/dmesg.boot`. -If the output shows the POPCNT feature, this processor can use the bhyve VM software. -Note that AMD K10 Kuma processors include POPCNT but do not support NRIS, which is required for use with bhyve. -Production of these processors ceased in 2012-2013. -{{< /expand >}} - -## Creating a Virtual Machine - -Before creating the virtual machine, you need an installer .iso or image file for the operating system you intend to install and a [storage pool]({{< relref "/CORE/CORETutorials/Storage/Pools/_index.md" >}}) available for both the virtual disk and operating system install file. - -To create a new VM, go to **Virtual Machines** and click **Add**. -Configure each category of the VM according to your specifications, starting with the **Operating System**. - -![VMAddOperatingSystem](/images/CORE/VirtualMachines/VirtualMachinesAddOperatingSystem.png "VM Add: OS") - -For information on the wizard screens and settings, see [Virtual Machine Screens]({{< relref "/CORE/UIReference/JailsPluginsVMs/VirtualMachines.md" >}}). - -Additional notes: - -* Using the **Grub** boot method as the guest operating system is not supported by Windows. -* Compare the recommended specifications for your guest operating system with the available host system resources when allocating values in **Virtual CPUs**, **Cores**, **Threads**, and **Memory Size**. -* Avoid allocating too much memory to a VM. - Activating a VM that has all available memory allocated to it can slow the host system or prevent other VMs from starting. - -**AHCI** is the recommended disk type for Windows VMs. - -**VirtIO** as network interface requires that the chosen guest operating system support VirtIO paravirtualized network drivers. -{{< expand "VirtIO compatibility with Windows 10 21H1" "v" >}} -VirtIO drivers are unstable with Windows 10 21H1 during the installation process and can result in VM install failure. -Avoid using VirtIO drivers with Windows 10 21H2 Virtual Machines. -{{< /expand >}} - -### Adding and Removing Devices - -After creating the VM, you can add and remove virtual devices by expanding the VM entry in **Virtual Machines** and clicking the **Devices** option. - -![VMDevices](/images/CORE/VirtualMachines/VirtualMachinesDevices.png "VM Devices") - -Device notes: - -* The virtual machine attempts to boot from devices according to the the **Device Order** setting, starting with **1000**, then ascending. -* The **CD-ROM** device option allows booting a VM from a CD-ROM image like an installation CD. - The CD image must be available in the system storage. - -## Managing a Virtual Machine - -After creating a VM and configuring any devices for it, manage the VM by expanding its entry in **Virtual Machines**. - -![VMOptions](/images/CORE/VirtualMachines/VirtualMachinesOptions.png "VM Options") - -Options for or connections are available after activating the VM. -If the **VNC** connection screen appears garbled, try adjusting the VNC device resolution. - -Using the **State** toggle or clicking follows a standard shutdown procedure to cleanly shut down the running VM. -Clicking immediately halts and deactivates the VM, similar to unplugging a computer. - -{{< hint type=note >}} -If the VM does not have a guest OS installed, the VM **State** toggle and button might not function as expected. -These buttons try to send an ACPI power-down command to the VM operating system, but since an OS is not installed, the commands time out. -Use the **POWER OFF** button instead. -{{< /hint >}} - -
- -## Virtual Machine Articles - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/CORETutorials/JailsPluginsVMs/_index.md b/content/CORE/CORETutorials/JailsPluginsVMs/_index.md deleted file mode 100644 index 358211982c..0000000000 --- a/content/CORE/CORETutorials/JailsPluginsVMs/_index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Jails, Plugins, and VMs" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/jailspluginsvms/" -description: "Tutorials about configuring TrueNAS CORE jails, specialized jails called plugins, and virtual machines for full operating system deployments." -geekdocCollapseSection: true -weight: 130 -related: false ---- - -TrueNAS CORE has a number of different features for deploying or using supplemental software on top of the CORE operating system. -The articles contained here describe and guide through deploying and using these features. - -
- -## Contents - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/CORETutorials/ManagingTLSCiphers.md b/content/CORE/CORETutorials/ManagingTLSCiphers.md deleted file mode 100644 index 1d1313df7b..0000000000 --- a/content/CORE/CORETutorials/ManagingTLSCiphers.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "Managing TLS Ciphers" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/managingtlsciphers/" -description: "Describes how to manage TLS ciphers on TrueNAS CORE." -weight: 30 -aliases: - - /core/system/general/uitlsciphers -tags: -- network ---- - -TrueNAS accepts different Transport Layer Security (TLS) cipher suites for secure web interface connections. -Only use [TLS 1.2](https://tools.ietf.org/html/rfc5246) or newer for best security. -By default, all options are available if you need to adjust this setting to match your particular network environment or security concerns. - -## Allow or Restrict TLS Ciphers - -Go to **System > General** and click on **HTTPS Protocols** to open a drop-down menu with the various cipher suites. - -Unsetting a cipher restricts its use in TrueNAS. -After enabling or disabling a cipher, you must reboot the TrueNAS system. - -![SystemGeneralHTTPSProtocols](/images/CORE/System/SystemGeneralHTTPSProtocols.png "HTTPS Protocols") - -### TLSv1 -[TLSv1](https://tools.ietf.org/html/rfc2246) provides Internet communication security using encryption and other secure messaging techniques. -While not officially deprecated, TLSv1 was considered obsolete in 2008. -For security, we discourage enabling TLSv1 unless your network environment requires it. - -### TLSv1.1 -[TLSv1.1](https://tools.ietf.org/html/rfc4346) is a revision of v1.0 with additional protections against CBC attacks. -While not officially deprecated, TLSv1.1 was considered obsolete in 2008. -For security reasons, users are encouraged to avoid enabling this suite unless required by the network environment. - -### TLSv1.2 -[TLSv1.2](https://tools.ietf.org/html/rfc5246) increases the protocol's ability to handle cryptographic algorithms. -TLSv1.2 represented a major step forward in security effectiveness and resulted in the "soft" deprecation of TLS versions 1.0 and 1.1. - -### TLSv1.3 -[TLSv1.3](https://www.rfc-editor.org/rfc/rfc8446.html) represents another major improvement to the protocol. -TLSv1.3 removes legacy or insecure encryption algorithms, adds encryption for handshake messages, and separates authentication and key exchange concepts. diff --git a/content/CORE/CORETutorials/Network/IPMI.md b/content/CORE/CORETutorials/Network/IPMI.md deleted file mode 100644 index 6ca64faa12..0000000000 --- a/content/CORE/CORETutorials/Network/IPMI.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "IPMI" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/network/ipmi/" -description: "Provides instructions on setting up Intelligent Platform Management Interface (IPMI) on TrueNAS CORE." -weight: 50 -aliases: /core/network/ipmi/ -tags: -- ipmi -- network ---- - -{{< hint type=note >}} -IPMI requires compatible hardware! Refer to your hardware documentation. Hardware compatibility determines if the IPMI option displays in the TrueNAS web interface. -{{< /hint >}} - -Many [TrueNAS Storage Arrays]({{< relref "/Hardware/_index.md" >}}) provide a built-in out-of-band management port. If the system becomes unavailable through the web interface, you can use this port to provide side-band management. Use IPMI to perform several vital functions. These include checking the log, accessing the BIOS setup, and powering on the system. IPMI does not need physical access to the system. You can use it to allow another person remote access to the system. This is useful when investigating a configuration or troubleshooting issue. - -{{< hint type=note >}} -Some IPMI implementations need updates to work with newer versions of Java. -See [PSA: Java 8 Update 131 breaks ASRock’s IPMI Virtual console](https://forums.freenas.org/index.php?threads/psa-java-8-update-131-breaks-asrocks-ipmi-virtual-console.53911/) for more information. -{{< /hint >}} - -Configure **IPMI** by going to **Network > IPMI**. The IPMI configuration screen provides a shortcut to the most basic IPMI configuration. - -![NetworkIPMIScreen](/images/CORE/Network/NetworkIPMIScreen.png "Network IPMI Screen") - -## IPMI Configuration - -Use the **Network > IPMI** screen to configure IPMI settings. See [IPMI Screen]({{< relref "/CORE/UIReference/Network/IPMIScreen.md" >}}) for more information on IPMI settings. - -Click **SAVE** to save the IPMI settings. - -## Connecting to the IPMI - -Save the configuration. Access the IPMI interface using a web browser and the IP address specified in **Network > IPMI**. The management interface prompts for login credentials. Refer to your IPMI device documentation to learn the default administrator account credentials. - -Log in to the management interface. Here you can change the default administrative user name and create extra IPMI users. The appearance of the IPMI utility and the functions that are available vary by hardware. diff --git a/content/CORE/CORETutorials/Network/Interfaces/BridgeCreate.md b/content/CORE/CORETutorials/Network/Interfaces/BridgeCreate.md deleted file mode 100644 index 26add592ef..0000000000 --- a/content/CORE/CORETutorials/Network/Interfaces/BridgeCreate.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Setting Up a Network Bridge" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/network/interfaces/bridgecreate/" -description: "Provides instructions on setting up a network bridge interface on TrueNAS CORE." -weight: 10 -tags: -- network -- interfaces ---- - -A [bridge](https://tools.ietf.org/html/rfc6325) generally refers to various methods of combining (aggregating) many network connections. These form a single total network. TrueNAS uses [bridge(4)](https://www.freebsd.org/cgi/man.cgi?bridge(4)) to manage bridges. - -To set up a bridge interface, go to **Network > Interface > Add**. - -![NetworkInterfaceAddBridgeScreen](/images/CORE/Network/NetworkInterfaceAddBridgeScreen.png "Network Interface Add Bridge Screen") - -Select **Bridge** as the **Type** and enter a name for the interface. The name must use the format **bridge**X*, where *X* is a number representing a non-parent interface. -It is also recommended to add any notes or reminders. Enter details about this particular bridge in **Description**. - -The next section is **Bridge Settings**. Use the dropdown list next to **Bridge Members** to select the correct interfaces. Configure the remaining interface options to match your networking needs. - -See [Interfaces Screen]({{< relref "/CORE/UIReference/Network/InterfacesScreen.md" >}}) for more information on settings. - -{{< include file="/static/includes/InterfaceOptions.md" markdown="true" >}} diff --git a/content/CORE/CORETutorials/Network/Interfaces/LAGGCreate.md b/content/CORE/CORETutorials/Network/Interfaces/LAGGCreate.md deleted file mode 100644 index 6f5e19e25c..0000000000 --- a/content/CORE/CORETutorials/Network/Interfaces/LAGGCreate.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "Setting Up Link Aggregations" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/network/interfaces/laggcreate/" -description: "Provides instructions on setting up a network link aggregation (LAGG) interface on TrueNAS CORE." -weight: 20 -tags: -- network -- interfaces ---- - -A [Link Aggregation (LAGG)](https://tools.ietf.org/html/rfc7424) is a general method of combining (aggregating) many network connections. The connections are either parallel or in series. This provides extra bandwidth or redundancy for critical networking situations. TrueNAS uses [lagg(4)](https://www.freebsd.org/cgi/man.cgi?lagg(4)) to manage LAGGs. - -To set up a LAGG interface, go to **Network > Interface > Add**. - -![NetworkInterfacesAddLAGG](/images/CORE/Network/NetworkInterfacesAddLAGG.png "Adding a lagg interface") - -Set the **Type** to **Link Aggregation**. - -Enter a name for the interface. The name must use the format *laggX*, where *X* is a number representing a non-parent interface. -Enter any notes or reminders about this particular LAGG in the **Description** field. - -Go to **LAGG Settings** and then **Lagg Protocol** to configure the interface ports to match your networking needs: - -## Lagg Protocols - -### LACP -The most commonly used LAGG protocol. -It is one part of [IEEE specification802.3ad](https://www.ieee802.org/3/hssg/public/apr07/frazier_01_0407.pdf). LACP mode performs negotiation with the network switch to form a group of ports. -These are all active at the same time. -The network switch must support LACP for this option to function. - -### Failover -Failover sends traffic through the primary interface of the group. -Traffic diverts to the next available interface in the LAGG if the primary is not accessible. - -### Load Balance -Load Balance accepts inbound traffic on any port of the LAGG group. -It then balances the outgoing traffic on the active ports in the LAGG group. -It is a static setup that does not watch the link state nor does it negotiate with the switch. - -### Round Robin -Round robin accepts inbound traffic on any port of the LAGG group. -It sends outbound traffic using a round robin scheduling algorithm. -The outbound traffic sends in sequence, using each LAGG interface in turn. - -### None -This mode disables traffic on the LAGG interface without disabling the LAGG interface. - -## Lagg Interfaces - -Now define the **Lagg Interfaces** and review the remaining interface options. - -See [Interfaces Screen]({{< relref "/CORE/UIReference/Network/InterfacesScreen.md" >}}) for more information on settings. - -{{< include file="/static/includes/InterfaceOptions.md" markdown="true" >}} diff --git a/content/CORE/CORETutorials/Network/Interfaces/SettingStaticIP.md b/content/CORE/CORETutorials/Network/Interfaces/SettingStaticIP.md deleted file mode 100644 index 45ecbe2193..0000000000 --- a/content/CORE/CORETutorials/Network/Interfaces/SettingStaticIP.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: "Setting a Static IP Address for the TrueNAS UI" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/network/interfaces/settingstaticip/" -description: "Provides instructions on configuring a network interface for static routes on TrueNAS CORE." -weight: 40 -aliases: /core/network/interfaces/settingstaticip/ -tags: -- network -- interfaces ---- - -{{< hint type=warning >}} -**Disruptive Change** - -It is possible to make changes to the network interface that the web interface uses. But this can result in losing connection to the TrueNAS system! -Very often fixing misconfigured network settings requires command line knowledge. Physical access to the system is often required as well. -{{< /hint >}} - -{{< include file="/static/includes/MultipleInterfacesOnNetwork.md" >}} - -{{< expand "Process Summary" "v" >}} -Configuring a static IP address involves both the TrueNAS web UI and the Console Setup menu. - -* Web UI - * **Network > Interfaces** > **Add** or **Edit** - * Type address into **IP Address** and select a subnet mask. - * **Add** or **Delete** additional addresses as needed. - * Test saved changes before permanently applying them. - * Dialog asks to temporarily apply changes. - * After you apply the network settings changes, they don't immediately become permanent. You can choose the amount of time the new settings will work as temporary settings. After this designated amount of time, the new network settings become permanent if you save them. Saving the new network changes overwrites the previous configuration. - * **Network > Network Summary** summarizes addressing information of every configured interface. -* Console menu - * Physical Interfaces: select **Configure Network Interfaces** (options are similar for other interface types) - * Delete interface? enter or select `n` - * Remove interface settings? enter or select `n` - * Configure IPv4? enter or select `y` - * Enter IP address and subnet mask - * Configure IPv6 enter or select `y` - * Enter IP address - * Configure failover? enter or select `n` - * Saving changes interrupts the web interface and could require a system reboot. -{{< /expand >}} - -## Setting Static IP Addresses - -TrueNAS can configure physical network interfaces with static IP addresses. Use either the web interface or the system console menu. - -{{< hint type=tip >}} -The recommendation is to use the web interface for this process. There are extra safety features to prevent saving misconfigured interface settings. -{{< /hint >}} - -### Adding Static IP Addresses Using the Web Interface - -Log in to the web interface and go to **Network > Interfaces**. -This contains creation and configuration options for physical and virtual network interfaces. - -{{< trueimage src="/images/CORE/Network/NetworkInterfaces.png" alt="Interfaces List" id="Interfaces List" >}} - -You can configure static IP addresses while creating or editing an interface. - -{{< hint type=tip >}} -To edit an active interface on TrueNAS Enterprise systems, you must first disable [High Availability]({{< relref "CORE/UIReference/System/Failover.md" >}}). -{{< /hint >}} - -{{< trueimage src="/images/CORE/Network/NetworkInterfacesEdit.png" alt="Editing an Interface" id="Editing an Interface" >}} - -Type the desired address in the **IP Address** field and select a subnet mask. - -{{< hint type=important >}} -Multiple interfaces cannot be members of the same subnet. - -If an error displays when setting the IP addresses on multiple interfaces, check the subnet. -{{< /hint >}} - -Use the buttons to **Add** and **Delete** more IP addresses as needed. - -To avoid saving invalid or unusable settings, network changes are at first temporary. -Applying any interface changes adds a dialog to the **Network > Interfaces** list. - -{{< trueimage src="/images/CORE/Network/NetworkInterfacesChangesPresent.png" alt="Interface Changes Detected" id="Interface Changes Detected" >}} - -You can adjust how long to test the network changes before they revert back to the previous settings. -If the test is successful, another dialog allows making the network changes permanent. - -To view system networking settings, go to **Network > Network Summary**. - -{{< trueimage src="/images/CORE/Network/NetworkSummary.png" alt="Network Summary" id="Network Summary" >}} - -### Using the System Console Menu to Assign Static IP Addresses to a Physical Interface - -You need to have a monitor and keyboard attached to the system to use the console. If the system hardware allows it, you can connect with [IPMI]({{< relref "CORE/CORETutorials/Network/IPMI.md" >}}). -The console menu displays after the system completes booting. - -{{< trueimage src="/images/CORE/ConsoleSetupMenu.png" alt="TrueNAS Console Setup Menu" id="TrueNAS Console Setup Menu" >}} - -To add static IP addresses to a physical interface, go to **Configure Network Interfaces**. -Other interface types have a similar process to add static IP addresses. -Interfaces that are already configured for DHCP have that option disabled. -There are many prompts to answer before you can add a static address. -This example shows adding static IPv4 addresses to interface *igb0*: -{{< expand "Example" >}} -``` - Enter an option from 1-11: 1 - 1) igb0 - 2) igb1 - Select an interface (q to quit): 1 - Delete interface? (y/n) n - Remove the current settings of this interface? (This causes a momentary disconne - ction of the network.) (y/n) n - Configure IPv4? (y/n) y - Interface name: - Several input formats are supported - Example 1 CIDR Notation: - 192.168.1.1/24 - Example 2 IP and Netmask separate: - IP: 192.168.1.1 - Netmask: 255.255.255.0, /24 or 24 - IPv4 Address:10.238.15.194/22 - Saving interface configuration: Ok - Configure IPv6? (y/n) n - Configure failover settings? (y/n) n - Restarting network: ok - Restarting routing: ok -``` -{{< /expand >}} -Saving interface configuration changes disrupts the web interface while system networking restarts. -The new settings might need a system reboot to take effect. If the web interface is unavailable, this could also require a reboot. Check if the network interface you changed is the one utilized by the web interface. diff --git a/content/CORE/CORETutorials/Network/Interfaces/VLANCreate.md b/content/CORE/CORETutorials/Network/Interfaces/VLANCreate.md deleted file mode 100644 index 77fde228e6..0000000000 --- a/content/CORE/CORETutorials/Network/Interfaces/VLANCreate.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Setting Up a Network VLAN" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/network/interfaces/vlancreate/" -description: "Provides instructions on setting up a network VLAN interface on TrueNAS CORE." -weight: 30 -tags: -- network -- interfaces ---- - -A virtual LAN (VLAN) is a specialized domain in a computer network. It is a domain partitioned and isolated at the data link layer (OSI layer 2). See [here](https://www.ieee802.org/1/pages/802.1Q-2014.html) for more information on VLANs. TrueNAS uses [vlan(4)](https://www.freebsd.org/cgi/man.cgi?vlan(4)) to manage VLANS. - -To set up a VLAN interface, go to **Network > Interface > Add**. - -![NetworkInterfacesAddVLAN](/images/CORE/Network/NetworkInterfacesAddVLAN.png "Adding a new VLAN") - -Set the **Type** to **VLAN** and enter a name for the interface in **Name**. The name must use the format **vlan***X*, where *X* is a number representing a non-parent interface. -Enter any notes or reminders about this VLAN in the **Description** field. - -Determine the requirements of your network environment before enabling **DHCP** or **AutoconfigureIPv6**. -It is important to understand how this new interface functions in your situation. By default, TrueNAS allows only one network interface to have **DHCP** enabled. - -Give careful attention to the remaining **VLAN Settings**. These need proper configuration in order for the network interface to function. - -* **Parent Interface** where you select the VLAN parent interface. This is usually an Ethernet card connected to a switch port already configured for the VLAN. -* **Vlan Tag** where you enter a numeric tag for this interface. This is usually preconfigured in the switched network. -* **Priority Code Point** where you define the VLAN [Class of Service](https://tools.ietf.org/html/rfc4761#section-4.2.7). - -There are a few extra interface options to review after the VLAN options are set. -See [Interfaces Screen]({{< relref "/CORE/UIReference/Network/InterfacesScreen.md" >}}) for more information on settings. - -{{< include file="/static/includes/InterfaceOptions.md" markdown="true" >}} diff --git a/content/CORE/CORETutorials/Network/Interfaces/_index.md b/content/CORE/CORETutorials/Network/Interfaces/_index.md deleted file mode 100644 index 6e5cbcad0f..0000000000 --- a/content/CORE/CORETutorials/Network/Interfaces/_index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "Interfaces" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/network/interfaces/" -description: "Provides instructions on how to edit a network physical interface and a list of other TrueNAS CORE network interface tutorials." -geekdocCollapseSection: true -weight: 30 -aliases: - - /core/coretutorials/network/interfaces/editingphysicalinterface/ - - /core/network/interfaces/editingphysicalinterface/ - - /core/coretutorials/network/networksummary/ - - /core/network/interfaces/ -related: false -tags: - - network - - interfaces ---- - -## Editing an Interface ### - -{{< hint type=important >}} -Be careful when configuring the network interface that controls the TrueNAS® web interface. An error can result in the loss of web connectivity. -{{< /hint >}} - -**Network > Interfaces** lists all physical [Network Interface Controllers (NICs)]({{< relref "/CORE/UIReference/Network/InterfacesScreen.md" >}}) connected -to your TrueNAS® system. - -![NetworkInterfaces](/images/CORE/Network/NetworkInterfaces.png "Interfaces List") - -To edit an interface, click **>** next to it to expand the view. This provides a general description about the chosen interface. Click **EDIT**. - -{{< hint type=note >}} -TrueNAS Enterprise customers: you cannot edit an interface with High Availability (HA) enabled. -Go to **System > Failover** and check the **Disable Failover** box, then click **SAVE**. -{{< /hint >}} - -![NetworkInterfaceDescription](/images/CORE/Network/NetworkInterfaceDescriptionView.png "Network Interface Description") - -{{< hint type=note >}} -The **Type** of interface determines the interface editing options available. -{{< /hint >}} - -See [Interfaces Screen]({{< relref "/CORE/UIReference/Network/InterfacesScreen.md" >}}) for more information on settings. - -## Saving Interface Changes ## - -After completing interface editing, click **SAVE**. -You have the option to **TEST CHANGES** or **REVERT CHANGES**. -The default time for testing changes is 60 seconds, but you can change it to your desired setting. - -![NetworkInterfacesChangesPresent](/images/CORE/Network/NetworkInterfacesChangesPresent.png "Interface Changes Detected") - -After clicking **TEST CHANGES**, confirm your choice and click **TEST CHANGES** again. - -![NetworkInterfaceTestChangesNotice](/images/CORE/Network/NetworkInterfaceTestChangesNotice.png "Network Interface Test Changes Notice") - -Either click **SAVE CHANGES** or **REVERT CHANGES**. -You have the time specified to make this choice. -Clicking **SAVE CHANGES** opens a dialog with the option to **CANCEL** or **SAVE** network interface changes. Click **SAVE**. - -![NetworkInterfaceEditSaveChanges](/images/CORE/Network/NetworkInterfaceEditSaveChanges.png "Network Interface Edit Save Changes ") - -![NetworkInterfaceSaveChangesOption](/images/CORE/Network/NetworkInterfaceSaveChangesOption.png "Network Interface Save Changes Option ") - -The system displays a dialog that shows the network interface changes are now permanent. - -![NetworkInterfaceDialog](/images/CORE/Network/NetworkInterfaceDialogBox.png "Network Interface Dialog Box ") - -
- -## Interface Articles - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/CORETutorials/Network/StaticRoutes.md b/content/CORE/CORETutorials/Network/StaticRoutes.md deleted file mode 100644 index c6d046ab49..0000000000 --- a/content/CORE/CORETutorials/Network/StaticRoutes.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Define Static Routes" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/network/staticroutes/" -description: "Provides instructions on setting up static routes on TrueNAS CORE." -weight: 40 -tags: -- staticroutes -- network ---- - -Static routes are fixed, or non-adaptive routes. They are manually configured routes in the routing table. - -It is recommended to use the web UI for all configuration tasks. TrueNAS does not have static routes defined by default. -When required, add a static route by going to **Network** > **Static Routes** and clicking **ADD**. - - -

- -* Enter a **Destination** IP address. Use the format *A.B.C.D/E* where *E* is the CIDR mask. - -* Enter the IP address of the **Gateway**. - -* Enter any notes or identifiers describing the route in **Description**. diff --git a/content/CORE/CORETutorials/Network/Wireguard.md b/content/CORE/CORETutorials/Network/Wireguard.md deleted file mode 100644 index fc51c89b74..0000000000 --- a/content/CORE/CORETutorials/Network/Wireguard.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "Enabling WireGuard" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/network/wireguard/" -description: "Provides instructions on setting up WireGuard on TrueNAS CORE." -weight: 50 -aliases: /core/network/wireguard/ -tags: -- vpn -- network ---- - -[WireGuard](https://www.wireguard.com/) is a popular option in the VPN marketplace. It is fast, simple, and uses modern cryptography standards. It is possible to connect your NAS to a WireGuard network in a few easy steps. Systems running FreeNAS version 11.3-RC1 through TrueNAS 13.0 have WireGuard capability. - -## Configure System Tunables for WireGuard - -Go to **System > Tunables > Add** and use these settings to enable the service: - -* **Variable** = **wireguard_enable** -* **Value** = **YES** -* **Type** = **rc.conf** - -![EnableWireguard](/images/CORE/System/wireguard_enable.png "Enable Wireguard") - -Next, create another tunable to define the networking interface: - -* **Variable** = **wireguard_interfaces** -* **Value** = **wg0** -* **Type** = **rc.conf** - -![WireguardInterface](/images/CORE/System/wireguard_interfaces.png "Wireguard Interfaces") - -When finished, TrueNAS sets and enables the two variables. - -![WireguardVariables](/images/CORE/System/wireguard_variables.png "Wireguard Variables") - -## Configure a Init/Shutdown Script - -Next, create a post-init script. This places the WireGuard config in the correct location at startup. - -Go to **Tasks > Init/Shutdown Scripts** and click **Add**. -Configure the script to load the WireGuard .conf file each time the system boots: - -* **Type** = **Command** -* **Command** = `mkdir -p /usr/local/etc/wireguard && cp /root/wg0.conf /usr/local/etc/wireguard/wg0.conf && /usr/local/etc/rc.d/wireguard start` -* **When** = **Post Init** - -## Configure the WireGuard File - -You can configure the /root/wg0.conf file. This applies a WireGuard configuration to attach to whatever WireGuard network you define. -It can be a single point-to-point to anything running WireGuard. It can even use full routing. -Example use cases are: - -* Access data on a NAS from your Remote Laptop -* Linking NAS to NAS for replication -* Attaching a managed NAS to a remote network -* Access to your NAS from your smartphone - -![WireguardPostInit](/images/CORE/System/WireguardInitScript.png "Wireguard Post Init Script") - -### Create the File with WireGuard Configuration to Apply at Boot - -Now create the /root/wg0.conf. This is the specific WireGuard configuration to apply at boot. -These file settings depend on your specific networking environment and requirements. Their configuration is beyond the scope of this article. - -There are [quickstart guides](https://www.wireguard.com/quickstart/) and [tutorials](https://www.linode.com/docs/networking/vpn/set-up-wireguard-vpn-on-ubuntu/) available online as well as the built-in wg-quick manpage. - -Determine that you have a valid /root/wg0.conf. If so, rebooting the system brings up the WireGuard interface with a wg0 device in the output of `ifconfig`. - -![wg0DeviceOutput](/images/CORE/System/wg0DeviceOutput.png "wg0 device output") diff --git a/content/CORE/CORETutorials/Network/_index.md b/content/CORE/CORETutorials/Network/_index.md deleted file mode 100644 index bedb2c9129..0000000000 --- a/content/CORE/CORETutorials/Network/_index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "Network" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/network/" -description: "Provides information on using the Network Summary screen and lists other tutorials related to configuring CORE networking." -geekdocCollapseSection: true -weight: 80 -related: false -aliases: - - /core/network/networksummary/ - - /core/coretutorials/network/networksummary/ -tags: -- network ---- - -## Network Summary - -The **Network Summary** screen gives a concise overview of the current network setup. -It provides information about the currently active interfaces, default routes, and name servers configured on the system. -These areas are not editable. - -![**Network Summary**](/images/CORE/Network/NetworkSummary.png "Network Summary") - -* [**Interfaces**]({{< relref "/CORE/CORETutorials/Network/Interfaces/_index.md" >}}) shows configured physical, [bridge]({{< relref "/CORE/CORETutorials/Network/Interfaces/BridgeCreate.md" >}}), link aggregation [LAGG]({{< relref "/CORE/CORETutorials/Network/Interfaces/LAGGCreate.md" >}}), and virtual LAN [vlan]({{< relref "/CORE/CORETutorials/Network/Interfaces/VLANCreate.md" >}}) interfaces. - All detected physical interfaces are listed, even when unconfigured. - The IPv4 or IPv6 address displays when a [static IP]({{< relref "/CORE/CORETutorials/Network/Interfaces/SettingStaticIP.md" >}}) is saved for an interface. - -* **Default Routes** lists all saved TrueNAS default routes. - Go to **Network > Global Configuration** to configure default routes. - -* **Nameservers** lists any configured DNS name servers that TrueNAS uses. - To change this list, go to **Network > Global Configuration**. - **Network > Global Configuration** contains the TrueNAS host name and domain, and default gateway. It also contains other options. - -Define a static route in **Network > [Static Routes]({{< relref "/CORE/CORETutorials/Network/StaticRoutes.md" >}})**. - -Out-of-band management is managed from **Network > [IPMI]({{< relref "/CORE/CORETutorials/Network/IPMI.md" >}})**. -This option is visible only when TrueNAS detects the appropriate physical hardware. - -
- -## Network Articles - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/CORETutorials/Services/ConfigureDynamicDNS.md b/content/CORE/CORETutorials/Services/ConfigureDynamicDNS.md deleted file mode 100644 index c669b7895b..0000000000 --- a/content/CORE/CORETutorials/Services/ConfigureDynamicDNS.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "Configuring Dynamic DNS" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/configuredynamicdns/" -description: "Provides instructions on how to configure Dynamic Domain Name Service (DDNS) on your TrueNAS system." -weight: 20 -aliases: /core/services/dynamicdns/ -tags: -- ddns ---- - -ISPs often change the IP address of the system. With [Dynamic Domain Name Service (DDNS)](https://tools.ietf.org/html/rfc2136) the current IP address continues to point to a domain name to provide access to TrueNAS. - -DDNS requires registration with a DDNS service such as [DynDNS](https://dyn.com/dns/) before configuring TrueNAS. -Open your specific DDNS service settings in another browser tab for reference while configuring TrueNAS. -Log in to the TrueNAS web interface and go to **Services > Dynamic DNS**. - -![ServicesDynamicDNSOptions](/images/CORE/Services/ServicesDynamicDNSOptions.png "Dynamic DNS Service Options") - -Your DDNS solution provides the required values for these fields. -Start the DDNS service after choosing your **Provider** options and saving the settings. diff --git a/content/CORE/CORETutorials/Services/ConfigureUPS.md b/content/CORE/CORETutorials/Services/ConfigureUPS.md deleted file mode 100644 index 5243d97a91..0000000000 --- a/content/CORE/CORETutorials/Services/ConfigureUPS.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "Configuring UPS" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/configureups/" -description: "Provides information on configuring UPS service on your TrueNAS." -weight: 150 -aliases: /core/services/ups/ -tags: -- ups ---- - -An Uninterruptible Power Supply (UPS) is a power backup system that ensures continuous electricity during outages, preventing downtime and damage. - -{{< include file="/static/includes/NUTsupport.md" >}} - -## Setting Up UPS Service - -Connect the TrueNAS system to the UPS device. Configure the UPS service by going to **Services**, finding the **UPS** entry, and clicking edit edit icon. - -{{< include file="/static/includes/HAUninterruptiblePowerSupplyNotice.md" >}} - -{{< trueimage src="/images/CORE/Services/ServicesUPSScreenTop.png" alt="UPS Service Screen" id="UPS Service Screen (Top)" >}} - -{{< trueimage src="/images/CORE/Services/ServicesUPSScreenBottom.png" alt="UPS Service Screen" id="UPS Service Screen (Bottom)" >}} - -See [UPS Screen]({{< relref "/CORE/UIReference/Services/UPSScreen.md" >}}) for more information on UPS settings. -Some UPS models can be unresponsive with the default polling frequency. -This shows in TrueNAS logs as a recurring error like `libusb_get_interrupt: Unknown error`. -The default polling frequency is **two** seconds. Decrease the polling frequency by adding an entry to **Auxiliary Parameters (ups.conf)**: `pollinterval = 10`. This should resolve the error. - -[upsc(8)](https://www.freebsd.org/cgi/man.cgi?query=upsc) can get status variables like the current charge and input voltage from the UPS daemon. -Run this command from the shell using the syntax `upsc ups@localhost`. -The [upsc(8)](https://www.freebsd.org/cgi/man.cgi?query=upsc) manual page has other usage examples. - -If the hardware supports sending the command, [upscmd(8)](https://www.freebsd.org/cgi/man.cgi?query=upscmd) can send commands directly to the UPS. -Only users with administrative rights can administer these commands. -Create these users in the **Extra Users** field. - -{{< expand "How do I find a device name?" "v" >}} -Determine the correct device name for the UPS. Go to **System > Advanced** and select **Show console messages**. -Plug in the USB device and look for a /dev/ugen or /dev/uhid device name in the console messages. -{{< /expand >}} - -{{< expand "Can I attach multiple computers to one UPS?" "v" >}} -A UPS with adequate capacity can power multiple computers. -Connect one computer to the UPS data port with a serial or USB cable. -This primary system makes UPS status available on the network for other computers. -The secondary computers receive UPS status data from the primary computer. The secondary computers receive power from the UPS. -See the [NUT User Manual](https://networkupstools.org/docs/user-manual.chunked/index.html) and [NUT User Manual Pages](https://networkupstools.org/docs/man/index.html#User_man). -{{< /expand >}} diff --git a/content/CORE/CORETutorials/Services/ConfiguringFTP.md b/content/CORE/CORETutorials/Services/ConfiguringFTP.md deleted file mode 100644 index 7b80853a0c..0000000000 --- a/content/CORE/CORETutorials/Services/ConfiguringFTP.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "Configuring FTP" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/configuringftp/" -description: "Provides information on how to configure File Transfer Protocol (FTP) on your TrueNAS." -weight: 30 -tags: -- ftp ---- - -## FTP Connections - -FTP connections cannot share connections with other accounts, such as SMB connections. FTP connections need a new dataset and local user account. - -Go to **Storage > Pools** to add a new dataset. - -![StoragePoolsAddDataset2](/images/CORE/Storage/StoragePoolsAddDataset2.png "Adding a New Dataset") - -See [Creating Datasets]({{< relref "CORE/CORETutorials/Storage/Pools/Datasets.md" >}}) for information on how to create the dataset. After this step is completed, the new dataset appears nested beneath the pool. - -![StorageAllPoolsDataset](/images/CORE/Storage/StorageAllPoolsDataset.png "New Dataset Listed") - -Next, go to **Accounts > Users > Add** to create a local user on the TrueNAS. - -![AddUserNamedCORE](/images/CORE/Accounts/AddUserNamedCORE.png "Adding a New User Account") - -Assign a user name and password. Link the new dataset for the FTP share as the home directory of the user. -Link the new dataset for the FTP share on a per user basis, or create a global account for FTP. Example: OurOrgFTPacnt, etc. - -Return to **Storage > Pools**, find the new dataset, and click **> Edit Permissions**. -In the **Owner** fields, select the new user account as the **User** and **Group** from the dropdown list. -Be sure to select **Apply User** and **Apply Group** before saving. - -![StoragePoolsEditPermissionsCORE](/images/CORE/Storage/StoragePoolsEditPermissionsCORE.png "Basic Permissions Editor") - -### Service Configuration - -To configure FTP, go to the **Services** page, find the **FTP** entry, and click the . - -![FTPServicesGeneralCORE](/images/CORE/Services/FTPServicesGeneralCORE.png "Services FTP Options") - -Configure the options according to your environment and security considerations. See [FTP Screen]({{< relref "/CORE/UIReference/Services/FTPScreen.md" >}}) - -### Advanced Options - -Enable **chroot** to help confine FTP sessions to a local user home directory and allow **Local User Login**. - -{{< hint type=important >}} -Unless necessary, do not allow anonymous or root access. For better security, enable TLS when possible. -This is effectively [FTPS](https://tools.ietf.org/html/rfc4217). -Enable TLS when FTP involves a WAN. -{{< /hint >}} - -### FTP Connection - -Use a browser or FTP client to connect to the TrueNAS FTP share. -The images here show using [FileZilla](https://sourceforge.net/projects/filezilla/), a free option. - -The user name and password are those of the local user account on the TrueNAS. -The default directory is the same as the user /home directory. -After connecting, you can create directories and upload or download files. - -![FilezillaFTPConnect](/images/CORE/FilezillaFTPConnect.png "Filezilla FTP Connection") diff --git a/content/CORE/CORETutorials/Services/ConfiguringLLDP.md b/content/CORE/CORETutorials/Services/ConfiguringLLDP.md deleted file mode 100644 index 6478d119e8..0000000000 --- a/content/CORE/CORETutorials/Services/ConfiguringLLDP.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Configuring LLDP" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/configuringlldp/" -description: "Provides information on how to configure Link Layer Discovery Protocol (LLDP) on your TrueNAS." -weight: 50 -aliases: /core/services/lldp/ -tags: -- network ---- - -Network devices use the [Link Layer Discovery Protocol (LLDP)](https://tools.ietf.org/html/rfc4957) to advertise their identity, capabilities, and neighbors on an Ethernet network. -TrueNAS uses the [ladvd](https://github.com/sspans/ladvd) LLDP implementation. -LLDP service is often used in a local network environment with managed switches. Configuring and starting the LLDP service allows the TrueNAS system to advertise itself on the network. - -To configure LLDP, go to the **Services** page, find the **LLDP** entry, and click the icon. - -![ServicesLLDPOptions](/images/CORE/Services/ServicesLLDPOptions.png "LLDP Service Options") - -Select **Interface Description** and enter a **Country Code**. The location of the system is optional. - -Click **SAVE** to save the current selections and return to the **Services** screen. - -Click the toggle on the **Services** screen to turn the LLDP service on. The toggle turns blue when it is running. diff --git a/content/CORE/CORETutorials/Services/ConfiguringOpenVPN.md b/content/CORE/CORETutorials/Services/ConfiguringOpenVPN.md deleted file mode 100644 index 8b5159e349..0000000000 --- a/content/CORE/CORETutorials/Services/ConfiguringOpenVPN.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: "Configuring OpenVPN" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/configuringopenvpn/" -description: "Provices information on how to configure Open Virtual Private Network (OpenVPN) services on your TrueNAS." -weight: 70 -aliases: /core/services/openvpn/ -tags: -- vpn ---- - -## About OpenVPN - -A virtual private network (VPN) is an extension of a private network over public resources. It allows remote clients on a public network to access a private network via a secure connection. TrueNAS provides [OpenVPN](https://openvpn.net/) as a system level service that provides VPN server or client functionality. TrueNAS uses a single TCP or UDP port to act as a primary VPN server. This allows remote clients access to data stored on the system. VPN integration is possible even if the system is in a separate physical location, or only has access to public networks. - -## Obtaining a Public Key Infrastructure (PKI) - -Public key infrastructure (PKI) must be in place before configuring TrueNAS as either an OpenVPN server or client. PKI utilizes [certificates]({{< relref "/CORE/UIReference/System/Certificates.md" >}}) and [certificate authorities]({{< relref "CAs.md" >}}) created in or imported to TrueNAS. -{{< expand "What does this do?" "v" >}} -TrueNAS authenticates with clients or servers by confirming network credentials. These must be signed by a valid master certificate authority (CA). -To read more about the required PKI for OpenVPN, see the [OpenVPN PKI Overview](https://community.openvpn.net/openvpn/wiki/HOWTO?__cf_chl_jschl_tk__=92022277e38bff707b1684f49a2af61f5eb4c632-1605712222-0-AQxKxUAlHKMcfHHNdSMOLL25Lr3e8icKHu3CgjMFRe6GXS1Z72EgXMieNrGaBdWa0m3R5CEZcxwGdwhgaRO392FTivdOQis5Pa2Bm-4jEzydUBTqhx_F4XWN7ujVee5CUxG6AoyOet91SaWM-siqV0_d0ppGnSsfwX9HFOmKuAnJexAjqpofUlP6xjru4Qujw72uR-yUT3fuFDMyukAAtEAP_zPXtewdS_kcSC5eSdf-RC6V8T_QZ2UT6GfqxxSr5shwe0rFkNinTCOKLk_67UIU2zEkpuiQ8C7p3ysh1DS_ONAzR2pfwdgetKm3HiBJ38C86956W6D8-mpOulfP26E#Overview). -{{< /expand >}} - -## Configuring OpenVPN: Process Overview - -The general process to configure OpenVPN (server or client) on TrueNAS is to: - -* Select the networking credentials -* Set the connection detail -* Choose any additional security or protocol options - -### Configuring OpenVPN Client - -Go to the **Services** page and find the **OpenVPN Client** entry. -Click the to configure the service. - -![ServicesOpenVPNClientOptions](/images/CORE/Services/ServicesOpenVPNClientOptions.png "OpenVPN Client Options") - -Choose the certificate to use as an OpenVPN client. -This certificate must exist in TrueNAS and be in an active (unrevoked) state. - -Enter the host name or IP address of the **Remote** OpenVPN server. - -Select any other [connection settings](#connection-settings) that fit with your network environment. Check for performance requirements. -The **Device Type** must match with the OpenVPN server **Device Type**. -**Nobind** prevents using a fixed port for the client. -Enabled by default, it allows the OpenVPN client and server to run at the same time. - -Review the [Security Options](#security-options) and select settings that meet your network security requirements. -Determine if the OpenVPN server is using TLS Encryption. If so, copy the static TLS encryption key and paste into the **TLS Crypt Auth** field. - -### OpenVPN Server - -Go to the **Services** page and find the **OpenVPN Server** entry. -Click the to configure the service. - -![ServicesOpenVPNServerOptions](/images/CORE/Services/ServicesOpenVPNServerOptions.png "OpenVPN Server Options") - -Choose a **Server Certificate** for this OpenVPN server. -This certificate must exist in TrueNAS and be in an active (unrevoked) state. - -Define a IP address and netmask for the OpenVPN. Enter these values in **Server**. -Continue to select the remaining [Connection Settings](#connection-settings) that fit with your network environment and performance requirements. -When selecting **TUN** in **Device Type**, you can select a virtual addressing method for the server in **Topology**. Options are: - -* **NET30**: Use one **/30** subnet per client in a point-to-point topology. - Designed for use when connecting clients are Windows systems. -* **P2P**: Point-to-point topology. Points the local server and remote client endpoints to each other. - One IP address given to each client. - This is only recommmended when none of the clients are a Windows system. -* **SUBNET**: The interface uses an IP address and subnet. - One IP address given to each client. - Windows clients need the **TAP-Win32 driver** version 8.2 or newer. - **TAP** devices always use the **SUBNET** specified in **Topology**. - -The **Topology** selection is automatically applied to any connected clients. - -When **TLS Crypt Auth Enabled** is selected, TrueNAS generates a static key for the **TLS Crypt Auth** field after saving the options. -To change this key, click **RENEW STATIC KEY**. -Any clients connecting to the server need this key. -Keys stored in the system database are included in a generated client config file. A good practice is to back up keys in a secure location. - -Review the [Security Options](#security-options) and choose settings that meet your network security requirements. - -Configure and save your OpenVPN server settings. - -OpenVPN client systems that are connecting to this server will need to import client configuration files. To generate client configuration files, you need the client certificate from the client system. The client certificate was previously imported to the client system. Click **DOWNLOAD CLIENT CONFIG** and select the **Client Certificate**. - -## Connection Settings - -See [OpenVPN Screens]({{< relref "/CORE/UIReference/Services/OpenVPNScreen.md" >}}) for more information on the client and server settings. - -## Security Options - -Connecting to a private network still sends data over less secure public resources. OpenVPN includes several security features that are optional. These optional security features help protect the data sent into or out of the private network. - -* **Authentication Algorithm**: This is used to validate packets that are sent over the network connection. Your network environment might require a specific algorithm. **SHA1 HMAC** is a good standard algorithm to use if a particular algorithm is not required. -* **Cipher**: This is an algorithm to encrypt data packets sent through the connection. While not required, choosing a cipher can increase connection security. Verify the required ciphers for your networking environment. If there are no specific cipher requirements, **AES-256-GCM** is a good default choice. -* **TLS Encryption**: Selecting **TLS Crypt Auth Enabled** encrypts all TLS handshake messages. This adds another layer of security. OpenVPN server and clients share a required static key. - -## Service Activation - -When finished configuring the server or client service, click **SAVE**. -Start the service by clicking the related toggle in **Services**. -To check the current state of the service, hover over the toggle. - -**Start Automatically**: Selecting this option starts the OpenVPN service whenever TrueNAS completes booting. The network and data pools must be running. diff --git a/content/CORE/CORETutorials/Services/ConfiguringRsync.md b/content/CORE/CORETutorials/Services/ConfiguringRsync.md deleted file mode 100644 index 36b1957a37..0000000000 --- a/content/CORE/CORETutorials/Services/ConfiguringRsync.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: "Configuring Rsync" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/configuringrsync/" -description: "Provides information on how to configure remote sync (rsync) on your TrueNAS." -weight: 43 -aliases: - - /core/services/rsync/ -tags: -- rsync ---- - -Rsync is an open source cross-platform file transfer and synchronization utility. It is a fast and secure way to copy data to another system for backup or to migrate data to a new system. -Use the default settings unless you require a specific change. Don't forget to click **SAVE** after changing any settings. - -Log in to the TrueNAS web interface and go to **Services > Rsync**. Click the edit icon to edit the Rsync settings. - -## Rsync Configuration Screen - -Enter the **TCP Port** you want Rsync to listen on, then enter any [rsyncd.conf(5)](https://www.samba.org/ftp/rsync/rsyncd.conf.html) **Auxiliary Parameters**. - -![RsyncConfigure](/images/CORE/Tasks/RsyncConfigure.png "Configuring rsync") - -## Rsync Modules - -TrueNAS lists all created modules here. -Use this **Rsync Modules** list to **EDIT** or **DELETE** a module. Click to select a module to edit. - -To create a new module, click **ADD**. - -![RsyncModule](/images/CORE/Tasks/RsyncModule.png "Creating a rsync module") - -**Name** the module and select a **Path** to store it in. Select an **Access Mode** and fill out the rest of the fields to your needs. - -![ServicesRsyncModuleAdd](/images/CORE/Services/ServicesRsyncModuleAdd.png "Creating a rsync module") - -{{< expand "Rsync Services Add Module Options Defined" "v" >}} -**General** - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Name** | Enter the IP address or host name of the system that will store the copy. Use the format `username@remote_host` if the user name differs on the remote host. | -| **Path** | Browse to pool or dataset to store received data. | -| **Comment** | Enter a description for this module. | -| **Enabled** | Select to activate this rsync module. Clear to deactivate but retain module configuration. | -| **Access Mode** | Select from dropdown list. **Read Only**, **Write Only**, **Read and Write**. | -| **Max Connections** | Enter a maximum number of connections. 0 is unlimited. | -| **User** | Select from dropdown list a user to run as during file transfers to and from this module. | -| **Group** | Select from dropdown list a group to run as during file transfers to and from this module. | -| **Hosts Allow** | Enter a value from [rsyncd.conf(5)](https://www.samba.org/ftp/rsync/rsyncd.conf.html). A list of patterns to match with the host name and IP address of a connecting client. Connection rejected if no patterns match. Separate entries by pressing Enter. | -| **Hosts Deny** | Enter a value from [rsyncd.conf(5)](https://www.samba.org/ftp/rsync/rsyncd.conf.html). A list of patterns to match with the host name and IP address of a connecting client. Connection rejected when the patterns match. Separate entries by pressing Enter. | -| **Other Options: Auxiliary Parameters** | Enter any additional parameters from [rsyncd.conf(5)](https://www.samba.org/ftp/rsync/rsyncd.conf.html). | -{{< /truetable >}} -{{< /expand >}} - -{{< hint type=note >}} -When a **Hosts Allow** list is defined, only the IPs and hostnames on the list are able to connect to the module. -{{< /hint >}} diff --git a/content/CORE/CORETutorials/Services/ConfiguringS3.md b/content/CORE/CORETutorials/Services/ConfiguringS3.md deleted file mode 100644 index 8293901548..0000000000 --- a/content/CORE/CORETutorials/Services/ConfiguringS3.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "Configuring S3" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/configurings3/" -description: "Provides information on how to start a local S3 service on your TrueNAS." -weight: 100 -aliases: /core/services/s3/ -tags: -- s3 ---- - -{{< include file="/static/includes/S3Deprecation.md" >}} - -This tutorial describes how to start a local S3 service on TrueNAS and connect to it from a networked client system with the MinIO Browser, s3cmd, and S3 Browser. - -{{< expand "Background" "v" >}} -S3 is an object storage protocol used by many major cloud providers, including Amazon Web Services™. On TrueNAS, the service is another way to store files. You can view these files with a web browser. S3 is the de facto standard for cloud-based storage. Organizations or online application developers can use TrueNAS with an S3 service. This can replace or archive expensive cloud storage. -{{< /expand >}} - -{{< hint type=important >}} -Having large numbers of files (>100K for instance) in a single bucket with no sub-directories is not recommended. It can harm performance and cause stability issues. -{{< /hint >}} - -## Setting up the S3 service - -Go to the **Services** page and find **S3** on the list. - -![ServicesS3Enable](/images/CORE/Services/ServicesS3Enable.png "Services S3 Enable") - -Click the toggle to stop the service if it is running. -Select **Start Automatically** to start the service when TrueNAS boots. - -Click the to configure the service. - -![ServicesS3Options](/images/CORE/Services/ServicesS3Options.png "S3 Service Options") - -See [S3 screen]({{< relref "/CORE/UIReference/Services/S3Screen.md" >}}) for information on settings. - -The IP address **0.0.0.0** allows the service to listen on any IPv4 address. -**::** allows the same for any IPv6 address. -Select the TrueNAS IP address to constrain it to a specific network. - -Select a clean dataset. -If there is no dataset, click **CANCEL** and then go to **Storage > Pools** and click **> Add Dataset**. -MinIO manages files as objects. These objects cannot mix with other dataset files. - -Configure the rest of the options as needed in your environment. -Make sure to start the service after saving any changes. diff --git a/content/CORE/CORETutorials/Services/ConfiguringSFTP.md b/content/CORE/CORETutorials/Services/ConfiguringSFTP.md deleted file mode 100644 index f61bfcede8..0000000000 --- a/content/CORE/CORETutorials/Services/ConfiguringSFTP.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "Configuring SFTP" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/configuringsftp/" -description: "Configuring SSH File Transfer Protocol (SFTP) service on your TrueNAS." -weight: 20 -aliases: - - /hub/sharing/ftp-sftp/ -tags: -- ftp -- sftp -- ssh ---- - -## Configuring SFTP Service - -SSH File Transfer Protocol (SFTP), is available by enabling SSH remote access to the TrueNAS system. -SFTP is more secure than standard FTP as it applies SSL encryption on all transfers by default. - -Go to **Services**, find the **SSH** entry, and click the . - -![ServicesSSHOptions](/images/CORE/Services/ServicesSSHOptions.png "SSH Options") - -Select **Allow Password Authentication**. - -{{< hint type=important >}} -Evaluate **Log in as Root with Password** for your security environment: -SSH with root is a security vulnerability. It allows more than SFTP transfer access. SSH with root also allows full remote control over the NAS with a terminal. -{{< /hint >}} - -Review the remaining options and configure according to your environment or security needs. - -### SSH Service Options - -Use the **SSH** screen to configure the system for SFTP. -See [ServicesSSH]({{< relref "/CORE/UIReference/Services/ServicesSSH.md" >}}) for information on SSH screen settings. - -### SFTP Connections - -Open FileZilla or another FTP client, or command line. -This example uses FileZilla. -Using FileZilla, enter `SFTP://TrueNAS IP`, `username`, `password`, and port `22` to connect. Where `TrueNAS IP` is the IP address for your system, and `username` and `password` are those you use to connect to the FTP client. Or enter `SFTP://'TrueNAS IP'`, `'username'`, `'password'`, and port `22` to connect. - -{{< hint type=important >}} -Chroot is not 100% secure, but SFTP does not have chroot locking. -The lack of chroot allows users to move up to the root directory. They can view internal system information. If this level of access is a concern, FTP with TLS may be the more secure choice. -{{< /hint >}} - -### SFTP in a TrueNAS Jail - -Setting up a jail and enabling SSH is another way to allow SFTP access. This does not grant read access to other areas of the NAS itself. - -{{< expand "Setting up a Jail for SFTP" "v" >}} -Go to **Jails > Add**. -Provide a name for the jail and pick a target FreeBSD image. -This example uses 11.3. - -Select the networking options for either DHCP or a static IP and confirm to create. - -![JailsAddNetworking](/images/CORE/Jails/JailsAddNetworking.png "Jail Networking Options") - -After the jail is created, click the expand icon **>** on the right-hand side of the jail to open it. -Click **START** and open **> SHELL**. - -Create a user in the jail. -Enter command `adduser`. Follow the prompts. Include the password and home directory location. -When complete, the jail asks to confirm the credentials. - -![JailsShellUserAdd](/images/CORE/Jails/JailsShellUserAdd.png "Adding a new user to a jail") - -Enable SSH by editing the /etc/rc.conf file. -Enter command `vi /etc/rc.conf` or `ee /etc/rc.conf` depending on preference, add `sshd_enable = "YES"` to the file, save, and exit. -Enter command `service sshd enabled` to enable the service (enabled vs start indicates whether sshd starts one time or on every reboot). - -![JailsShellEditRCConf](/images/CORE/Jails/JailsShellEditRCConf.png "Enabling SSH in a jail") - -Using an FTP client, such as FileZilla, log in with the jail IP address and user credentials. It is like SSH on TrueNAS. Browsing to other folders and locations beyond the user home directory is possible. But unlike running on TrueNAS directly, only the components of the jail are available. - -![FilezillaJailConnectSFTP](/images/CORE/FilezillaJailConnectSFTP.png "Filezilla SFTP Connect to TrueNAS Jail") -{{< /expand >}} diff --git a/content/CORE/CORETutorials/Services/ConfiguringSMART.md b/content/CORE/CORETutorials/Services/ConfiguringSMART.md deleted file mode 100644 index a64b0aa144..0000000000 --- a/content/CORE/CORETutorials/Services/ConfiguringSMART.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "Configuring S.M.A.R.T." -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/configuringsmart/" -description: "Configurinng Self-Monitoring, Analysis and Reporting Technology (S.M.A.R.T.) on your TrueNAS." -weight: 90 -aliases: /core/services/smart/ -tags: -- smart ---- - -[S.M.A.R.T.](https://en.wikipedia.org/wiki/S.M.A.R.T.) Self-Monitoring, Analysis and Reporting Technology (SMART) is an industry standard. It performs disk monitoring and testing. Several different kinds of self-tests check disks for problems. - -Click the in **Services > S.M.A.R.T.** to configure the service. - -![ServicesSMARTOptions](/images/CORE/Services/ServicesSMARTOptions.png "S.M.A.R.T. Options") - -**General Options** - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Check Interval** | Enter number of minutes to determine how often the smartd daemon monitors for configured tests to be run. | -| **Power Mode** | Select from dropdown list: **Never**, **Sleep**, **Standby** or **Idle**. Tests only run with **Never**. | -| **Difference** | Enter in degrees Celsius. S.M.A.R.T. sends alerts if the temperature of a drive changes by N degrees Celsius since the last report. | -| **Informational** | Enter in degrees Celsius. S.M.A.R.T. sends messages with a log level of LOG_INFO if the temperature exceeds the threshold. | -| **Critical** | Enter in degrees Celsius. S.M.A.R.T. sends messages with a log level of LOG_CRIT if the temperature exceeds the threshold. | -{{< /truetable >}} - -## Service Activation - -Click **SAVE** when finished configuring the server or client service. -Start the service by clicking the related toggle in **Services**. -To check the current state of the service, hover over the toggle. - -Selecting **Start Automatically** starts the service whenever TrueNAS completes booting. The network and data pools must be running. diff --git a/content/CORE/CORETutorials/Services/ConfiguringSNMP.md b/content/CORE/CORETutorials/Services/ConfiguringSNMP.md deleted file mode 100644 index 3f6d3c0a74..0000000000 --- a/content/CORE/CORETutorials/Services/ConfiguringSNMP.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Configuring SNMP" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/configuringsnmp/" -description: "Provides information on how to configure Simple Network Management Protocol (SNMP) on your TrueNAS." -weight: 120 -aliases: /core/services/snmp/ -tags: -- snmp ---- - -[SNMP (Simple Network Management Protocol)](https://tools.ietf.org/html/rfc1157) monitors network-attached devices for conditions that warrant administrative attention. -TrueNAS uses [Net-SNMP](https://sourceforge.net/projects/net-snmp/) to provide SNMP. -To configure SNMP, go to the **Services** page, find the **SNMP** entry, and click the . - -![ServicesSNMPScreen](/images/CORE/Services/ServicesSNMPScreen.png "SNMP Service Options") - -See [SNMP screen]({{< relref "/CORE/UIReference/Services/SNMPScreen.md" >}}) for information on settings. - -After starting the SNMP service, port **UDP 161** listens for SNMP requests. - -## Checking the Management Information Bases (MIBs) Directory - -Locate available Management Information Bases (MIBs). Go to /usr/local/share/snmp/mibs. This directory contains many files routinely added or removed from the directory. Check the directory on your system. Open the shell and enter command `ls /usr/local/share/snmp/mibs`. -Here is a sample of the directory contents: - -![ServicesSNMPMibSample](/images/CORE/Services/ServicesSNMPMibSample.png "Services SNMP Mib Sample") diff --git a/content/CORE/CORETutorials/Services/ConfiguringSSH.md b/content/CORE/CORETutorials/Services/ConfiguringSSH.md deleted file mode 100644 index 0ecc4d3a37..0000000000 --- a/content/CORE/CORETutorials/Services/ConfiguringSSH.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "Configuring SSH" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/configuringssh/" -description: "Provides instructions on configuring Secure Shell (SSH) on your TrueNAS." -weight: 130 -tags: -- sftp -- ssh ---- - -The SSH service allows connections to TrueNAS with the [Secure Shell Transport Layer Protocol](https://tools.ietf.org/html/rfc4253). -To use TrueNAS as an SSH server, the users in the network must use [SSH client software](https://www.bing.com/search?q=SSH%20client%20software) to transfer files with SSH. - -{{< hint type=warning >}} -Allowing external connections to TrueNAS is a security vulnerability! -Only enable SSH when there is a need for external connections. -See [Security Recommendations]({{< relref "Security.md" >}}) for more security considerations when using SSH. -{{< /hint>}} - -## Service Configuration - -To configure SSH, disable the service and click the . - -![ServicesSSHOptions](/images/CORE/Services/ServicesSSHOptions.png "SSH Options") - -Configure the options as needed to match your network environment. - -See [SSH Screen]({{< relref "/CORE/UIReference/Services/ServicesSSH.md" >}}) - -{{< hint type=warning >}} -Root access to the system from a remote client is never recommended. -If an unavoidable critical situation requires allowing root access, it is recommended to [configure two-factor authentication]({{< relref "UsingTwoFactorAuthentication.md" >}}) first. -Also, disable root logins as soon as possible. -{{< /hint>}} - -Re-enable the SSH service on the **Services** page when all configuration changes are complete. -To create and store specific [SSH connections and keypairs]({{< relref "ConfiguringSSHConnections.md" >}}), go to the **System** menu section. - -{{< expand "Advanced: Restricting Command Line Users to scp or sftp" "v" >}} -This only works for users that use command line versions of commands `scp` and `sftp`. -With SSH configured, authenticated users with a user account can use `ssh` to log into the TrueNAS system over the network. -Create user accounts by going to **Accounts > Users** and clicking **ADD**. - -By default, the user sees their home directory after logging in with SSH. -The user can still find system locations outside their home directory. Take security precautions before granting users SSH access to the system. -One method to increase security is to change shell for a user to only allow file transfers. -Users can still use commands `scp` and `sftp` to transfer files between their local computer and their home directory. But the TrueNAS system restricts them from logging into the system using `ssh`. - -To configure this scenario, go to **Accounts > Users** and edit the desired user account. -Change the **Shell** to **scponly**. -Repeat for each user that needs restricted SSH access. - -![Accounts Users Edit Shell Scp only](/images/CORE/Accounts/AccountsUsersEditShellScponly.png "Accounts Users Edit Shell Scp only") - -Test the configuration from another system. Run the `sftp`, `ssh`, and `scp` commands as that user account. -`sftp` and `scp` work but `ssh` fails. -{{< /expand >}} diff --git a/content/CORE/CORETutorials/Services/ConfiguringTFTP.md b/content/CORE/CORETutorials/Services/ConfiguringTFTP.md deleted file mode 100644 index ebcf841196..0000000000 --- a/content/CORE/CORETutorials/Services/ConfiguringTFTP.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Configuring TFTP" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/configuringtftp/" -description: "Configuring Trivial File Transfer Protocol (TFTP) on your TrueNAS." -weight: 140 -tags: -- ftp -- tftp -- sftp ---- - -## Setting Up TFTP - -The Trivial File Transfer Protocol (TFTP) is a light-weight version of FTP. It is often used in a local environment. It can transfer configuration or boot files between machines, such as routers. -TFTP offers a very limited set of commands and provides no authentication. - -Determine the usage requirements for the TrueNAS system. If they are minimal, configure TFTP. For example, if the TrueNAS system is only used for storing images. Or if it is only used to store configuration files for network devices. - -If the system has minimal usage requirements, start the service. Starting the TFTP service opens UDP port **69**. - -![ServicesTFTPOptions](/images/CORE/Services/ServicesTFTPOptions.png "TFTP Service Options") - -Use the **TFTP** screen to configure the system for SFTP. diff --git a/content/CORE/CORETutorials/Services/FTPTFTP.md b/content/CORE/CORETutorials/Services/FTPTFTP.md deleted file mode 100644 index 8b3c6f89a1..0000000000 --- a/content/CORE/CORETutorials/Services/FTPTFTP.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "FTP, SFTP, and TFTP" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/ftptftp/" -description: "Configuring FTP, SFTP and TFTP on your TrueNAS." -weight: 160 -aliases: /core/services/ftptftp/ -tags: -- ftp -- tftp -- sftp -- ssh ---- - -The [File Transfer Protocol (FTP)](https://tools.ietf.org/html/rfc959) is a simple option for data transfers. -The additional SSH options provide secure config file transfer methods. Trivial FTP options provide only simple config file transfer methods. - -Options for configuring **FTP**, **SSH**, and **TFTP** are in the system **Services**. -Click the to configure the related service. diff --git a/content/CORE/CORETutorials/Services/S3forMinIO.md b/content/CORE/CORETutorials/Services/S3forMinIO.md deleted file mode 100644 index dfd2381958..0000000000 --- a/content/CORE/CORETutorials/Services/S3forMinIO.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: "S3 for MinIO" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/s3forminio/" -description: "Provides information on how to configure S3 for MinIO on your TrueNAS." -weight: 105 -tags: -- s3 ---- - -{{< include file="/static/includes/S3Deprecation.md" >}} - -MinIO connections and service is configured using the **Services** [S3 screen]({{< relref "/CORE/UIReference/Services/S3Screen.md" >}}). - -{{< hint type=important >}} -MinIO deprecated Access key and Secret key. MinIO now utilizes MINIO_ROOT USER and MINIO_ROOT_PASSWORD arguments and their values. For the ROOT_USER value, use a name up to 20 characters. For the ROOT_PASSWORD, use a string of 8 to 40 randomized characters. MinIO recommends using a long password string of unique random characters. -{{< /hint >}} - -## Testing Minio Connections - -To test access to the MinIO Browser, select **Enable Browser**. Open a web browser and type the TrueNAS IP address with the TCP port. Example: *https://192.168.0.3:9000*. Allow the port specified in **Port** through the network firewall. This permits bucket creation and file uploads. - -## MinIO Connection Methods - -Different methods are used for connecting to and using MinIO: - -{{< expand "s3cmd" >}} - -Linux or macOS users must have the [s3cmd](https://s3tools.org/s3cmd) service installed before beginning this setup. -On Windows, users can also refer to [S3Express](https://www.s3express.com/) for a similar command line experience. - -{{< hint type=tip >}} -The `s3cmd --configure` command is available for Ubuntu or other Linux distributions. Using this command you can configure important settings step by step. -{{< /hint >}} - -Enter the specified access key and the secret key. -Under the **S3 Endpoint**, enter the TrueNAS IP address followed by TCP port, and reply **N** to the DNS-style bucket+hostname. - -Save the file. -On Linux, the default is in the home directory \~/.s3cfg. - -If the connection has any issues, open .s3cfg again to troubleshoot. -In Ubuntu, use command `nano .s3cfg` or `vi .s3cfg` or `gedit .s3cfg` depending on the preferred text editor. -For other operating systems, .s3cfg file location and editing tools may vary. - -Scroll down to the host_bucket area. Make sure the %(bucket)s. portion is removed. The IP address should point to the *IP_address:TCP_port* for the system. - -**Correct Example** -``` -host_base = `192.168.123.207:9000` -host_bucket = `192.168.123.207:9000` -``` - -**Incorrect Example** -``` -host_base = `192.168.123.207` -host_bucket = `%(bucket)s.192.168.123.207` -``` - -Poll the buckets using command `s3cmd ls` to see the buckets created with the MinIO Browser. - -For more information on using MinIO with command `s3cmd`, see https://docs.minio.io/docs/s3cmd-with-minio.html and https://s3tools.org/s3cmd. -{{< /expand >}} - -{{< expand "S3 Browser (Windows)" >}} -On Windows PCs, the S3 Browser is another convenient way to connect to the MinIO S3 on a TrueNAS system. - -To set it up, first [install the S3 Browser](https://s3-browser.en.uptodown.com/windows). - -After installation completes, add a new account. - -![AmazonS3NewAccount](/images/CORE/AmazonS3NewAccount.png "S3 Browser: New Account") - -In the S3 Browser settings, select **S3 Compatible Storage** as the **Account Type**. Enter the MinIO access point. Example: (TrueNAS_IP_address:9000 or other port). -Select the SSL settings appropriate for the particular setup. -The default assumes SSL in S3 Browser, but for a LAN attached session, this may or may not already be set. - -![AmazonS3EditAccount](/images/CORE/AmazonS3EditAccount.png) - -It is possible to access, create new buckets, or upload files to created buckets. - -![AmazonS3Browser](/images/CORE/AmazonS3Browser.png "S3 Browser") -{{< /expand >}} diff --git a/content/CORE/CORETutorials/Services/_index.md b/content/CORE/CORETutorials/Services/_index.md deleted file mode 100644 index f9c0df5efd..0000000000 --- a/content/CORE/CORETutorials/Services/_index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Services" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/services/" -description: "Provides information on the Services screen and lists other service tutorial articles." -geekdocCollapseSection: true -weight: 120 -related: false ---- - - -{{< include file="/static/includes/COREServices.md" >}} - -Services related to data sharing or automated tasks are documented in their respective [Sharing]({{< relref "/CORE/CORETutorials/Sharing/_index.md" >}}) or [Tasks]({{< relref "/CORE/CORETutorials/Tasks/_index.md" >}}). - -
- -## Services Articles - -{{< children depth="2" sort="Name" description="true" >}} - -
diff --git a/content/CORE/CORETutorials/SettingUIPreferences.md b/content/CORE/CORETutorials/SettingUIPreferences.md deleted file mode 100644 index bb427da475..0000000000 --- a/content/CORE/CORETutorials/SettingUIPreferences.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Setting UI Preferences -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/settinguipreferences/" -description: "Use the Interface Preferences screen to display a list of general preferences or to change preference settings for your TrueNAS." -weight: 1000 -tags: -- ui ---- - -{{< include file="/static/includes/COREUIPreferencesIntro.md" >}} - -## Tuning the Visibility of UI Elements. - -Click the **Choose Theme** dropdown list to change the color appearance of the web interface. Select from a range of prebuilt or custom created themes. -The **High Contrast** option offers the most visibility. - -Select **Prefer buttons with icons only** when working with limited screen space. This displays icons and tooltips without text labels. - -For increased security, clear the **Enable Password Toggle** checkbox. -This removes all the icons next to password fields. It prevents the actual password characters from being visible. - -## Creating a Custom Theme - -To create a custom theme, click **CREATE NEW THEME**. - -![Preferences Custom Theme](/images/CORE/Settings/PreferencesCustomTheme.png "Custom UI Theme") - -1. Click **Load colors from existing theme** to change colors within an existing theme. Select an existing theme from the dropdown list to import into the configuration. This is useful when you have a theme you like but want to change a few colors within it. -2. Click the **COLORS** tab to define the color values for this new theme. - Define color choices as either RGBA or hexadecimal values. Or click a color swatch to open a visual color picker. -3. Define color selections in the **COLORS** tab. These selections determine the options available on the **GENERAL** tab. -4. Color selections display in the **Preview**. The **Preview** updates to reflect your current choices. You can turn this feature off. Click the **PREVIEW** tab then click the **Global Preview** toggle. This allows you to compare these selections with the currently active theme. -5. Go to the **GENERAL** tab and choose the primary, accent, and topbar colors for the theme. The color selections you made in the **COLORS** tab determine the options shown here. -6. Name and label the theme. Click **SUBMIT** to save it and add it to the options on the **Preferences** page. diff --git a/content/CORE/CORETutorials/SettingUpUsersAndGroups.md b/content/CORE/CORETutorials/SettingUpUsersAndGroups.md deleted file mode 100644 index 6b9781dd33..0000000000 --- a/content/CORE/CORETutorials/SettingUpUsersAndGroups.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: "Setting Up Users and Groups" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/settingupusersandgroups/" -description: "Describes how to set up users and groups in TrueNAS CORE." -weight: 19 -aliases: - - /core/accounts/users - - /core/accounts/groups -tags: -- users -- groups -- accounts ---- - -Creating users and assigning them to groups allows you to efficiently tune permissions and share data for large numbers of users. - -{{< hint type=note >}} -Only the root user account can log in to the TrueNAS web interface. -{{< /hint >}} - -When the network uses a directory service, import the existing account information using the instructions in [Directory Services](https://www.truenas.com/docs/core/coretutorials/directoryservices/). -Using [Active Directory]({{< relref "/CORE/CORETutorials/DirectoryServices/ActiveDirectory.md" >}}) requires setting Windows user passwords inside Windows. - -To see user accounts, go to **Accounts > Users**. - -![AccountsUsersList](/images/CORE/Accounts/AccountsUsersList.png "List of User Accounts") - -TrueNAS hides all built-in users by default. To see all built-in users, click and **SHOW**. - -## Add a User - -Go to **Accounts > Users** and click **ADD**. - -![Accounts Users Add](/images/CORE/Accounts/AccountsUsersAdd.png "Accounts Users Add") - -{{< include file="/static/includes/CORERequiredFields.md" >}} - -TrueNAS subdivides account options into groups of similar options. - -### Identification - -Enter a **Full Name**. -TrueNAS suggests a simplified **Username** from the **Full Name**, but you override it with your own choice. - -You can associate an **Email** address with a user account. - -Set and confirm the user password. - -### User ID and Groups - -Next, you must set a user ID. -TrueNAS automatically suggests the user ID starting at *1000*, but you can change it. -We recommend using an ID of *1000* or more for non-built-in users. - -By default, TrueNAS creates a new primary group with the same name as the user. -To add the user to an existing primary group instead, unset **New Primary Group** and select a group from the **Primary Group** drop-down. -You can add the user to more groups using the **Auxiliary Groups** drop-down. - -### Directories and Permissions - -When creating a user, TrueNAS sets the home directory path to /nonexistent, which does not create a user home directory. -To set a home directory, select a path using the file browser. -If the directory exists and matches the user name, it sets as the user home directory. -When the path does not end with a subdirectory matching the user name, TrueNAS creates a new subdirectory. -The full path to the user home directory displays here when editing a user. - -Directly under the file browser, you can set the home directory permissions. -TrueNAS default user accounts cannot change their permissions. - -### Authentication - -You can assign a public SSH key to a user for key-based authentication by pasting the public key into the **SSH Public Key** field. -If you are using an SSH public key, always keep a backup. -Click **DOWNLOAD SSH PUBLIC KEY** to download the pasted key as a .txt file. - -When **Disable Password** is *Yes*, the **Password** field is unavailable. -The system removes the existing password from the account and disables the **Lock User** and **Permit Sudo** options. -The account can't use password-based logins for services. -For example, disabling the password prevents using account credentials to log in to an SMB share or open an SSH session on the system. -By default, **Disable Password** is *No*. - -You can set a specific [shell]({{< relref "ChangingDefaultShell.md" >}}) for the user from the **Shell** dropdown: - -{{< expand "Shell Options" "v" >}} -{{< include file="archive/COREshellOptions.md" >}} -{{< /expand >}} - -Setting **Lock User** disables all password-based functionality for the account until you unset the option. - -**Permit Sudo** allows the account to act as the system administrator using the `sudo` command. -For better security, leave this option disabled. - -If the user account is accessing TrueNAS data using a Windows 8 or newer client, set **Microsoft Account** to enable additional authentication methods available from those operating systems. - -By default, **Samba Authentication** is enabled. -It allows users to access [SMB]({{< relref "/CORE/CORETutorials/Sharing/SMB/_index.md" >}}) share data using account credentials. - -## Groups - -Using groups in TrueNAS is an efficient way to manage permissions for many similar user accounts. -The interface lets you manage UNIX-style groups. -If the network uses a directory service, import the existing account information using the instructions in [Active Directory]({{< relref "/CORE/CORETutorials/DirectoryServices/ActiveDirectory.md" >}}). - -### View Existing Groups - -To see saved groups, go to **Accounts > Groups** - -![AccountsGroupsList](/images/CORE/Accounts/AccountsGroupsList.png "Accounts Groups List") - -By default, TrueNAS hides built-in groups. -To see built-in groups, click and **SHOW**. - -### Add a Group - -Go to **Accounts > Groups** and click **ADD**. - -![AccountsGroupsAdd](/images/CORE/Accounts/AccountsGroupsAdd.png "Accounts Groups Add") - -Each group gets a Group ID (**GID**). -Enter a number above *1000* for a group with user accounts. -You cannot change the GID later. -Groups used by a system service must have an ID that matches the default port number used by the service. - -Next, enter a descriptive group **Name**. -Group names cannot begin with a hyphen (-) or contain a space, tab, or these characters: , : + & # % ^ ( ) ! @ ~ * ? < > =. - -By default, the **Permit Sudo** option is unset. -Setting it allows group members to act as the root account by using [sudo](https://www.sudo.ws/). -Leave **Permit Sudo** unset for better security. - -**Samba Authentication** is set by default. -It allows group members to use [SMB]({{< relref "/CORE/CORETutorials/Sharing/SMB/_index.md" >}}) permissions and authentication. - -Finally, **Allow Duplicate GIDs** lets you duplicate group IDs but can complicate system configurations. -We recommend leaving it unset. - -### Group Member Management - -Register user accounts to a group to simplify permissions and access to many user accounts. -To manage group membership, go to **Accounts > Groups**, click the for a group, then click **MEMBERS**: - -![AccountsGroupsMembers](/images/CORE/Accounts/AccountsGroupsMembers.png "Managing Group Members") - -To add user accounts to the group, select them in **All users** and click . -Select multiple users by holding CTRL while clicking each entry. diff --git a/content/CORE/CORETutorials/Sharing/AFPShare.md b/content/CORE/CORETutorials/Sharing/AFPShare.md deleted file mode 100644 index 116e80126e..0000000000 --- a/content/CORE/CORETutorials/Sharing/AFPShare.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "AFP Share Creation" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/sharing/afpshare/" -description: "Provides information on how to create Apple Filing Protocol (AFP) shares on your TrueNAS." -weight: 10 -aliases: - - /core/sharing/afp/afpshare/ - - /core/coretutorials/sharing/afp/afpshare/ -tags: -- afp ---- - -The Apple Filing Protocol (AFP) is a network protocol that allows file sharing over a network. -It is like SMB and NFS, but it is for Apple systems. - -{{< hint type=important >}} -Apple began using the SMB sharing protocol as the default option for file sharing in 2013. At that time Apple ceased development of the AFP sharing protocol. The recommendation is to use SMB sharing instead of AFP. AFP sharing is still used if files are being shared with legacy Apple products. Please see https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/APFS_Guide/FAQ/FAQ.html -{{< /hint >}} - -To create a new share, make sure a dataset is available with all the data for sharing. - -## AFP Share Configuration - -To configure the new share, go to **Sharing > Apple Shares (AFP)** and click **ADD**. -Because AFP sharing is deprecated, confirm that you intend to create an AFP share. -Next, use the file browser to select a dataset to share and enter a descriptive name for the share in **Name**. - -Select **Time Machine** if the share is to have Apple Time Machine backups. -This advertises the share to other Mac systems as a disk that stores Time Machine backups. -Having multiple AFP shares configured for Time Machine backups is not recommended. - -Select **Use as Home Share** to create home directories for users that connect to the share. -Only one AFP share can be a home share. - -The AFP share is enabled by default. -To create the share but not immediately enable it, clear **Enabled**. -Clicking **SUBMIT** creates the share. - -![Sharing AFP Add](/images/CORE/Sharing/SharingAFPAdd.png "Sharing AFP Add") - -See [Sharing AFP screen]({{< relref "AFPShareScreen.md" >}}) for more information on screen settings. - -To edit an existing AFP share, go to **Sharing > Apple Shares (AFP)** and click . - -## Start or Stop AFP Service - -To begin advertising the AFP shared location, go to **Services**. To determine the current state of the AFP service, hover the mouse over the toggle. The toggle turns blue when it is running. Click the AFP toggle to start the service if it is not running, or to stop the service if it is already running. -To automatically start the service after TrueNAS boots, select **Start Automatically**. - -### Changing AFP Service settings - -If the AFP service is running, stop it before attempting to edit settings. - -It is recommended to use the default settings for the AFP service. -To adjust the service settings, click the icon. - -![Services AFP Edit](/images/CORE/Services/ServicesAFPEdit.png "Services AFP Edit") - -See [Adding AFP Service]({{< relref "/CORE/UIReference/Services/AFPScreen.md" >}}) for more information on AFP service settings. - -## Connecting to the AFP Share - -Use an Apple operating system to connect to the share. -Open the **Finder** app on the Mac and click **Go > Connect to Server...** in the top menu bar on the Mac. -Enter `afp://{IPofTrueNASsystem}` and click **Connect**. -For example, entering `afp://192.168.2.2` connects to the TrueNAS AFP share at 192.168.2.2. - -![Apple AFP Connect](/images/CORE/AppleAFPConnect.png "Apple AFP Connect") diff --git a/content/CORE/CORETutorials/Sharing/NFSShare.md b/content/CORE/CORETutorials/Sharing/NFSShare.md deleted file mode 100644 index 7f4053cf4e..0000000000 --- a/content/CORE/CORETutorials/Sharing/NFSShare.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "NFS Share Creation" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/sharing/nfsshare/" -description: "Provides information on how to create a Network File Share (NFS) on your TrueNAS." -weight: 30 -aliases: - - /hub/sharing/nfs/nfs-share/ - - /core/sharing/nfs/nfsshare/ - - /core/coretutorials/sharing/nfs/nfsshare/ -tags: -- nfs ---- - -Creating a Network File System (NFS) share on TrueNAS makes a lot of data available for anyone with share access. -Depending on the share configuration, it can restrict users to read or write privileges. - -{{< hint type=note >}} -NFS treats each dataset as its own file system. -When creating the NFS share on the server, the specified dataset is the location that client accesses. -If you choose a parent dataset as the NFS file share location, the client cannot access any nested or child datasets beneath the parent. - -If you need to create shares that include child datasets, SMB sharing is an option. -Note that Windows NFS Client versions currently support only NFSv2 and NFSv3. -{{< /hint >}} - -## Adding an NFS Share Dataset - -Before creating an NFS share, create the dataset you want the share to use for data storage. - -{{< include file="/static/includes/ShareDatasetsNotPools.md" >}} - -We recommend creating a new dataset with the **Share Type** set to **Generic** for the new NFS share. - -## Creating an NFS Share - -Go to **Sharing > Unix Shares (NFS)** and click **ADD**. - -{{< trueimage src="/images/CORE/Sharing/SharingNFSAdd.png" alt="Add NFS Share" id="Add NFS Share" >}} - -Use the file browser to select the dataset to share. -Enter an optional **Description** to help identify the share. -Clicking **SUBMIT** creates the share. -There is the option to select **ENABLE SERVICE** while creating the share to start the service. -With this option selected, the service starts automatically after any reboots. - -{{< trueimage src="/images/CORE/Sharing/SharingNFSAddServiceEnable.png" alt="Enable NFS Service" id="Enable NFS Service" >}} - -If you wish to create the share but not immediately enable it, select **CANCEL**. - -{{< trueimage src="/images/CORE/Sharing/SharingNFSAddServiceEnableSuccess.png" alt="NFS Enabled" id="NFS Enabled" >}} - -### NFS Share Settings - -See [Sharing NFS Screen]({{< relref "NFSShareScreen.md" >}}) for more information on NFS share settings. - -To edit an existing NFS share, go to **Sharing > Unix Shares (NFS)** and click **> Edit**. -The options available are identical to the share creation options. - -## Configure the NFS Service - -To begin sharing the data, go to **Services** and click the **NFS** toggle. -If you want NFS sharing to activate immediately after TrueNAS boots, set **Start Automatically**. - -NFS service settings can be configured by clicking (Configure). -See [NFS Screen]({{< relref "/CORE/UIReference/Services/NFSScreen.md" >}}) for details. - -Unless a specific setting is needed, we recommend using the default settings for the NFS service. -When TrueNAS is already connected to [Active Directory]({{< relref "/CORE/CORETutorials/DirectoryServices/ActiveDirectory.md" >}}), setting **NFSv4** and **Require Kerberos for NFSv4** also requires a [kerberos keytab]({{< relref "/CORE/CORETutorials/DirectoryServices/Kerberos.md" >}}). - -## Connecting to the NFS Share with a Linux/Unix OS - -The NFS share connects with various operating systems. -The recommendation is to use a Linux/Unix operating system. -Using a Linux/Unix operating system, download the `nfs-common` kernel module. -Do this using the package manager of the installed distribution. -For example, on Ubuntu/Debian, enter `sudo apt-get install nfs-common` in the terminal. - -After installing the module, connect to an NFS share by entering `sudo mount -t nfs {IPaddressOfTrueNASsystem}:{path/to/nfsShare} {localMountPoint}`, where *{IPaddressOfTrueNASsystem}* is the IP address of the remote TrueNAS system that contains the NFS share, *{path/to/nfsShare}* is the path to the NFS share on the TrueNAS system, and *{localMountPoint}* is a local directory on the host system configured for the mounted NFS share. -For example, `sudo mount -t nfs 10.239.15.110:/mnt/pool1/photoDataset /mnt` mounts the NFS share *photoDataset* to the local directory `/mnt`. - -By default, anyone that connects to the NFS share only has the read permission. -To change the default permissions, edit the share. -Go to **Advanced Options** and change the **Access** settings. - -{{< hint type=important >}} -ESXI 6.7 or later is required for read/write functionality with NFSv4 shares. -{{< /hint >}} diff --git a/content/CORE/CORETutorials/Sharing/SMB/HomeShare.md b/content/CORE/CORETutorials/Sharing/SMB/HomeShare.md deleted file mode 100644 index 763b3d0563..0000000000 --- a/content/CORE/CORETutorials/Sharing/SMB/HomeShare.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: "Home Shares" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/sharing/smb/homeshare/" -description: "Describes how to configure a Home Share on TrueNAS CORE." -weight: 20 -aliases: /core/sharing/smb/homeshare/ -tags: -- smb ---- - -TrueNAS offers the **Use as Home Share** option for organizations or SMEs that want to use a single SMB share to provide a personal directory to every user account. - -{{< hint type=important >}} -The **Use as Home Share** feature is available for a single TrueNAS SMB share. You can create additional SMB shares as described in the [SMB sharing article]({{< relref "/CORE/GettingStarted/SharingStorage.md" >}}) but without the **Use as Home Share** option enabled. -{{< /hint >}} - -## Create a Pool and Join Active Directory - -First, go to **Storage > Pools** and [create a pool]({{< relref "/CORE/CORETutorials/Storage/Pools/_index.md" >}}). - -Next, [set up the Active Directory]({{< relref "/CORE/CORETutorials/DirectoryServices/ActiveDirectory.md" >}}) that you want to share resources with over your network. - -## Prepare a Dataset - -Go to **Storage > Pools** and open the next to the root dataset in the pool you just created, then click **Add Dataset**. - -Name the dataset (this article uses *Home_Share_Dataset* as an example) and set the **Share Type** to **SMB**. - -![StoragePoolsOptionsDatasetCreateOurhome](/images/CORE/Storage/StoragePoolsOptionsDatasetCreateOurhome.png "Creating the SMB Dataset") - -After creating the dataset, go to **Storage > Pools** and open next to the new dataset. Select **Edit Permissions**. - -Click the **Group** dropdown menu and change the owning group to your Active Directory domain admins and check **Apply Group**. - -![GroupDomainAdmins](/images/CORE/Storage/GroupDomainAdmins.png "Set the owning group to Domain Admins") - -Click **Select an ACL Preset** and choose **HOME**. Then, click **SAVE**. - -![StoragePoolsOptionsEditPermissionsACLPresetHome](/images/CORE/Storage/StoragePoolsOptionsEditPermissionsACLPresetHome.png "Set the Home ACL Preset") - -## Create the Share - -Go to **Sharing > Windows Shares (SMB)** and click **ADD**. - -Set the **Path** to the prepared dataset (*Home_Share_Dataset* for example). - -The **Name** automatically changes to be identical to the dataset. Leave this at the default. - -Set the **Purpose** to **No presets**, then click **ADVANCED OPTIONS** and check **Use as Home Share**. Click **SUBMIT**. - -![SharingSMBAddHomeShareExample](/images/CORE/Sharing/SharingSMBAddHomeShareExample.png "Example Home Share") - -The ACL editor opens, displaying the home ACL preset values. - -![HomeShareACLEditor](/images/CORE/Storage/HomeShareACLEditor.png "Home Share ACL Editor") - -Click **SAVE**. Enable the **SMB** service in **Services** to make the share available on your network. - -## Add Users - -Go to **Accounts > Users** and click **ADD**. Create a new user name and password. By default, the user **Home Directory** is titled from the user account name and added as a new subdirectory of *Home_Share_Dataset*. - -![AccountsUsersEditHomeDir](/images/CORE/Accounts/AccountsUsersEditHomeDir.png "Editing a User's Home Directory") - -If existing users require access to the home share, go to **Accounts > 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. - -After the user accounts have been added and permissions configured, users can log in to the share and see a folder matching their user name. diff --git a/content/CORE/CORETutorials/Sharing/SMB/ManagingSMBShares.md b/content/CORE/CORETutorials/Sharing/SMB/ManagingSMBShares.md deleted file mode 100644 index 1a41591ef6..0000000000 --- a/content/CORE/CORETutorials/Sharing/SMB/ManagingSMBShares.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "Managing SMB Shares" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/sharing/smb/managingsmbshares/" -description: "Provides information on how to manage Server Message Block (SMB) shares on your TrueNAS." -weight: 10 -tags: -- smb ---- - -## Share Management - -After creating the SMB share, additional management options are available by going to **Sharing > Windows Shares (SMB)** and clicking for a share entry: - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Edit** | Opens the [share creation screen]({{< relref "/CORE/CORETutorials/Sharing/SMB/_index.md" >}}) to reconfigure the share or disable it. | -| **Edit Share ACL** | Opens a screen to configure an Access Control List (ACL) for the share. The default is open. | -{{< /truetable >}} - -**Edit Share ACL** -* This is separate from file system permissions, and applies at the level of the entire SMB share. -* Permissions defined here are not interpreted by clients of other file sharing protocols. -* Permissions defined here are not interpreted by other SMB shares. Even if the other SMB shares export the same share **Path** value. -* Enabling **Access Based Share Enumeration** uses this ACL to determine the browse list. - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Edit Filesystem ACL**| Opens a screen to configure an Access Control List (ACL) for the path defined in the share **Path**. | -| **Delete** | Remove the share configuration from TrueNAS. Shared data is unaffected. | -{{< /truetable >}} - -## Configure Share ACL - -To see the share ACL options, click > **Edit Share ACL**. - -![EditShareACL](/images/CORE/Sharing/SharingSMBShareACL.png "Share ACL Options")> - -The **Share Name** is shown, but cannot be changed. -**ACL Entries** are listed as a block of settings. -Click **ADD** to register a new entry. - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **SID** | Who this ACL entry (ACE) applies to, shown as a [Windows Security Identifier](https://docs.microsoft.com/en-us/windows/win32/secauthz/security-identifiers). Either a **SID** or a **Domain** with **Name** is required for the ACL. | -| **Domain** | Enter a domain for the user **Name**. Required when a **SID** is not entered. Local users have the SMB server NetBIOS name: *truenas\\smbusers*. | -| **Permission** | Dropdown list of predefined permission combinations:
Select **Read** for read access and execute permission on the object (RX).
Select **Change** for read access, execute permission, write access, and delete object (RXWD).
Select **Full** for read access, execute permission, write access, delete object, change Permissions, and take ownership (RXWDPO).

For more details, see [smbacls(1)](https://www.samba.org/samba/docs/current/man-html/smbcacls.1.html). | -| **Name** | Enter the name of who this ACL entry applies to, shown as a user name. Requires adding the user **Domain**. | -| **Type** | Select from the dropdown list how permissions are applied to the share. Select **Allowed** to deny all permissions by default except those that are manually defined. Select **Denied** to allow all permissions by default except those that are manually defined. | -{{< /truetable >}} - -Click **SAVE** to store the share ACL and apply it to the share immediately. - -## Configure File System ACL - -Click **> Edit Filesystem ACL** to quickly return to **Storage > Pools** and edit the dataset ACL. - -![DatasetACLEdit](/images/CORE/Storage/StoragePoolsEditACLOwner.png "Dataset Permissions Options") - -This ACL defines the user accounts or groups that own or have specific [permissions]({{< relref "/CORE/CORETutorials/Storage/Pools/Permissions.md" >}}) to the shared dataset. -The **User** and **Group** values show which accounts own, or have full permissions to the dataset. -Change the default settings to your preferred primary account and group. Select the **Apply** checkboxes before saving any changes. - -### ACL Presets - -To rewrite the current ACL with a standardized preset, click **SELECT AN ACL PRESET** and choose an option: - -#### Open -Has three entries: -* **owner@** has full dataset control. -* **group@** has full dataset control. -* All other accounts can modify the dataset contents. - -#### Restricted -Has two entries: -* **owner@** has full dataset control. -* **group@** can modify the dataset contents. - -#### Home -Has three entries: -* **owner@** has full dataset control. -* **group@** can modify the dataset contents. -* All other accounts can traverse through the dataset. - -### Adding ACL Entries (ACEs) - -To define permissions for a specific user account or group, click **ADD ACL ITEM**. -Open the **Who** dropdown list, select **User** or **Group**, and select a specific user or group account. -Define the settings for the account. Define the permissions to apply to that account. -For example, to allow the *tmoore* user permission to view dataset contents but not make changes, define the **ACL Type** as **Allow**. Define **Permissions** for this user as **Read**. - -![ExampleACE](/images/CORE/Storage/StoragePoolsEditACLExample.png "Sample ACE") diff --git a/content/CORE/CORETutorials/Sharing/SMB/ShadowCopies.md b/content/CORE/CORETutorials/Sharing/SMB/ShadowCopies.md deleted file mode 100644 index d3e8d13453..0000000000 --- a/content/CORE/CORETutorials/Sharing/SMB/ShadowCopies.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "Shadow Copies" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/sharing/smb/shadowcopies/" -description: "Describes how to configure shadow copies on TrueNAS CORE." -weight: 30 -aliases: /core/sharing/smb/shadowcopies/ -tags: -- smb ---- - -[Shadow Copies](https://docs.microsoft.com/en-us/windows-server/storage/file-server/volume-shadow-copy-service), also known as the Volume Shadow Copy Service (VSS) or Previous Versions, is a Microsoft service for creating volume snapshots. -Shadow copies can be used to restore previous versions of files from within Windows Explorer. - -By default, all ZFS snapshots for a dataset underlying an SMB share path are presented to SMB clients through the volume shadow copy service or are accessible directly with SMB when the hidden ZFS snapshot directory is located within the path of the SMB share. - -There are a few caveats about shadow copies to be aware of before activating the feature in TrueNAS: - -* When the Windows system is not fully patched to the latest service pack, Shadow Copies might not work. - If no previous versions of files to restore are visible, use Windows Update to ensure the system is fully up-to-date. - -* Shadow copy support only works for ZFS pools or datasets. - -* Appropriate permissions must be configured on the pool or dataset shared by SMB. - -* Users cannot use an SMB client to delete shadow copies. Instead, the administrator uses the TrueNAS web interface to remove snapshots. - Shadow copies can be disabled for an SMB share by clearing the checkmark from **Enable shadow copies** for the SMB share. - This does not prevent access to the hidden .zfs/snapshot directory for a ZFS dataset when the directory is located within the path for an SMB share. - -To enable Shadow Copies, go to **Sharing > Windows Shares (SMB)** and **Edit** an existing share. -Open the **Advanced Options**, find the **Other Options** and select **Enable Shadow Copies**. - -![SMBShadowCopy](/images/CORE/Sharing/SharingSMBAddAdvanced.png "Enabling Shadow Copies") - -{{< expand "Windows 10 v2004 Issue" "v" >}} -Some users have experienced issues in the Windows 10 v2004 release where network shares can't be accessed. The problem appears to come from a bug in gpedit.msc, the Local Group Policy Editor. Unfortunately, setting the **Allow insecure guest logon** flag value to **Enabled** in **Computer Configuration > Administrative Templates > Network > Lanman Workstation** appears to have no effect on the configuration. - -To work around this issue, edit the Windows registry. Use **Regedit** and go to **HKLM\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters**. -The **DWORD AllowInsecureGuestAuth** is an incorrect value: **0x00000000**. Change this value to **0x00000001** (Hexadecimal 1) to allow adjusting the settings in gpedit.msc. -You can apply this to a fleet of Windows machines with a Group Policy Update. -{{< /expand >}} diff --git a/content/CORE/CORETutorials/Sharing/SMB/_index.md b/content/CORE/CORETutorials/Sharing/SMB/_index.md deleted file mode 100644 index a442e87c8b..0000000000 --- a/content/CORE/CORETutorials/Sharing/SMB/_index.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -title: "Windows Shares (SMB)" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/sharing/smb/smbshare/" -description: "Tutorials for SMB sharing scenarios." -geekdocCollapseSection: true -weight: 50 -aliases: - - /hub/sharing/smb/smb-share/ - - /core/sharing/smb/smbshare/ - - /core/coretutorials/sharing/smb/smbshare/ -related: false -tags: -- smb ---- - -## SMB Background - -SMB (also known as CIFS) is the native file sharing system in Windows. -SMB shares can connect to any major operating system. This includes Windows, MacOS, and Linux. - -TrueNAS can use SMB to share files among one or many users or devices. -SMB supports a wide range of permissions and security settings. -SMB can support advanced permissions (ACLs) on Windows and other systems. -SMB also supports Windows Alternate Streams and Extended Metadata. -SMB is suitable for the management and administration of large or small pools of data. - -{{< hint type=important >}} -TrueNAS uses [Samba](https://www.samba.org/) to provide SMB services. -There are many versions of the SMB protocol. -During SMB session negotiation, an SMB client attempts to negotiate the highest SMB protocol. -Industry-wide, the usage of the SMB1 protocol (sometimes referred to as NT1) is [being deprecated]({{< relref "/CORE/CoreSecurityReports/SMB1Advisory.md" >}}) for security reasons. -However, most SMB clients support SMB 2 or 3 protocols, even when they are not the default protocols. -{{< /hint >}} - -{{< hint type=note >}} -Legacy SMB clients rely on NetBIOS name resolution to discover SMB servers on a network. -The NetBIOS name server (nmbd) is disabled by default in TrueNAS. -You can enable it in **Network > Global Configuration** if this functionality is required. - -MacOS clients use mDNS to discover the presence of SMB servers on the network. -The mDNS server (avahi) is enabled by default on TrueNAS. - -Windows clients use [WS-Discovery](https://docs.oasis-open.org/ws-dd/ns/discovery/2009/01) to discover the presence of SMB servers. -Check the version of the Windows client. -In some versions of the Windows client, the default settings disable network discovery. - -Discoverability through broadcast protocols is a convenience feature. -It is not required to access an SMB server. -{{< /hint >}} - -## First Steps - -1. Create a dataset. - - {{< include file="/static/includes/ShareDatasetsNotPools.md" >}} - - For the new SMB share, the recommendation is to create a new dataset and set the **Share Type** to **SMB**. - - Create the ZFS dataset with these settings: - - * **aclmode** = restricted - * **case sensitivity** = insensitive - - A default Access Control List is also applied to the dataset. - This default ACL is restrictive and only allows access to the dataset owner and group. - You can change this ACL later according to your use case. - -2. Create local user accounts. - - By default, all new local users are members of a built-in SMB group called **builtin users**. - You can use this group to grant access to all local users on the server. - You can use additional [groups]({{< relref "/CORE/CORETutorials/SettingUpUsersAndGroups.md" >}}) to fine-tune permissions to large numbers of users. - User accounts built-in to TrueNAS cannot access SMB. - User accounts that do not have the **smb** flag set cannot access SMB. - - As of 13.3, SMB user passwords can include the question mark (?). - - {{< expand "Why not just allow anonymous access to the share?" "v" >}} - Anonymous or guest access to the share is possible, but this is a security vulnerability. - Anonymous or guest access is being deprecated by the major SMB client vendors. - This partly because signing and encryption are not possible for guest sessions. - {{< /expand >}} - - {{< expand "What about LDAP users?" "v" >}} - {{< hint type=important >}} - Support for LDAP **Samba Schema** is deprecated in TrueNAS 13.0 or later. - Users with LDAP and SMB shares configured should begin to migrate legacy Samba domains to Active Directory. - {{< /hint >}} - - With LDAP configured, users from the LDAP server can have access the SMB share. - Go to **Directory Services > LDAP > ADVANCED MODE** and set **Samba Schema**. - Caution: local TrueNAS user accounts no longer have access to the share. - {{< /expand >}} - -3. Tune the dataset ACL. - - After creating a dataset and the needed accounts, determine the access requirements and adjust the dataset ACL to match. - To edit the ACL, go to **Storage > Pools**, open the options for the new dataset, and click **Edit Permissions**. - Many home users often add a new entry that grants this access: **FULL_CONTROL** to the **builtin_users** group with the flags set to **INHERIT**. - See the [Permissions article]({{< relref "/CORE/CORETutorials/Storage/Pools/Permissions.md" >}}) for more details. - -## Creating an SMB Share - -To create a Windows SMB share, go to **Sharing > Windows Shares (SMB)** and click **ADD**. - -{{< trueimage src="/images/CORE/Sharing/SharingSMBAdd.png" alt="Basic SMB Share Options" id="Basic SMB Share Options" >}} - -The **Path** and **Name** of the SMB share define the smallest amount of information required to create a new SMB share. -The **Path** is the directory tree on the local file system exported over the SMB protocol. -**Name** is the name of the SMB share. -This forms a part of the full share path name when SMB clients perform an SMB tree connect. -Enter a name that is less than or equal to 80 characters in length. -The name shoud not contain any invalid characters. -Microsoft documentation [MS-FSCC section 2.1.6](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-fscc/dc9978d7-6299-4c5a-a22d-a039cdc716ea) lists these invalid characters. -The last component of the value in **Path** becomes the share name if **Name** is blank or empty. - -You can set a share **Purpose** to apply and lock pre-defined advanced options for the share. -To keep full control over all the share **Advanced Options**, choose **No presets**. - -You can specify an optional value in **Description** to help explain the purpose of the share. - -**Enabled** shares this path when the SMB service is activated. -Clearing **Enabled** disables the share without deleting the configuration. - -See [SMB Share Screen]({{< relref "SMBShareScreen.md" >}}) for more information on SMB Share settings. - -## Activating the SMB Service - -Connecting to an SMB share does not work when the related system service is not activated. -To make an SMB share available on the network, go to **Services** and click the **SMB** toggle to start the service. -If you want the service to activate whenever TrueNAS boots, select **Start Automatically**. - -See [SMB Service Screen]({{< relref "/CORE/UIReference/Services/SMBScreen.md" >}}) for more information on SMB services settings. - -## Mounting an SMB Share on Another Machine - -{{< expand "Mount Commands" >}} -### Linux -Verify that the required CIFS packages are installed for your distribution of Linux. -Create a mount point. Enter `sudo mkdir /mnt/smb_share`. - -Mount the volume. Enter `sudo mount -t cifs //computer_name/share_name /mnt/smb_share`. - -If your share requires user credentials, add the switch `-o username=` with your username after `cifs` and before the share address. - -### Windows -To mount the SMB share to a drive letter on Windows, open the command line and enter the following command with the appropriate drive letter, computer name, and share name. - -```net use Z: \\computer_name\share_name /PERSISTENT:YES``` - -{{< hint type=tip title="Troubleshooting Tip" >}} -In case of Windows reporting an incorrect password, you might have to change your Windows security settings using **Local Security Policy > Local Policies > Security Options > Network security: LAN Manager authentication level > Send NTLMv2 response only**. -{{< /hint >}} - -### Apple -Open **Finder > Go > Connect To Server** -Enter the SMB address: `smb://192.168.1.111`. - -Input the username and password for the user assigned to that pool or guest if gGuest access is enabled on the share. - -### FreeBSD -Create a mount point. Enter `sudo mkdir /mnt/smb_share`. - -Mount the volume. Enter `sudo mount_smbfs -I computer_name\share_name /mnt/smb_share`. -{{< /expand >}} - -
- -## SMB Articles - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/CORETutorials/Sharing/WebDAVShare.md b/content/CORE/CORETutorials/Sharing/WebDAVShare.md deleted file mode 100644 index 1b11ef2d30..0000000000 --- a/content/CORE/CORETutorials/Sharing/WebDAVShare.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "WebDav Share Creation" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/sharing/webdavshare/" -description: "Contains information on how to create a Web-based Distributed Authoring and Versioning (WebDAV) share on your TrueNAS." -weight: 40 -aliases: - - /core/sharing/webdav/webdavshare/ - - /core/coretutorials/sharing/webdav/webdavshare/ -tags: -- webdav ---- - -TrueNAS supports (WebDAV), or Web-based Distributed Authoring and Versioning. WebDAV makes it easy to share a TrueNAS dataset and its contents over the web. - -To create a new share, make sure a dataset is available with all the data for sharing. - -## Share Configuration - -Go to **Sharing > WebDAV Shares** and click **ADD**. - -![SharingWebdavAdd](/images/CORE/Sharing/SharingWebdavAdd.png "Creating a WebDAV Share") - -Enter a name for the share in **Name** and use the file browser to select the dataset to share. -Enter an optional description for the share in **Description** to help identify it. -To prevent user accounts from modifying the shared data, select **Read Only**. - -{{< hint type=important >}} -The default selection is **Change User & Group Ownership**. -This changes existing ownership of all files in the share to the **webdav** user and group accounts. -The default selection simplifies WebDAV share permission. This unexpected change causes the web interface to display a warning: -{{< /hint >}} - -![Webdav Add Warning](/images/CORE/Sharing/SharingWebdavAddWarning.png "Services Webdav Add Warning") - -Clearing the checkbox labeled **Change User & Group Ownership** prevents the warning from displaying. You must manually set shared file ownership to the **webdav** or **www** user and group accounts in that case. - -By default, the new WebDAV share is immediately active. -To create the share but not immediately activate it, clear the checkmark in **Enable**. -Click **SUBMIT** to create the share. - -## Service Activation - -Creating a share immediately opens a dialog to activate the WebDAV service: - -![WebdavServiceEnable](/images/CORE/Sharing/SharingCreateServiceEnable.png "WebDAV Service Activation from Share") - -It is possible to enable or disable the WebDAV system service at a later time. Go to **Services** and click the **WebDAV** toggle to stop the service. To automatically start the service when TrueNAS boots, select **Start Automatically**. -Click the to change the service settings. - -![WebDAVServiceOptions](/images/CORE/Services/ServicesWebdavOptions.png "WebDAV Service Options") - -For better data security, select **HTTPS** as the **Protocol**. -This requires choosing an SSL certificate. The **freenas_default** certificate is available as an option. -All **Protocol** options require defining a **Port** number. -Verify that the WebDAV service port is not already in use on the network before defining a **Port** number. - -Select either **Basic** or **Digest** as the method of **HTTP Authentication**. Create a new **Webdav Password**. This prevents unauthorized access to the shared data. - -Click **SAVE** after making any changes. - -## Connecting to the WebDAV Share - -WebDAV shared data is accessible from a web browser. -To see the shared data, open a new browser tab and enter the following in the URL field `{PROTOCOL}://{TRUENASIP}:{PORT}/{SHAREPATH}` where the elements in curly brackets **{}** are your chosen settings from the WebDAV share and service. -Example: *https://10.2.1.1:8081/newdataset* - -When the **Authentication** WebDAV service option is configured to either **Basic** or **Digest**, a user name and password is required. -Enter the user name **webdav** and the password defined in the WebDAV service. diff --git a/content/CORE/CORETutorials/Sharing/_index.md b/content/CORE/CORETutorials/Sharing/_index.md deleted file mode 100644 index 9f2dd40f95..0000000000 --- a/content/CORE/CORETutorials/Sharing/_index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Sharing" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/sharing/" -description: "Tutorials for configuring different storage sharing protocols in TrueNAS." -geekdocCollapseSection: true -weight: 110 -related: false -aliases: - - /core/sharing/ ---- - -File sharing is a core benefit of a NAS. TrueNAS helps foster collaboration between users through network shares. -TrueNAS can use AFP, iSCSI shares, Unix NFS shares, Windows SMB shares, and WebDAV shares. - -
- -## Contents - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/CORETutorials/Sharing/iSCSI/AddingiSCSIShare.md b/content/CORE/CORETutorials/Sharing/iSCSI/AddingiSCSIShare.md deleted file mode 100644 index 79797a3105..0000000000 --- a/content/CORE/CORETutorials/Sharing/iSCSI/AddingiSCSIShare.md +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: "Adding an iSCSI Share" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/sharing/iscsi/addingiscsishare/" -description: "Describes how to add an iSCSI share on TrueNAS CORE." -weight: 10 -aliases: /core/sharing/iscsi/iscsishare/ -tags: -- iscsi -- iscsi ---- - -To get started, make sure you have created a [zvol]({{< relref "CORE/CORETutorials/Storage/Pools/ZVols.md" >}}) or a [dataset]({{< relref "CORE/CORETutorials/Storage/Pools/Datasets.md" >}}) with at least one file to share. - -Go to **Sharing > Block Shares (iSCSI)**. You can either set one up manually or use **WIZARD** to guide you through creation. - -## Wizard Setup Process - -![SharingISCSIWizardDevice](/images/CORE/Sharing/SharingISCSIWizardDevice.png "iSCSI Wizard: Block Device") - -On **Create or Choose Block Device**: - -1. Enter a name for the iSCSI share. It can only contain lowercase alphanumeric characters plus a dot (.), dash (-), or colon (:). We recommend keeping the name short or at most 63 characters. - -2. Choose the **Extent Type**. - - * If the **Extent Type** is **Device**, select the Zvol to share from the **Device** menu. - - * If the **Extent Type** is **File**, select the path to the extent and indicate the file size. - -3. Select the type of platform to use for the share. For example, if using the share from an updated Linux OS, choose **Modern OS**. - -4. Click **Next**. The **Portals** screen displays. - -5. Select an existing portal or click **Create New** to add a portal. - - If you create a new portal, you must select a discovery authentication method. - - a. Select either **CHAP** or **MUTUAL CHAP** in the **Discovery Authentication Method** field. - - b. Select either **None** or **Create New** in the **Discovery Authentication Group** field. **Create New** displays additional configuration fields. - If you select **None** you can leave **Discovery Authentication Group** empty. - - c. Enter a number in the **Group ID** field to identify the group. - - d. Enter the user name in the **User** field. This can be the same as the initiator. - - e. Enter a password of 12 to 16 characters in the **Secret** field and again in **Secret (Confirm)**. - - f. Select the IP address(es) to use. If adding more than one IP address, click **ADD** and then select the IP address. - Use **0.0.0.0.** to listen on all IPv4 or **::** to listen on all IPv6 IP addresses. - - G. Select the TCP port number to use if different from the default. - - H. Click Next to display the **Initiator** screen. - -6. Enter the initiator information to use. Decide which initiators or networks can use the iSCSI share. Leave the list empty to allow all initiators or networks, or add entries to the list to limit access to those systems. Use the keyboard Enter between each entry. Click **Next** to display the **Confirm Options** screen. - -7. Confirm the settings you entered. To change any setting click **BACK** until you see the screen where you want to make changes. - -8. Click **SUBMIT** to save the iSCSI block share. - -## Manual Setup Process - -To add or edit an existing iSCSI share, use the seven tab to access the various iSCSI configuration screens. - -1. Configure the share global configuration settings. Click the **Target Global Configuration** tab. - - ![SharingISCSIManualTargetGlobalConfig](/images/CORE/Sharing/SharingISCSIManualTargetGlobalConfig.png "iSCSI Target Global Configuration") - -2. Configure the portal settings. Click on the **Portals** tab. - - ![SharingISCSIManualPortals](/images/CORE/Sharing/SharingISCSIManualPortals.png "iSCSI Portal") - - To add a new portal, click **ADD** and enter the basic and IP address information. - - To edit an existing portal, click next to the portal and select **Edit**. - - ![SharingISCSIManualPortalsForm](/images/CORE/Sharing/SharingISCSIManualPortalsForm.png "iSCSI Portals Form") - -3. Configure the initiator settings (not required). Click on the **Initiators Groups** tab. Both the **Add** and **Edit** forms have the same settings fields. - - ![iSCSIAddInitiators](/images/CORE/Sharing/iSCSIAddInitiators.png "iSCSI Add Initiators") - - Use **ADD** to display the **Initiators Add** configuration screen. - Either leave **Allow All Initiators** checked or configure your own allowed initiators and authorized networks. - - Click the icon for the initiator group and select **Edit** to display the **Initiator Group Edit** configuration screen. - -4. Configure authorized access networks. Click the **Authorized Access** tab. - - ![SharingISCSIManualAuthorizedAccessForm](/images/CORE/Sharing/SharingISCSIManualAuthorizedAccessForm.png "iSCSI Authorized Access Form") - - Click **ADD** to add a new authorized access network. Fill out the group, user and peer user information. - - Click next to the authorized access network and select **Edit**. - -5. Configure targets. Click the **Targets** tab. - - ![SharingISCSIManualTargetsForm](/images/CORE/Sharing/SharingISCSIManualTargetsForm.png "iSCSI Targets Form") - - To add a new target, click **ADD** and enter the basic and iSCSI group information. - - To edit an existing target, click next to it and select **Edit**. - -6. Configure extents. Click the **Extents** tab. - - ![SharingISCSIManualExtentsForm](/images/CORE/Sharing/SharingISCSIManualExtentsForm.png "iSCSI Extents Form") - - To add a new extent, click **ADD** and enter the basic, type, and compatibility information. - - To edit an existing extent, click next to it and select **Edit**. - -7. Configure any associated targets. Click on the **Associated Targets** tab. - - ![SharingISCSIManualAssociatedTargetsForm](/images/CORE/Sharing/SharingISCSIManualAssociatedTargetsForm.png "iSCSI Associated Targets Form") - - To add a new associated target, click **ADD** and fill out the information. - - To edit an existing associated target, click next to it and select **Edit**. - -## Starting the iSCSI Service - -To turn on the iSCSI service, go to **Services** locate **iSCSI** and click on the toggle. It should display the status **Running**. - -To set it to start automatically when TrueNAS boots up, select the **Start Automatically** checkbox. - -![ServicesISCSIEnable](/images/CORE/Services/ServicesISCSIEnable.png "Starting the iSCSI Service") - -Click on the returns to the options in **Sharing > iSCSI**. diff --git a/content/CORE/CORETutorials/Sharing/iSCSI/IncreasingiSCSIAvailableStorage.md b/content/CORE/CORETutorials/Sharing/iSCSI/IncreasingiSCSIAvailableStorage.md deleted file mode 100644 index 3bf5ac52b1..0000000000 --- a/content/CORE/CORETutorials/Sharing/iSCSI/IncreasingiSCSIAvailableStorage.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "Increasing iSCSI Share Available Storage" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/sharing/iscsi/increasingiscsiavailablestorage/" -description: "Describes how to increase iSCSI share available storage on TrueNAS CORE." -weight: 10 -tags: -- iscsi ---- - -## Expanding LUNs - -TrueNAS lets users expand Zvol and file-based LUNs to increase the available storage that the iSCSI shares. - -### Expanding Zvol LUNs - -To expand a Zvol LUN, go to **Storage > Pools** and click the next to the Zvol LUN, then select **Edit Zvol**. - -![ExpandingZvolLUNList](/images/CORE/Storage/ExpandingZvolLUNList.png "Edit the Zvol LUN") - -Enter a new size in the **Size for this zvol** field, then click **SAVE**. - -![ExpandingZvolLUNSize](/images/CORE/Storage/ExpandingZvolLUNSize.png "Change the Zvol Size") - -{{< hint type=tip >}} -To prevent data loss, the web interface does not allow users to reduce the Zvol size. -TrueNAS also does not allow users to increase the Zvol size past 80% of the pool size. -{{< /hint >}} - -### Expanding a File-Based LUN - -To expand a file-based LUN, you need to know the path to the file. To find the path, go to **Sharing > Block Shares (iSCSI)** and click the **Extents** tab. -Click the next to the file-based LUN and select **Edit**. - -![ExpandingFileLUNPath](/images/CORE/Storage/ExpandingFileLUNPath.png "Copy the Path to the File") - -Highlight and copy the path, then click **CANCEL** - -Go to the shell and enter truncate -s +size path/to/file where *size* is how much space you want to grow the file by, and *path/to/file* is the file path you copied earlier, then press Enter. - -![ExpandingFileLUNShell](/images/CORE/Storage/ExpandingFileLUNShell.png "Expanding the File Size in Shell") - -An example of the command could look like this: `truncate -s +2g /mnt/Shares/Dataset1/FileLun/FileLUN` - -Lastly, go back to the extent in **Sharing > Block Shares (iSCSI)** and make sure the **Filesize** is set to **0** so that the share uses the actual file size. diff --git a/content/CORE/CORETutorials/Sharing/iSCSI/SettingUpFibreChannel.md b/content/CORE/CORETutorials/Sharing/iSCSI/SettingUpFibreChannel.md deleted file mode 100644 index 78c20c2a47..0000000000 --- a/content/CORE/CORETutorials/Sharing/iSCSI/SettingUpFibreChannel.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "Fibre Channel" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/sharing/iscsi/settingupfibrechannel/" -description: "Describes how to set up Fibre Channel on TrueNAS CORE." -weight: 20 -aliases: /core/sharing/iscsi/fibrechannel/ -tags: -- iscsi ---- - -{{< hint type=note >}} -Fibre Channel is a TrueNAS Enterprise feature. Only TrueNAS systems licensed for Fibre Channel have the **Fibre Channel Ports** added to **Sharing > Block Shares (iSCSI)** screens. - -![Sharing ISCSI Fibre Channel Ports](/images/CORE/Sharing/SharingISCSIFibreChannelPorts.png "Sharing ISCSI Fibre Channel Ports") -{{< /hint >}} - -## Setting up a Fibre Channel ISCSI Share - -{{< hint type=note >}} -This procedure uses an example to illustrate each step. -{{< /hint >}} - -1. Add a zvol to use for the share. - - a. Go to **Storage > Pools**. - - b. Find an existing pool, click   and **Add zvol** to create a new zvol. - - ![StoragePoolsZvolFibreEnterprise](/images/CORE/Storage/StoragePoolsZvolFibreEnterprise.png "Creating a Zvol for Fibre Channel") - -2. Configure these iSCSI tabs in **Sharing > Block Shares (iSCSI)**: - - {{< hint type=note >}} - **Initiators** and **Authorized Access** screens only apply to iSCSI and can be ignored when configuring Fibre Channel. - {{< /hint >}} - - a. **Portals**. Check for the **0.0.0.0:3260** IP and port number. If it doesn't exist, click **Add** and add this portal. - - b. **Targets**. Click **Add** to set up a new target. Enter the values for your uses case in the **Target Name**, **Target Alias**, and **Portal Group**. - - Select the **Target Mode** option from **iSCSI**, **Fibre Channel** or **Both**. - - The **Initiator Group ID** selects which existing initiator group has access to the target. - - Options for the **Authentication Method** are **None**, **CHAP**, or **Mutual CHAP**. - - Set **Authentication Group Number** to either none or an integer. This value represents the number of existing authorized accesses. - - ![Sharing ISCSI Targets Add Fibre](/images/CORE/Sharing/SharingISCSITargetsAddFibre.png "ISCSI Targets: Fibre") - - The **Target** [Reporting]({{< relref "/CORE/UIReference/ReportingGraphs.md" >}}) tab provides Fibre Channel port bandwidth graphs. - - c. **Extents**. Click **Add** to create a new extent. - - ![ISCSIExtentsAddFibre](/images/CORE/Sharing/ISCSIExtentsAddFibre.png "ISCSI Extents Add Fibre") - - d. **Associated Targets**. Click **Add** to add a new associated target. - - Select values for **Target** and **Extent**. - - The LUN ID is a value between 0 and 1023. Some initiators expect a value below 256. Leave this field blank to automatically assign the next available ID. - - ![ISCSIAssocTargetAddFibre](/images/CORE/Sharing/ISCSIAssocTargetAddFibre.png "ISCSI Assoc Target: Add Fibre") - -3. Set **Fibre Channel Ports**. - - a. Click to expand the option for the port you want to select. - - b. Select the **Mode** as either **Initiators** or **Targets**. The **Targets** dropdown field displays on the right side of the screen. - - c. Select the target from the list. A list of **Connected Initiators displays below the **Targets** dropdown list field. - - ![Sharing ISCSI Targets Add Fibre](/images/CORE/Sharing/SharingISCSITargetsAddFibre.png "ISCSI Targets: Fibre") - - d. Select the initiator you want to use and then click **Save**. - -4. Start the iSCSI service. Go to **Services** and click the **iSCSI** toggle until the **Running** status message displays. diff --git a/content/CORE/CORETutorials/Sharing/iSCSI/UsingiSCSIShare.md b/content/CORE/CORETutorials/Sharing/iSCSI/UsingiSCSIShare.md deleted file mode 100644 index 8a60e1d1ca..0000000000 --- a/content/CORE/CORETutorials/Sharing/iSCSI/UsingiSCSIShare.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: "Using the iSCSI Share" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/sharing/iscsi/usingiscsishare/" -description: "Describes how to use the iSCSI share in TrueNAS CORE." -weight: 10 -tags: -- iscsi -- iscsi ---- - - -## Using the iSCSI Share - -Connecting to and using an iSCSI share can differ between operating systems. This article provides instructions for Linux and Windows. - -{{< expand "Configuring Linux to Use the iSCSI Share" >}} -### iSCSI Utilities and Service - -First, open the command line and ensure that the `open-iscsi` utility is installed. - -To install the utility on an Ubuntu/Debian distribution, enter command `sudo apt update && sudo apt install open-iscsi`. -After the installation completes, ensure the iscsid service is running with command `sudo service iscsid start`. -With the iscsid service started, run the command `iscsiadm` with the discovery arguments and get the necessary information to connect to the share. - -![LinuxISCSIAppInstall](/images/CORE/LinuxISCSIAppInstall.png "Linux ISCSI App Install") - -### Discover and Log In to the iSCSI Share - -Run the command `sudo iscsiadm \--mode discovery \--type sendtargets \--portal {IPADDRESS}` where `{IPADDRESS}` is IP address (without curly brackets) you configured in the UI on the **iSCSI > Portals > Add** screen. -The output provides the base name and target name that TrueNAS configured. - -![LinuxISCSIDiscoveryList](/images/CORE/LinuxISCSIDiscoveryList.png "Linux ISCSI Discovery List") - -Alternatively, to get the same output enter command `sudo iscsiadm -m discovery -t st -p {IPADDRESS}` where `{IPADDRESS}` is IP address (without curly brackets) you configured for the iSCSI share. -Note the base name and target name given in the output, since you need them to log in to the iSCSI share. - -When a portal discovery authentication method** set to CHAP (on the UI **Sharing > iSCSI> Portals** screen), add the three following command lines to /etc/iscsi/iscsid.conf. -``` -discovery.sendtargets.auth.authmethod = CHAP -discovery.sendtargets.auth.username = user -discovery.sendtargets.auth.password = secret -``` -The user for command `discovery.sendtargets.auth.username` is set in the authorized access used by the portal of the iSCSI share (UI **iSCSI > Portals**). Likewise, the password to use for command `discovery.sendtargets.auth.password` is the in the **iSCSI > Authorized Access** screen **Secret** field. Without those lines, the iscsiadm does not discover the portal configured to use the CHAP authentication method. - -Next, enter command `sudo iscsiadm \--mode node \--targetname {BASENAME}:{TARGETNAME} \--portal {IPADDRESS} \--login`, where `{BASENAME}` and `{TARGETNAME}` (without curly brackets) is the information from the discovery command. - -![LinuxISCSILogin](/images/CORE/LinuxISCSILogin.png "Linux ISCSI Login") - -### Partition iSCSI Disk - -When the iSCSI share login succeeds, the device shared through iSCSI shows on the Linux system as an *iSCSI Disk*. -To view a list of connected disks in Linux, enter command `sudo fdisk -l`. - -![FDiskList](/images/CORE/FDiskList.png "fdisk -l output") - -Because the connected iSCSI disk is raw, you must partition it. -Identify the iSCSI device in the list and enter command `sudo fdisk {/PATH/TO/iSCSIDEVICE}` where `{/path/to/iSCSIDEVICE}` (without curly brackets) is the path for your iSCSI device. - -![FDiskPartition](/images/CORE/FDiskPartition.png "fdisk partitioning") - -View the iSCSI device path in shell with the `sudo fdisk -l` command. -Use the `fdisk` command defaults when partitioning the disk. - -{{< hint type=note >}} -Remember to type w when finished partitioning the disk. -The `w` command tells `fdisk` to save any changes before quitting. -{{< /hint >}} - -![LinuxISCSIFilesystemCreated](/images/CORE/LinuxISCSIFilesystemCreated.png "Linux ISCSI Filesystem Created") - -After creating the partition on the iSCSI disk, a partition slice displays on the device name. -For example, /dev/sdb1. -Enter `fdisk -l` to see the new partition slice. - -### Make a File System on the iSCSI Disk - -Finally, use `mkfs` to make a file system on the new partition slice on the device. -To create the default filesystem (ext2), enter the `sudo mkfs {/PATH/TO/iSCSIDEVICEPARTITIONSLICE}` command where `{/PATH/TO/iSCSIDEVICEPARTITIONSLICE}` (without curly brackets) is the path to your partition slice on your device. - -![LinuxISCSIFilesystem](/images/CORE/LinuxISCSIFilesystem.png "Linux ISCSI Filesystem") - -### Mount the iSCSI Device - -Now the iSCSI device can mount and share data. -Enter command `sudo mount {/PATH/TO/iSCSIDEVICEPARTITIONSLICE}` where `{/PATH/TO/iSCSIDEVICEPARTITIONSLICE}` (without curly brackets) is the path to your partition slice on your device. -For example, `sudo mount /dev/sdb1 /mnt` mounts the iSCSI device *sdb1* to /mnt. -{{< /expand >}} - -{{< expand "Configuring Windows to Use the iSCSI Share" >}} -To access the data on the iSCSI share, clients need to use iSCSI Initiator software. An iSCSI Initiator client is pre-installed in Windows 7 to 10 Pro, and Windows Server 2008, 2012, and 2019. Windows Professional Edition is usually required. - -First, click the **Start Menu** and search for the **iSCSI Initiator** application. - -![WindowsISCSIInitiatorApp](/images/CORE/WindowsISCSIInitiatorApp.png "Windows ISCSI Initiator App") - -Next, go to the **Configuration** tab and click **Change** to change the iSCSI initiator to the same name created earlier. Click **OK**. - -![Windows ISCSI Initiator Config Name](/images/CORE/WindowsISCSIInitiatorConfigName.png "Windows ISCSI Initiator Config Name") - -Next, switch to the **Discovery Tab**, click **Discover Portal**, and type in the TrueNAS IP address. - -* If TrueNAS changed the port number from the default **3260**, enter the new port number. - -* If you set up CHAP when creating the iSCSI share, click **Advanced...**, set **Enable CHAP log on**, and enter the initiator name and the same target/secret set earlier in TrueNAS. - -Click **OK**. - -![Windows ISCSI Initiator Discover Portal](/images/CORE/WindowsISCSIInitiatorDiscoverPortal.png "Windows ISCSI Initiator Discover Portal") - -Go to the **Targets** tab, highlight the iSCSI target, and click **Connect**. - -![Windows ISCSI Initiator Target Connect](/images/CORE/WindowsISCSIInitiatorTargetConnect.png "Windows ISCSI Initiator Target Connect") - -After Windows connects to the iSCSI target, you can partition the drive. - -Search for and open the **Disk Management** app. - -![WindowsISCSIDiskManagementApp](/images/CORE/WindowsISCSIDiskManagementApp.png "Windows ISCSI Disk Management App") - -Your drive should currently be *unallocated*. Right-click the drive and click **New Simple Volume...**. - -![WindowsISCSIDiskNewVolume](/images/CORE/WindowsISCSIDiskNewVolume.png "Windows ISCSI Disk New Volume") - -Complete the Wizard to format the drive and assign a drive letter and name. - -![WindowsISCSIDiskNewVolumeOptions](/images/CORE/WindowsISCSIDiskNewVolumeOptions.png "Windows ISCSI Disk New Volume Options") - -Finally, go to **This PC** or **My Computer** in File Explorer. The new iSCSI volume should show up under the list of drives. You should now be able to add, delete, and modify files and folders on your iSCSI drive. - -![WindowsiSCSIVolumeLocation](/images/CORE/WindowsiSCSIVolumeLocation.png "Windows iSCSI Volume Location") -{{< /expand >}} diff --git a/content/CORE/CORETutorials/Sharing/iSCSI/_index.md b/content/CORE/CORETutorials/Sharing/iSCSI/_index.md deleted file mode 100644 index 6c83addcd7..0000000000 --- a/content/CORE/CORETutorials/Sharing/iSCSI/_index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Block Shares (iSCSI)" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/sharing/iscsi/" -description: "Describes how to configure iSCSI shares on TrueNAS CORE." -geekdocCollapseSection: true -weight: 20 -aliases: /core/sharing/iscsi/ -related: false ---- - -{{< include file="/static/includes/iSCSIRef.md" >}} - -
- -For more information on iSCSI shares also see: - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/CORETutorials/Storage/Disks/DiskReplace.md b/content/CORE/CORETutorials/Storage/Disks/DiskReplace.md deleted file mode 100644 index 86755f24c9..0000000000 --- a/content/CORE/CORETutorials/Storage/Disks/DiskReplace.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: "Disk Replacement" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/disks/diskreplace/" -description: "Describes how to replace a disk and restore the hot spare in TrueNAS CORE." -weight: 20 -aliases: /core/storage/disks/diskreplace/ -tags: -- disks ---- - -Hard drives or solid-state drives (SSDs) have a finite lifetime and can fail unexpectedly. -When a disk fails in a Stripe (RAID0) pool, the entire pool has to be recreated and all data restored from backups. -Creating non-stripe storage pools that have disk redundancy is always recommended. - -To prevent further loss of redundancy or eventual data loss, always replace a failed disk as soon as possible! -TrueNAS integrates new disks into a pool to restore the pool to full functionality. - -## Replacing a Disk - -Another disk of the same or greater capacity is required to replace a failed disk. -This disk must be installed in the TrueNAS system, not part of an existing storage pool, and available to use as a replacement. -The replacement process wipes any data on the replacement disk. - -{{< expand "Can I replace a disk in a GELI-encrypted (Legacy) pool?" "v" >}} -Although GELI encryption is deprecated, TrueNAS implements GELI encryption during a "GELI-Encrypted (Legacy) pool" disk replacement. TrueNAS uses GELI encryption for the lifetime of that pool, even after replacement. -{{< /expand >}} - -The TrueNAS **Pool** widget on the main **Dashboard** shows when a disk failure degrades a pool. - -{{< trueimage src="/images/CORE/Dashboard/DashboardPoolDegraded.png" alt="Degraded Pool" id="Degraded pool on dashboard widget" >}} - -Click the on the pool card to go to the **Storage > Pools > Pool Status** screen to locate the failed disk. - -To replace a disk: -1. Take the disk offline. -2. Remove, or replace the disk. -3. Refresh the screen. -4. Bring the disk online. - -### Taking a Failed Disk Offline - -Clicking for the failed disk to show the disk options. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsStatusDiskFailedOptions.png" alt="Disk Options" id="Pool Status disk options" >}} - -We recommend you take the disk offline before starting the replacement. -This removes the device from the pool and can prevent swap issues. -To offline a disk: - -Go to **Storage > Pools** screen, click on the settings icon, and then select **Status** to Open the **Pool Status** screen and display the disks in the pools. - -Click the icon for the disk you plan to remove, and then click **Offline**. - -Select **Confirm**, then click **OFFLINE**. The disk should now be offline. - -{{< expand "Can I use a disk that is failing but still active?" "v" >}} -There are some situations where a disk that has not completely failed can be left online to provide additional redundancy during the replacement procedure. -We don't recommend leaving failed disks online unless you know the exact condition of the failing disk! -Attempting to replace a heavily degraded disk without off-lining it first results in a significantly slower replacement process. -{{< /expand >}} - -{{< expand "The offline failed?" "v" >}} -If the offline operation fails with a **Disk offline failed - no valid replicas** message, go to **Storage > Pools**, click the for the degraded pool, and select **Scrub Pool**. -When the scrub operation finishes, reopen the pool **Status** and try to offline the disk again. -{{< /expand >}} - -When the disk status shows as **Offline**, physically remove the disk from the system. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsStatusOffline.png" alt="Offline Disk" id="Pool Status disk offline" >}} - -### Replacing a Disk - -If the replacement disk is not already physically added to the system, add it now. - -If replacing a failed disk with an available disk in the system, click **Replace**, select an available disk from the dropdown list, then click **Replace**. - -To update the **Pool Status** screen and show the new disk, click **Refresh**. - -In the **Pool Status**, open the options for the offline disk and click **Replace** - -{{< trueimage src="/images/CORE/Storage/StoragePoolsStatusDiskReplace.png" alt="Replacing Disk" id="Replacing disk screen" >}} - -Select a new member disk and click **Replace Disk**. -The new disk must have the same or greater capacity as the disk you are replacing. -The replacement fails when the chosen disk has partitions or data present. -To destroy any data on the replacement disk and allow the replacement to continue, set the **Force** option. - -When the disk wipe completes and TrueNAS starts replacing the failed disk, the **Pool Status** changes to show the in-progress replacement. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsStatusReplaceStart.png" alt="Replacing Started" id="Pool Status replacing disk" >}} - -TrueNAS resilvers the pool during the replacement process. -For pools with large amounts of data, resilvering can take a long time. - -### Bringing a New Disk Online - -When the resilver completes, the pool status screen updates to show the new disk, and the pool status returns to **Online**. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsStatusReplaceComplete.png" alt="Replacement Complete" id="Pool Status disk replacement complete" >}} - -During the failed disk replacement process, take these actions after removing and replacing the physical disk to make that replacement disk available: -1. Go to **Disks** and locate the offline disk -2. Click the icon for the offline disk -3. Click **Online**. diff --git a/content/CORE/CORETutorials/Storage/Disks/DiskWipe.md b/content/CORE/CORETutorials/Storage/Disks/DiskWipe.md deleted file mode 100644 index eaaf15a976..0000000000 --- a/content/CORE/CORETutorials/Storage/Disks/DiskWipe.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "Wiping a Disk" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/disks/diskwipe/" -description: "Describes how to wipe a disk in TrueNAS CORE." -weight: 10 -aliases: /core/storage/disks/diskwipe/ -tags: -- disks ---- - -The wipe function deletes obsolete data off an unused disk. - -{{< hint type=warning >}} -This is a destructive action and results in permanent data loss! -Back up any critical data off the disk to be wiped. -{{< /hint >}} - -To wipe a disk, go to **Storage** > **Disks**. -Click the for a disk to see all the options. - -![StorageDisksExpand](/images/CORE/Storage/StorageDisksExpand.png "Disk Options") - -The wipe option is only available when the disk is not in use. -Click **WIPE** to open a dialog with additional options: - -![StorageDisksWipeMethod](/images/CORE/Storage/StorageDisksWipeMethod.png "Disk Wipe Options") - -The disk **Name** (da1, da2, ada4) helps confirm that you have selected the right disk to wipe. - -The **Method** dropdown list shows the different available wipe options available. Select **Quick** to erase only the partitioning information on a disk, making it easy to reuse but without clearing other old data. Quick wipes take only a few seconds. Select **Full with zeros** to overwrite the entire disk with zeros. This can take several hours to complete. Select **Full with random** to overwrite the entire disk with random binary code and takes even longer than **Full with zeros** to complete. - -{{< hint type=warning >}} -Ensure all data is backed up and the disk is no longer in use. -Triple check that the correct disk is selected for the wipe. -Recovering data from a wiped disk is usually impossible. -{{< /hint >}} - -After selecting the appropriate method, click **WIPE**. -A dialog asks for confirmation of the action. - -![StorageDisksWipeConfirm](/images/CORE/Storage/StorageDisksWipeConfirm.png "Wipe Confirmation") - -Verify the name to ensure you have the correct disk chosen. -When satisfied the disk can be wiped, select **Confirm** and click **CONTINUE**. -A dialog shows the disk wipe progress. - -See [Disks Screens]({{< relref "DisksScreens.md" >}}) for more information on Disks screen settings. diff --git a/content/CORE/CORETutorials/Storage/Disks/_index.md b/content/CORE/CORETutorials/Storage/Disks/_index.md deleted file mode 100644 index dac9ff9c50..0000000000 --- a/content/CORE/CORETutorials/Storage/Disks/_index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Disks" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/disks/" -description: "Tutorials about managing disks in TrueNAS CORE." -geekdocCollapseSection: true -weight: 40 -related: false ---- - -{{< children depth="2" description="true" >}} diff --git a/content/CORE/CORETutorials/Storage/ImportDisk.md b/content/CORE/CORETutorials/Storage/ImportDisk.md deleted file mode 100644 index 188a8758ed..0000000000 --- a/content/CORE/CORETutorials/Storage/ImportDisk.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "Import Disk" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/importdisk/" -description: "Describes how to import a disk on TrueNAS CORE." -weight: 50 -aliases: /core/storage/importdisk/ -tags: -- storage ---- - -Use **Storage > Import Disk** to integrate UFS (BSD Unix), NTFS (Windows), MSDOS (FAT), or EXT2 (Linux) formatted disks into TrueNAS. -This is a one-time import, copying the data from that disk into a TrueNAS dataset. -Only one disk can be imported at a time, and the disk must be installed or physically connected to the TrueNAS system. - -{{< expand "What about EXT3 or EXT4 filesystems?" "v" >}} -Importing an EXT3 or EXT4 filesystem is possible in some cases, although neither is fully supported. -EXT3 journaling is not supported, so those file systems must have an external `fsck` utility, like the one provided by [E2fsprogs utilities](https://e2fsprogs.sourceforge.net/), run on them before import. -EXT4 file systems with extended attributes or inodes greater than 128 bytes are not supported. -EXT4 file systems with EXT3 journaling must have an `fsck` run on them before import, as described above. -{{< /expand >}} - -![StorageImportDisk](/images/CORE/Storage/StorageImportDisk.png "Import Disk Options") - -Use the dropdown list to select the **Disk** to import. - -TrueNAS attempts to detect and select the the **Filesystem type**. -Selecting the MSDOSFS file system shows an additional **MSDOSFS locale** dropdown menu. -Use this option to select the locale when non-ASCII characters are present on the disk. - -Finally, browse to the ZFS dataset to hold the copied data and define the **Destination Path**. - -After clicking **SAVE**, the chosen disk mounts and its contents copied to the specified dataset at the end of the entry in **Destination Path**. -To monitor an in-progress import, open the **Task Manager** by clicking the in the top menu bar. -The disk unmounts after the copy operation completes. -A dialog allows viewing or downloading the disk import log. - -{{< expand "The import was interrupted!" "v" >}} -Use the same import procedure to restart the task. -Choose the same entry in **Destination Path** as the interrupted import for TrueNAS to scan the destination for previously imported files and resume importing any remaining files. -{{< /expand >}} diff --git a/content/CORE/CORETutorials/Storage/Pools/Datasets.md b/content/CORE/CORETutorials/Storage/Pools/Datasets.md deleted file mode 100644 index 907b8eb35a..0000000000 --- a/content/CORE/CORETutorials/Storage/Pools/Datasets.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: "Creating Datasets" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/pools/datasets/" -description: "Describes how to create and configure a dataset on TrueNAS CORE." -weight: 17 -aliases: /core/storage/pools/datasets/ -tags: -- datasets ---- - -A TrueNAS dataset is a file system that is created within a data storage pool. -Datasets can contain files, directories (child datasets), and have individual permissions or flags. -Datasets can also be [encrypted]({{< relref "/CORE/CORETutorials/Storage/Pools/StorageEncryption.md" >}}), either using the encryption created with the pool or with a separate encryption configuration. - -It is recommended to organize your pool with datasets before configuring [data sharing]({{< relref "/CORE/UIReference/Sharing/_index.md" >}}), as this allows for more fine-tuning of access permissions and using different sharing protocols. - -## Creating a Dataset - -To create a dataset in the desired pool, go to **Storage > Pools**. - -{{< trueimage src="/images/CORE/Storage/StoragePools.png" alt="Pools list with one example" id="Pools list with one example" >}} - -Find the pool and top-level (root) dataset for that pool, then click   and **Add Dataset**. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsAddDataset.png" alt="Add Dataset" id="Add Dataset" >}} - -To quickly create a dataset with the default options, enter a name for the dataset and click **SUBMIT**. - -### Dataset Options - -{{< trueimage src="/images/CORE/Storage/StoragePoolsAddDatasetOptions.png" alt="Dataset Creation: Basic Option" id="Basic Options" >}} - -The **Name and Options** fields is required to create the dataset. -Datasets typically inherit most of these settings from the root or parent dataset, only a dataset name is required before clicking **SUBMIT**. - -See [Dataset Screens]({{< relref "/CORE/UIReference/Storage/Pools/DatasetsScreen.md" >}}) for more information on basic and advanced settings. - -For the **Sync** option, we recommend production systems with critical data use the default **Standard** choice or increase to **Always**. -Choosing **Disabled** is only suitable in situations where data loss from system crash or power loss is acceptable. - -By default, datasets inherit the **Encryption Options** from the root or parent dataset. -To configure the dataset with different encryption settings, clear the checkmark from **Inherit** and choose the new in **Encryption Options**. -For detailed descriptions of the encryption options, see the [Encryption article]({{< relref "/CORE/CORETutorials/Storage/Pools/StorageEncryption.md" >}}). - -Clicking **ADVANCED OPTIONS** adds dataset quota management tools and a few additional fields to the **Other Options**: - -## Managing Datasets - -After a dataset is created, additional management options are available by going to **Storage > Pools** and clicking   for a dataset: - -* **Add Dataset**: create a new dataset that is a child of this dataset. - Datasets can be continuously layered in this manner. -* **Add Zvol**: create a new [ZFS block device]({{< relref "/CORE/CORETutorials/Storage/Pools/Zvols.md" >}}) as a child of this dataset. -* **Edit Options**: opens the [dataset options](#dataset-options) to make adjustments to the dataset configuration. - The dataset **Name**, **Case Sensitivity**, and **Share Type** cannot be changed. -* **Edit Permissions**: opens the editor to set access permissions for this dataset. - Depending on the dataset creation options, this can be a simple permissions editor or the full ACL editor. For more information about editing permissions, read the [permissions]({{< relref "/CORE/CORETutorials/Storage/Pools/Permissions.md" >}}) article. -* **User Quotas**: shows options to set data or object quotas for user accounts cached on the system or user accounts that are connected to this system. -* **Group Quotas**: shows options to set data or object quotas for user groups cached on the system or user groups that are connected to this system. -* **Delete Dataset**: removes the dataset, all stored data, and any snapshots of the dataset from TrueNAS. - {{< hint type=warning >}} - Deleting datasets can result in unrecoverable data loss! - Be sure that any critical data is moved off the dataset or is otherwise obsolete. - {{< /hint >}} -* **Create Snapshot**: take a single [ZFS snapshot]({{< relref "/CORE/CORETutorials/Storage/Snapshots.md" >}}) of the dataset to provide additional data protection and mobility. - Created snapshots are listed in **Storage > Snapshots**. - -## Quotas - -TrueNAS allows setting data or object quotas for user accounts and groups cached on or connected to the system. - -Setting a quota defines the maximum allowed space for the dataset. -You can also reserve a defined amount of pool space for the dataset to help prevent situations where automatically generated data like system logs consume all space on the dataset. -Quotas can be configured for either the new dataset or to include all child datasets in the quota. - -[Dataset Screens]({{< relref "/CORE/UIReference/Storage/Pools/DatasetsScreen.md" >}}) for more information on quota settings. - -### Quota Types - -#### User Qutoas -To view and edit user quotas, go to **Storage > Pools** and click   to open the **Dataset Actions** menu, and then click **User Quotas**. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsDatasetActionsUserQuotas.png" alt="User Quotas List" id="User Quotas List" >}} - -The **User Quotas** page displays the names and quota data of any user accounts cached on or connected to the system. - -To edit individual user quotas, go to the user row and click the   button, then click . - -{{< trueimage src="/images/CORE/Storage/StoragePoolsDatasetActionsUserQuotasUserEdit.png" alt="User Quotas: Editing a Single User" id="Editing a Single User" >}} - -The **Edit User** window allows editing the **User Data Quota**, which is the amount of disk space that can be used by the selected users, and the **User Object Quota**, which is the number of objects that can be owned by each of the selected users. - -To edit user quotas in bulk, click **Actions** and select **Set Quotas (Bulk)**. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsDatasetActionsUserQuotasBulkEdit.png" alt="User Quotas: Bulk Edits" id="Bulk Edits" >}} - -The **Set Quotas** window allows editing user data and object quotas after selecting any cached or connected users. - -#### Group Quotas - -Go to **Storage > Pools** and click   to open the **Dataset Actions** menu. -Click **Group Quotas**. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsDatasetActionsGroupQuotas.png" alt="Group Quotas List" id="Group Quotas List" >}} - -The **Group Quotas** page displays the names and quota data of any groups cached on or connected to the system. - -To edit individual group quotas, go to the group row and click the **>** button, then click . - -{{< trueimage src="/images/CORE/Storage/StoragePoolsDatasetActionsGroupQuotasEditGroup.png" alt="Group Quotas: Edit single group" id="Edit a Single Group" >}} - -The **Edit Group** window allows editing the **Group Data Quota** and **Group Object Quota**. - -To edit group quotas in bulk, click **Actions** and select **Set Quotas (Bulk)**. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsDatasetActionsGroupQuotasBulkEdit.png" alt="Group Quotas: Bulk Edit" id="Bulk Edit" >}} - -The same options for single groups are presented, along with choosing groups for these new quota rules. diff --git a/content/CORE/CORETutorials/Storage/Pools/FusionPool.md b/content/CORE/CORETutorials/Storage/Pools/FusionPool.md deleted file mode 100644 index 3da87dbde3..0000000000 --- a/content/CORE/CORETutorials/Storage/Pools/FusionPool.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "Fusion Pools" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/pools/fusionpool/" -description: "Describes how to create a Fusion Pool on TrueNAS CORE." -weight: 30 -aliases: /core/storage/pools/fusionpool/ -tags: -- pools ---- - -{{< include file="/static/includes/FusionPools.md" >}} - -See [Managing Pools]({{< relref "/CORE/CORETutorials/Storage/Pools/ManagingPools.md" >}}). diff --git a/content/CORE/CORETutorials/Storage/Pools/ManagingPools.md b/content/CORE/CORETutorials/Storage/Pools/ManagingPools.md deleted file mode 100644 index 9e38b31492..0000000000 --- a/content/CORE/CORETutorials/Storage/Pools/ManagingPools.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: "Managing Pools" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/pools/managingpools/" -description: "Describes how to manage storage pools on TrueNAS CORE." -weight: 16 -Aliases: /core/storage/pools/managingpools/ -tags: -- pools -- storage ---- - -After creating a data storage pool, there are a variety of options to change the initial configuration of that pool. -Changing a pool can be disruptive, so make sure you are aware of existing resources on the system and consider backing up any stored data before changing the pool. -To find an existing pool, log in to the web interface and go to **Storage > Pools**. - -![StoragePoolsScreen](/images/CORE/Storage/StoragePoolsScreen.png "Storage Pools Screen") - -The current status and storage usage of each pool is shown. -To see more details about a pool, click the expand_more expand symbol on the right side of the pool entry. -Click the for all pool management options. - -## Pool Actions -{{< expand "Pool Options" >}} -Contains any additional high-level settings for the pool. - -![StoragePoolsPoolOptions](/images/CORE/Storage/StoragePoolsPoolOptions.png "StoragePoolsPoolOptions") - -**Auto TRIM** allows TrueNAS to periodically check the pool disks for storage blocks that can be reclaimed. -This can have a performance impact on the pool, so the option is disabled by default. -For more details about TRIM in ZFS, see the `autotrim` property description in [zpool.8](https://zfsonlinux.org/manpages/0.8.1/man8/zpool.8.html). -{{< /expand >}} -{{< expand "Export/Disconnect" >}} -Removes the pool from the system. - -Use to prepare drives for transfer to a new system and import the pool or completely delete the pool and any data stored on it. -A dialog warns about the risks of disconnecting the pool and shows any system services that are affected by removing the pool. - -![Storage Pools Export Example](/images/CORE/Storage/StoragePoolsExportExample.png "Storage Pools Export Example") - -Because this is a destructive action, you must select additional checkboxes and enter the name of the pool when also deleting stored data. -You can also remove existing shares to this data when the pool is disconnected. -{{< /expand >}} -{{< expand "Add Vdevs" >}} -Opens the **Pool Manager** to add more vdevs to the pool. -Changing the original encryption and data vdev configuration is not allowed. - -![Storage Pools Add Create Vdevs](/images/CORE/Storage/StoragePoolsAddCreateVdevs.png "Storage Pools Add Create Vdevs") - -A new data vdev is chosen by default. - -To add different kinds of vdevs to the pool, click **ADD VDEV** and select the type from the dropdown list. - -When adding disks to increase the capacity of a pool, ZFS supports the addition of virtual devices, or vdevs, to an existing ZFS pool. - -After a vdev is created, more drives cannot be added to that vdev, but a new vdev can be striped with another of the same type to increase the overall size of the pool. -To extend a pool, the vdev added must be the same type as existing vdevs. - -Some vdev extending examples: - -* Extend a ZFS mirror: Add the same number of drives. The result is a striped mirror. - For example, if ten new drives are available, a mirror of two drives can be created initially, then extended by adding another mirror of two drives, and repeating three more times until all ten drives are added. -* Extend a three-drive RAIDZ1: Add another three drives. The resulting pool is a stripe of two RAIDZ1 vdevs, similar to RAID 50 on a hardware controller. -* Extend a four-drive RAIDZ2: Add another four drives. The result is a stripe of RAIDZ2 vdevs, similar to RAID 60 on a hardware controller. -* Add a disk as a *hot spare* to the pool. -{{< /expand >}} -{{< expand "Scrub Pool" >}} -Initiate a data integrity check of the pool. - -Any problems detected during the scrub are either automatically corrected or generate an [alert]({{< relref "CORE/CORETutorials/SystemConfiguration/CreatingAlerts.md" >}}) in the web interface. -By default, every pool is automatically checked on a reoccurring [scrub schedule]({{< relref "/CORE/CORETutorials/Tasks/CreatingScrubTasks.md" >}}). -{{< /expand >}} -{{< expand "Status" >}} -Opens the **Pool Status** screen to show the state of the last scrub and disks in the pool. - -![PoolStatusScreen](/images/CORE/Storage/PoolStatusScreen.png "Storage Pools Status") - -Additional options for [managing connected disks]({{< relref "/CORE/CORETutorials/Storage/Disks/DiskReplace.md" >}}) are available in this screen. -{{< /expand >}} -{{< expand "Expand Pool" >}} -Increases the size of the pool to match all available disk space. -This option is typically used when virtual disks are resized apart from TrueNAS. -{{< /expand >}} -{{< expand "Upgrade Pool" >}} -This option only displays when the pool can be upgraded to use new [ZFS feature flags]({{< relref "/References/ZFSPrimer.md" >}}). -Before upgrading an existing pool, be aware of these caveats: - -* Upgrading a pool is one-way. This means that if you change your mind. - You cannot go back to an earlier ZFS version or downgrade to an earlier version of the software that does not support those ZFS features. -* Upgrading can affect data. Before performing any operation that can affect the data on a storage disk, always back up all data first and verify the integrity of the backup. - While it is unlikely that the pool upgrade affects the data, it is always better to be safe than sorry. -* Upgrading a ZFS pool is optional. Do not upgrade the pool if the possibility of reverting to an earlier version of TrueNAS or repurposing the disks in another operating system that supports ZFS is desired. - It is not necessary to upgrade the pool unless the end user has a specific need for the newer ZFS Feature Flags. - If you upgrade a pool to the latest feature flags, you cannot import that pool into another operating system that does not yet support those feature flags. - -The upgrade itself only takes a few seconds and is non-disruptive. -It is not necessary to stop any sharing services to upgrade the pool. -However, it is best to upgrade when the pool is not in heavy use. -The upgrade process suspends I/O for a short period, but is nearly instantaneous on a quiet pool. -{{< /expand >}} diff --git a/content/CORE/CORETutorials/Storage/Pools/Permissions.md b/content/CORE/CORETutorials/Storage/Pools/Permissions.md deleted file mode 100644 index b557b52f9b..0000000000 --- a/content/CORE/CORETutorials/Storage/Pools/Permissions.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: "Permissions" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/pools/permissions/" -description: "This articled describes permissions configuration on TrueNAS CORE." -weight: 22 -aliases: /core/storage/pools/permissions/ -tags: -- datasets -- acl -- storage ---- - -Permissions control the actions users can perform on dataset contents. -TrueNAS allows using both a simple permissions manager and editing a full Access Control List (ACL) for defining dataset permissions. - -To change dataset permissions, go to **Storage > Pools >** **Edit Permissions** for a dataset. - -## Basic Permissions Editor - -The **Edit Permissions** option allows basic adjustments to a datasets ACL. - -![StoragePoolsEditPermissionsBasic](/images/CORE/Storage/StoragePoolsEditPermissionsBasic.png "Basic Permissions Editor") - -### Options - -The **Owner** section controls which TrueNAS user and group has full control of this dataset. - -**Access Mode** defines the basic read, write, and execute permissions for the user, group, and other accounts that might access this dataset. - -**Advanced** has several tuning options to set how permissions apply to directories and files within the current dataset. - -To switch from the basic editor to the advanced ACL editor, click **USE ACL MANAGER**. - -## Access Control Lists - -An Access Control List (ACL) is a set of account permissions associated with a dataset and applied to directories or files within that dataset. -ACLs are typically used to manage user interactions with shared datasets and are created when a dataset is added to a pool. - -When [creating a dataset]({{< relref "/CORE/CORETutorials/Storage/Pools/Datasets.md" >}}), you can choose how the ACL can be modified by selecting an **ACL Mode**: - -* **Passthrough** only updates ACL entries (ACEs) that are related to the file or directory mode. - -* **Restricted** does not allow `chmod` to make changes to files or directories with a non-trivial ACL. - An ACL is trivial if it can be fully expressed as a file mode without losing any access rules. - Setting the **ACL Mode** to **Restricted** is typically used to optimize a dataset for SMB sharing, but can require further optimizations. - For example, configuring an rsync task with this dataset could require adding `--no-perms` as an extra option for the task. - -To view an ACL, go to **Storage > Pools >** **Edit Permissions** for a nested dataset within a pool. - -![ACLManager](/images/CORE/Storage/ACLManager.png) - -{{< expand "Tutorial Video" "v" >}} -{{< embed-video name="userspermissionsacls" >}} -{{< /expand >}} - -### ACL Inheritance - -The ACL for a new file or directory is typically inherited from the parent directory and is preserved when it is moved or renamed within the same dataset. -An exception is when there are no **File Inherit** or **Directory Inherit** flags in the parent ACL **owner@**, **group@**, or **everyone@** entries. -These non-inheriting entries are added to the ACL of the newly created file or directory based on the [Samba](https://wiki.samba.org/index.php/Main_Page) create and directory masks or the [umask](https://www.freebsd.org/cgi/man.cgi?query=umask&sektion=2) value. - -### Editing an ACL - -Click **ACL Manager** to adjust file ownership or account permissions to the dataset. -The first time viewing the ACL Manager a dialog suggests using basic presets. -The ACL can be edited at any time after choosing to either apply a preset or create a custom ACL. - -Choose **Select a preset ACL** and choose a preset. -The preset options are **OPEN**, **RESTRICTED**, or **HOME**. - -Choose **Create a custom ACL** to create a new list of customized permissions. - -**File Information** - -The selected **User** controls the dataset and always has permission to modify the ACL and other attributes. -The selected **Group** also controls the dataset, but permissions change by adding or modifying a **group@** ACE. -Any user accounts or groups imported from a directory service can be selected as the primary in **User** or **Group**. - -### Access Control List (ACEs) - -To add a new item to the ACL, define **Who** the Access Control Entry (ACE) applies to, and configure permissions and inheritance flags for the ACE. - -{{< expand "ACL Details from Shell" "v" >}} -To view an ACL information from the console, connect to a shell session and enter: - -```shell -getfacl /mnt/path/to/dataset -``` -{{< /expand >}} - -#### Permissions - -Permissions are divided between **Basic** and **Advanced** options. -The basic options are commonly used groups of the advanced options. - -**Basic Permissions** - -* **Read** (`r-x---a-R-c---`): view file or directory contents, attributes, named attributes, and ACL. - Includes the **Traverse** permission. -* **Modify** (`rwxpDdaARWc--s`): adjust file or directory contents, attributes, and named attributes. - Create new files or subdirectories. - Includes the **Traverse** permission. - Changing the ACL contents or owner is not allowed. -* **Traverse** (`--x---a-R-c---`): Execute a file or move through a directory. - Directory contents are restricted from view unless the **Read** permission is also applied. - To traverse and view files in a directory, but not be able to open individual files, set the **Traverse** and **Read** permissions, then add the advanced **Directory Inherit** flag. -* **Full Control** (`rwxpDdaARWcCos`): Apply all permissions. - -**Advanced Permissions** - -* **Read Data** (`r`): View file contents or list directory contents. -* **Write Data** (`w`): Create new files or modify any part of a file. -* **Append Data** (`p`): Add new data to the end of a file. -* **Read Named Attributes** (`R`): view the named attributes directory. -* **Write Named Attributes** (`W`): create a named attribute directory. Must be paired with the Read Named Attributes permission. -* **Execute** (`x`): Execute a file, move through, or search a directory. -* **Delete Children** (`D`): delete files or subdirectories from inside a directory. -* **Read Attributes** (`a`): view file or directory non-ACL attributes. -* **Write Attributes** (`A`): change file or directory non-ACL attributes. -* **Delete** (`d`): remove the file or directory. -* **Read ACL** (`c`): view the ACL. -* **Write ACL*** (`C`): change the ACL and the ACL mode. -* **Write Owner** (`o`): change the user and group owners of the file or directory. -* **Synchronize** (`s`): synchronous file read/write with the server. This permission does not apply to FreeBSD clients. - -#### Inheritance Flags - -Basic inheritance flags only enable or disable ACE inheritance. -Advanced flags offer finer control for applying an ACE to new files or directories. - -**Basic Flags** - -* **Inherit** (`fd-----`): enable ACE inheritance. -* **No Inherit** (`-------`): disable ACE inheritance. - -**Advanced Flags** - -* **File Inherit** (`f`): The ACE is inherited with subdirectories and files. It applies to new files. -* **Directory Inherit** (`d`): new subdirectories inherit the full ACE. -* **No Propagate Inherit** (`n`): The ACE can only be inherited once. -* **Inherit Only** (`i`): Remove the ACE from permission checks but allow it to be inherited by new files or subdirectories. Inherit Only is removed from these new objects. -* **Inherited** (`I`): set when the ACE has been inherited from another dataset. diff --git a/content/CORE/CORETutorials/Storage/Pools/PoolImport.md b/content/CORE/CORETutorials/Storage/Pools/PoolImport.md deleted file mode 100644 index 267a0b79d3..0000000000 --- a/content/CORE/CORETutorials/Storage/Pools/PoolImport.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: "Importing Pools" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/pools/poolimport/" -description: "Describes how to import storage pools on TrueNAS CORE." -weight: 15 -Aliases: /core/storage/pools/poolimport/ -tags: -- pools -- storage ---- - -{{< hint type=note >}} -This procedure only applies to disks with a ZFS storage pool. -To import disks with different file systems, see [Import Disk]({{< relref "/CORE/CORETutorials/Storage/ImportDisk.md" >}}). -{{< /hint >}} - -ZFS pool importing works for pools that were exported or disconnected from the current system, created on another system, and pools to reconnect after reinstalling or upgrading the TrueNAS system. -To import a pool, go to **Storage > Pools > ADD**. - -{{< expand "Do I need to do anything different with disks installed on a different system?" "v" >}} -When physically installing ZFS pool disks from another system, use the command `zpool export poolname` in the command line or a web interface equivalent to export the pool on that system. -Shut that system down and move the drives to the TrueNAS system. -Shutting down the original system prevents an *in use by another machine* error during the TrueNAS import. -{{< /expand >}} - -There are two kinds of pool imports, standard ZFS pool imports and ZFS pools with [legacy GELI encryption](https://docs.freebsd.org/en_US.ISO8859-1/books/handbook/disks-encrypting.html). - -## Pool Import Options -{{< expand "Standard ZFS Pool" >}} -## Standard ZFS Pools - -Select **Import Existing Pool** and click **NEXT**. - -![StoragePoolsAddImport](/images/CORE/Storage/StoragePoolsAddImport.png "Import Pool Selection") - -The wizard asks if the pool has legacy GELI encryption. - -![StoragePoolsAddImportNoGELI](/images/CORE/Storage/StoragePoolsAddImportNoGELI.png "No GELI on the pool") - -Select **No, continue with import** and click **NEXT**. - -TrueNAS detects any pools that are present but unconnected. - -![StoragePoolsAddImportZFSPool](/images/CORE/Storage/StoragePoolsAddImportZFSPool.png "Selecting a pool to import") - -Choose the ZFS pool to import and click **NEXT**. - -Review the Pool Import Summary and click **IMPORT**. - -![StoragePoolsAddImportZFSPoolSummary](/images/CORE/Storage/StoragePoolsAddImportZFSPoolSummary.png "Pool Import Summary") - -{{< /expand >}} -{{< expand "ZFS Pool with GELI" >}} -## Encrypted GELI Pools - -{{< hint type=warning >}} -Importing a GELI-encrypted pool requires using the encryption key file and passphrase to decrypt the pool *before* importing. -When a pool cannot be decrypted, it cannot be re-imported after a failed upgrade or lost configuration, and the data is *irretrievable*! -Always have a copy of the pool GELI key file and passphrase available. -{{< /hint >}} - -Select **Import Existing Pool** and click **NEXT**. - -![StoragePoolsAddImport](/images/CORE/Storage/StoragePoolsAddImport.png "Import Pool Selection") - -The wizard asks if the pool has legacy GELI encryption. -Select **Yes, decrypt the disks** and review the decryption options. - -![StoragePoolsAddImportGELIPresentDecrypt](/images/CORE/Storage/StoragePoolsAddImportGELIPresentDecrypt.png "GELI decryption options") - -Make sure the **Disks** selection shows the encrypted disks and partitions that are part of the incoming pool. -Apply the GELI encryption key file by clicking **Choose File** and uploading the file from your local system. - -![StoragePoolsAddImportGELIPresentDecryptKeyFile](/images/CORE/Storage/StoragePoolsAddImportGELIPresentDecryptKeyFile.png "GELI encryption key file upload") - -When a passphrase is also present, enter it in **Passphrase**. -Click **Next** and wait for the disks to decrypt. - -When the disks are decrypted, select the GELI pool to import. - -![StoragePoolsAddImportGELIPresentDecryptPool](/images/CORE/Storage/StoragePoolsAddImportGELIPresentDecryptPool.png "Select the GELI pool to import") - -Review the **Pool Import Summary** and click **IMPORT**. - -![StoragePoolsAddImportGELIPresentDecryptPoolSummary](/images/CORE/Storage/StoragePoolsAddImportGELIPresentDecryptPoolSummary.png "Import Summary for GELI pool") - -GELI encrypted pools show in **Storage > Pools** as **(Legacy Encryption)**. - -![StoragePoolsLegacyGELI](/images/CORE/Storage/StoragePoolsLegacyGELI.png "Pool with GELI encryption") - -### Back Up the Pool Key - -For security reasons, encrypted pool keys do not save to a configuration backup file. -When TrueNAS is installed to a new device and restored with a saved configuration file, keys for encrypted disks are not present and the system does not request them. - -To correct this, export the encrypted pool in **Storage > Pools** with > **Export/Disconnect**. -{{< hint type=warning >}} -Do *not* select **Destroy data on this pool?**. -{{< /hint >}} -Now import the pool again. -During the import, add the encryption keys as described previously. -{{< /expand >}} diff --git a/content/CORE/CORETutorials/Storage/Pools/SLOGOverprovision.md b/content/CORE/CORETutorials/Storage/Pools/SLOGOverprovision.md deleted file mode 100644 index 6dc369b101..0000000000 --- a/content/CORE/CORETutorials/Storage/Pools/SLOGOverprovision.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "SLOG Overprovisioning" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/pools/slogoverprovision/" -description: "Describes how to configure SLOG over-provisioning on TrueNAS CORE." -weight: 50 -aliases: /core/storage/pools/slogoverprovision/ -tags: -- slog -- storage ---- - -Over-provisioning SLOG SSDs is useful for different scenarios. -The most useful benefit of over-provisioning is greatly extending SSD life. -Over-provisioning an SSD distributes the total number of writes and erases across more flash blocks on the drive. - -Seagate provides a thoughtful investigation into over-provisioning SSDs here: -https://www.seagate.com/blog/ssd-over-provisioning-benefits-master-ti/. - -{{< hint type=note >}} -Some SATA devices are limited to one resize per power cycle. -Some BIOS can block resize during boot and require a live power cycle. -{{< /hint >}} - -## Overprovision Options -{{< expand "Web Interface" >}} -To over provision a SLOG device, log in to TrueNAS and go to **System > Advanced**. -Enter an over-provision value corresponding to the new size in GB in the **Log (Write Cache) Overprovision Size in GiB** field. - -![StoragePoolsOptionSLOGOverprovision](/images/CORE/Storage/StoragePoolsOptionsLogOverprovision.png "") - -When this value is applied, the over-provision value is applied whenever a pool is created with a SLOG device. -It is impossible to restore an over-provisioned SLOG device back to original capacity without running the `disk_resize` command after first destroying the pool it was part of and issuing a full power cycle. - -{{< hint type=note >}} -Only one over-provision/under-provision operation occurs per power cycle. -{{< /hint >}} - -Erasing the over-provision setting in **System > Advanced** **Log (Write Cache) Overprovision Size in GiB** field and setting to *none* prevents future SLOG devices from being over-provisioned. -{{< /expand >}} -{{< expand "Shell" >}} -Use `disk_resize` in the shell to over-provision. - -The command to over-provision an SSD is `disk_resize {DEVICE} {SIZE}`, where *{DEVICE}* is the SSD device name and *{SIZE}* is the new provision size in GiB or TiB. -Example: `disk_resize ada5 16GB`. -When no size is specified, it reverts the provision back the full size of the device. -{{< /expand >}} diff --git a/content/CORE/CORETutorials/Storage/Pools/StorageEncryption.md b/content/CORE/CORETutorials/Storage/Pools/StorageEncryption.md deleted file mode 100644 index fa613bfd93..0000000000 --- a/content/CORE/CORETutorials/Storage/Pools/StorageEncryption.md +++ /dev/null @@ -1,286 +0,0 @@ ---- -title: "Storage Encryption" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/pools/storageencryption/" -description: "Describes how to encrypt a storage pool in TrueNAS CORE." -weight: 25 -aliases: /core/storage/pools/storageencryption/ -tags: -- encryption -- pools -- datasets -- sed ---- - -TrueNAS supports different encryption options for critical data. - -{{< hint type=warning >}} -Users are responsible for backing up and securing encryption keys and passphrases! -Losing the ability to decrypt data is similar to a catastrophic data loss. -{{< /hint >}} - -Data-at-rest encryption is available with: - -+ [Self Encrypting Drives (SEDs)](https://www.snia.org/sites/default/education/tutorials/2009/fall/security/MichaelWillett-Self_Encrypting_Drives-FINAL.pdf) using OPAL or FIPS 140.2 (Both [AES 256](https://csrc.nist.gov/projects/cryptographic-standards-and-guidelines/archived-crypto-projects/aes-development)) -+ Encryption of specific datasets (AES-256-GCM in TrueNAS 12.0) - -The local TrueNAS system manages keys for data-at-rest. -The user is responsible for storing and securing their keys. -The [Key Management Interface Protocol (KMIP)](https://docs.oasis-open.org/kmip/spec/v1.1/os/kmip-spec-v1.1-os.html) is included in TrueNAS 12.0. - -{{< expand "Encryption Drawbacks and Considerations" "v" >}} -Always consider the following drawbacks/considerations when encrypting data: -* All datasets contained within an encrypted pool inherit encryption. -* If there is only one pool and it is encrypted, all datasets are also encrypted. -* If the encryption keys and passwords are lost, encrypted data is unrecoverable. - -Unrelated encrypted datasets [do not support deduplication](https://github.com/openzfs/zfs/discussions/9423). - -We do not recommend using GELI or ZFS encryption with deduplication because of the sizable performance impact. - -Be cautious when using many encryption and deduplication features at once since they all compete for the same CPU cycles. -{{< /expand >}} - -## Encrypting a Storage Pool - -Encrypting the root dataset of a new storage pool further increases data security. -All datasets added to a pool with encryption applied inherit encryption. This means all datasets added to a pool with encryption are also encrypted. - -[Create a new pool]({{< relref "/CORE/CORETutorials/Storage/Pools/_index.md#creating-a-pool" >}}) and set **Encryption** in the **Pool Manager**. -TrueNAS shows a warning. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsAddEncryptionWarning.png" alt="Storage Pools Add Encryption Warning" id="Storage Pools Add Encryption Warning" >}} - -Read the warning, select **Confirm**, and click **I Understand**. - -We recommend using the default encryption in **Cipher**, but other ciphers are available. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsAddCreateEncryptionCiphers.png" alt="Choosing an encryption cipher" id="Choosing an encryption cipher" >}} - -{{< expand "What are these options?" "v" >}} -TrueNAS supports AES [Galois Counter Mode (GCM)](https://csrc.nist.gov/publications/detail/sp/800-38d/final) and [Counter with CBC-MAC (CCM)](https://tools.ietf.org/html/rfc3610) algorithms for encryption. -These algorithms provide authenticated encryption with block ciphers. -{{< /expand >}} - -## Encrypting a New Dataset - -TrueNAS can encrypt new datasets within an existing unencrypted storage pool without having to encrypt the entire pool. -To encrypt a single dataset, go to **Storage > Pools**, open the for an existing dataset, and click **Add Dataset**. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsDatasetAdd.png" alt="New Dataset Options" id="New Dataset Options" >}} - -In the **Encryption Options** area, clear the **Inherit** checkbox, then select **Encryption**. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsCreateDatasetEncryptionOptions.png" alt="Dataset Encryption Options" id="Dataset Encryption Options" >}} - -Now select the authentication to use from the two options in **Type**: either a **Key** or **Passphrase**. -The remaining options are the same as a new pool. -Datasets with encryption enabled show additional icons on the **Storage > Pools** list. - -### Locking and Unlocking Datasets - -The dataset locked/unlocked status is determined from an icon: - -* The dataset unlocked icon: . -* The dataset locked icon: . -* A Dataset on an encrypted pool with encryption properties that don't match the root dataset shows this icon: ![UnecryptedPoolEncryptionDatasetIcon](/images/CORE/Storage/unecrypted_pool_encrypted_dataset.png "Unencrypted Storage Pool with an Unencrypted Dataset") - -{{< hint type=note >}} -NOTE: An unencrypted pool with an encrypted dataset also shows this icon: ![UnecryptedPoolEncryptionDatasetIcon](/images/CORE/Storage/unecrypted_pool_encrypted_dataset.png "Unencrypted Storage Pool with an Unencrypted Dataset") -{{< /hint >}} - -You can only lock or unlock encrypted datasets when they are secured with a passphrase instead of a key file. -Before locking a dataset, verify that it is not currently in use, then click   (Options) and **Lock**. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsDatasetLockOptions.png" alt="Dataset Locking Options" id="Dataset Locking Options" >}} - -Use the **Force unmount** option only if you are certain no one is currently accessing the dataset. -After locking a dataset, the unlock icon changes to a locked icon. -While the dataset is locked, it is not available for use. - -To unlock a dataset, click and **Unlock**. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsDatasetUnlockOptions.png" alt="Dataset Unlock Options" id="Dataset Unlock Options" >}} - -Enter the passphrase and click **Submit**. -To unlock child datasets, select **Unlock Children**. -Child datasets that inherited encryption settings from the parent dataset unlock when the parent unlocks. -Users can simultaneously unlock child datasets with different passphrases from the parent by entering their passphrases. - -Confirm unlocking the datasets and wait for a dialog to show the unlock is successful. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsDatasetUnlockSuccess.png" alt="Dataset Unlock Success" id="Dataset Unlock Success" >}} - -{{< expand "Example" >}} - -{{< trueimage src="/images/CORE/Storage/EncryptionExample1.png" alt="Encrypted locked Datasets" id="Encrypted locked Datasets" >}} - -The parent dataset is *media*. It has three child datasets. -The *documents* child dataset inherits the parent encryption settings and password. -The other two child datasets (*audio* and *video*) have their own passphrases. When you lock the parent dataset all child datasets are also locked. - -{{< trueimage src="/images/CORE/Storage/EncryptionExample2.png" alt="Password for locked Datasets" id="Password for locked Datasets" >}} - -Open the for the parent dataset and select **unlock**. -To unlock all the datasets, select **Unlock Children** and enter the passphrase for each dataset to unlock. - -{{< trueimage src="/images/CORE/Storage/EncryptionExample3.png" alt="Successfully unlocked Datasets" id="Successfully unlocked Datasets" >}} - -Click the **Continue** button in the dialog window that confirms that the unlocking was successful. -The dataset listing changes to show the unlocked icon. -{{< /expand >}} -## Encryption Management - -There are two ways to manage the encryption credentials, with either key files or passphrases. -{{< hint type=warning >}} -Always back up the key file to a safe and secure location! -{{< /hint >}} -### Key Files -Creating a new encrypted pool automatically generates a new key file and prompts you to download it. - -{{< trueimage src="/images/CORE/Storage/EncryptionKeyBackupWarning.png" alt="Encryption Backup Warning" id="Encryption Backup Warning" >}} -#### Pool Key File - -Manually download a copy of the inherited and non-inherited encrypted dataset key files for the pool by opening the pool menu and selecting **Export Dataset Keys**. Enter the root password and click **CONTINUE**. - -{{< trueimage src="/images/CORE/Storage/storagepoolexportdatasetkeys.png" alt="Exporting Key Files" id="Exporting Key Files" >}} - -#### Dataset Key File -To manually download a back up of a single key file for the dataset, click the dataset and select **Export Key**. -Enter the root password and click **CONTINUE**. Click **DOWNLOAD KEY**. - -To change the key, click the dataset and **Encryption Options**. - -{{< trueimage src="/images/CORE/Storage/storagepoolencryptionoptions.png" alt="Dataset Options: Encryption Options" id="Encryption Options" >}} - -Enter your custom key or click **Generate Key**. - -{{< trueimage src="/images/CORE/Storage/storagepoolgeneratekey.png" alt="Editing Encryption Options" id="Editing Encryption Options" >}} - -### Passphrases -{{< hint type=important >}} -The passphrase is the only means to decrypt the information stored in a dataset using passphrase encryption keys. Be sure to create a memorable passphrase or physically secure the passphrase. -{{< /hint >}} -To use a passphrase instead of a key file, click the dataset and **Encryption Options**. -Change the **Encryption Type** from **Key** to **Passphrase**. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsDatasetEncryptionPassphrase.png" alt="Dataset Encryption Passphrase Options" id="Dataset Encryption Passphrase Options" >}} - -Set the rest of the options: -* **Passphrase** is a user-defined string of eight to 512 characters in length, to use instead of an encryption key to decrypt the dataset. - -* **pbkdf2iters** is the number of password-based key derivation function 2 ([PBKDF2](https://tools.ietf.org/html/rfc2898#appendix-A.2)) iterations to use for reducing vulnerability to brute-force attacks. - Entering a number greater than **100000** is required. - -## Unlocking a Replicated Encrypted Dataset or Zvol Without a Passphrase - -TrueNAS Enterprise users can connect a Key Management Interoperability Protocol ([KMIP]({{< relref "/CORE/UIReference/System/KMIP.md" >}})) server to centralize keys when they are not using passphrases to unlock a dataset or zvol. - -Users with TrueNAS CORE or Enterprise installations without [KMIP]({{< relref "/CORE/UIReference/System/KMIP.md" >}}) should either replicate the dataset or zvol without properties to disable encryption at the remote end or construct a special json manifest to unlock each child dataset/zvol with a unique key. - -### Unlocking Methods -{{< expand "Method 1: Construct JSON Manifest" >}} -1. Replicate every encrypted dataset you want to replicate with properties. -2. Export key for every child dataset which has a unique key. -3. Construct a proper json for each child dataset with *poolname*/*datasetname* of the destination system and key from the source system. For example: - `{"tank/share01": "57112db4be777d93fa7b76138a68b790d46d6858569bf9d13e32eb9fda72146b"}` -5. Save this file with the extension .json. -6. Unlock the dataset(s) on the remote system using properly constructed json files. - -{{< /expand >}} -{{< expand "Method 2: Replicate Encrypted Dataset/zvol Without Properties" >}} -To not encrypt the dataset on the remote side so it does not require a key to unlock, clear properties when replicating. -1. Go to **Tasks > Replication Tasks** and click **ADD**. -2. Click **ADVANCED REPLICATION CREATION**. -3. Fill out the form as needed and do not select **Include Dataset Properties**. -4. Click **SUBMIT**. -{{< /expand >}} - -{{< hint type=tip >}} -This does not affect TrueNAS Enterprise installs with [KMIP]({{< relref "/CORE/UIReference/System/KMIP.md" >}}). -{{< /hint >}} - -## Legacy GELI Encryption - -TrueNAS no longer supports GELI encryption (deprecated). - -{{< expand "Can I directly convert a GELI-encrypted pool to native ZFS encryption?" "v" >}} -No. -You must migrate data out of the GELI pool and into a ZFS encrypted pool. -{{< /expand >}} - -### GELI Pool Migrations - -Data can be migrated from the GELI-encrypted pool to a new ZFS-encrypted pool. -Unlock the GELI-encrypted pool before attempting any data migrations. -The new ZFS-encrypted pool must be at least the same size as the previous GELI-encrypted pool. -Do not delete the GELI dataset until you verify the data migration. - -There are a few options to migrate data from a GELI-encrypted pool to a new ZFS-encrypted pool: -* Using the [Replication Wizard](#using-the-replication-wizard) -* Using [file transfer](#file-transfer-method) -* Using [ZFS send and receive](#zfs-send-and-receive) - -#### Using the Replication Wizard -GELI encrypted pools continue to be detected and supported in the TrueNAS web interface as **Legacy Encrypted** pools. -As of TrueNAS version 12.0-U1, a decrypted GELI pool can migrate data to a new ZFS encrypted pool using the Replication Wizard. -{{< expand "Replication Wizard Method" "v" >}} -Start the Replication Wizard, go to **Tasks** > **Replication Task** and click **ADD**. - -1. In **Source Location**, select **On this System**, then set the dataset to transfer. -2. In **Destination Location**, select **On a Different System**, then: - - a. Create or select an existing **SSH Connection**. - Either click **Create New** or select the destination system SSH connection from the list of available connections. - - b. In **Destination**, select the dataset to replicate files to. - - c. (Optional) Select **Encryption** to apply encryption to the SSH transfer. - Select either **PASSPHRASE** or **HEX** as the **Encryption Key Format**. - If you selected **PASSPHRASE**, enter the passphrase. If you selected **HEX**, set **Generate Encryption Key**. - Select **Store Encryption key in Sending TrueNAS database**. - Click **Next** - -3. Select **Run Once** as the replication schedule. -4. Clear the **Make Destination Dataset Read-Only** checkbox. -5. Click **START REPLICATION** -{{< /expand >}} -#### File Transfer Method -{{< hint type=important >}} -This method does not preserve file ACLs. -{{< /hint >}} -The web interface supports using **Tasks > Rsync Tasks** to transfer files out of the GELI pool. -{{< expand "File Transfer Method" "v" >}} -In the shell, `rsync` and other file transfer mechanisms (`scp`, `cp`, `sftp`, `ftp`, `rdiff-backup`) are available for copying data between pools. -{{< /expand >}} -#### ZFS Send and Receive -{{< hint type=important >}} -These instructions are an example walk-through, and not an exact step-by-step guide for all situations. -Research ZFS [send](https://openzfs.github.io/openzfs-docs/man/8/zfs-send.8.html)/[receive](https://openzfs.github.io/openzfs-docs/man/8/zfs-receive.8.html) before attempting this. -A simple example cannot cover every edge case. -{{< /hint >}} -{{< expand "ZFS Send and Receive Method" "v" >}} -Legend: - -* GELI pool = pool_a -* Origin dataset = dataset_1 -* Latest snapshot of GELI pool = snapshot_name -* ZFS native-encrypted pool = pool_b -* Receiving dataset = dataset_2 - -1. Create a new encrypted pool in **Storage > Pools**. -2. Open the shell. - Make a new snapshot of the GELI pool and dataset with the data to migrate. Enter command: - `zfs snapshot -r pool_a/dataset_1@snapshot_name`. -3. Create a passphrase: `echo passphrase > /tmp/pass`. -4. Use ZFS send/receive to transfer the data between pools. Enter command: - `zfs send -Rv pool_a/dataset_1@snapshot_name | zfs recv -o encryption=on -o keyformat=passphrase -o keylocation=file:///tmp/pass pool_b/dataset_2`. -5. After the transfer completes, go to **Storage > Pools** and lock the new dataset. - After locking the dataset, immediately unlock it. - TrueNAS prompts for the passphrase. - After entering the passphrase and unlocking the pool, you can delete the `/tmp/pass` file used for the transfer. -6. If desired, you can convert the dataset to use a key file instead of a passphrase. - To use a key file, click the dataset   (Options) and click **Encryption Options**. - Change the **Encryption Type** from **Passphrase** to **Key** and save. - Back up your key file immediately! -7. Repeat this process for every dataset in the pool that you need to migrate. -{{< /expand >}} diff --git a/content/CORE/CORETutorials/Storage/Pools/Zvols.md b/content/CORE/CORETutorials/Storage/Pools/Zvols.md deleted file mode 100644 index df39b051a7..0000000000 --- a/content/CORE/CORETutorials/Storage/Pools/Zvols.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "Adding Zvols" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/pools/zvols/" -description: "Describes how to create a Zvol on TrueNAS CORE." -weight: 19 -aliases: /core/storage/pools/zvols/ -tags: -- zvol -- storage ---- - -A ZFS Volume (Zvol) is a [dataset]({{< relref "/CORE/CORETutorials/Storage/Pools/Datasets.md" >}}) that represents a block device. -These are needed when configuring an [iSCSI Share]({{< relref "/CORE/CORETutorials/Sharing/iSCSI/AddingiSCSIShare.md" >}}). - -To create a zvol in a pool, go to **Storage > Pools** then click   and *Add Zvol*. - -## Options - -![StoragePoolsCreateZvol](/images/CORE/Storage/StoragePoolsCreateZvol.png "Creating a new Zvol") - -To quickly create a Zvol with the default options, enter a name for the Zvol, a size, and click **SAVE**. - -See [Zvols Screen]({{< relref "/CORE/UIReference/Storage/Pools/ZvolsScreen.md" >}}) for more information on zvol settings. - -### Setting Zvol Block Sizes - -To set the zvol block size, click **ADVANCED OPTIONS** on the **ADD ZVOL** screen. This adds the **Block Size** setting near the bottom of the screen. -Select that option that suits the use case or uses the information below to help determine the correct setting to use. - -{{< expand "Optimal Zvol Block Sizes" "v" >}} - -TrueNAS automatically recommends a space-efficient block size for new zvols. This table shows the minimum recommended volume block size values. To manually change this value, use the **Block size** dropdown list. - -{{< truetable >}} -| Configuration | Number of Drives | Optimal Block Size | -|---------------|------------------|--------------------| -| Mirror | N/A | 16k | -| Raidz-1 | 3 | 16k | -| Raidz-1 | 4/5 | 32k | -| Raidz-1 | 6/7/8/9 | 64k | -| Raidz-1 | 10+ | 128k | -| Raidz-2 | 4 | 16k | -| Raidz-2 | 5/6 | 32k | -| Raidz-2 | 7/8/9/10 | 64k | -| Raidz-2 | 11+ | 128k | -| Raidz-3 | 5 | 16k | -| Raidz-3 | 6/7 | 32k | -| Raidz-3 | 8/9/10/11 | 64k | -| Raidz-3 | 12+ | 128k | -{{< /truetable >}} - -Additional tuning might be required for optimal performance, depending on the workload. iXsystems engineers are available to assist [Enterprise](https://www.truenas.com/truenas-enterprise/) customers with tuning their TrueNAS hardware. The [workload tuning chapter](https://openzfs.github.io/openzfs-docs/Performance%20and%20Tuning/Workload%20Tuning.html) of the OpenZFS handbook is also a good resource. - -{{< /expand >}} - -## Managing Zvols - -To see options for an existing zvol, click next to the desired zvol in **Storage** > **Pools**: - -Use **Delete zvol** to remove the zvol from TrueNAS. -{{< hint type=warning >}} -Deleting zvols can result in unrecoverable data loss! -Be sure that any critical data is moved off the zvol or is otherwise obsolete. -{{< /hint >}} -Deleting a zvol also deletes all snapshots of that zvol. -Use **Edit Zvol** to open the zvol creation form to change the previously saved settings. -Similar to datasets, a zvol name cannot be changed. -Use **Create Snapshot** to take a single current-point-in-time image of the zvol and save it to **Storage > Snapshots**. -A snapshot name is suggested in **Name** along with an extra option to make the snapshot **Recursive** is available. - -When the selected zvol is cloned from an existing [snapshot]({{< relref "/CORE/CORETutorials/Storage/Snapshots.md" >}}), **Promote Dataset** is available. -When a clone is promoted, the original volume becomes a clone of the clone, making it possible to delete the volume that the clone was created from. -Otherwise, a clone cannot be deleted while the original volume exists. - -When the zvol is created with [encryption]({{< relref "/CORE/CORETutorials/Storage/Pools/StorageEncryption.md" >}}) enabled, additional **Encryption Actions** are displayed. diff --git a/content/CORE/CORETutorials/Storage/Pools/_index.md b/content/CORE/CORETutorials/Storage/Pools/_index.md deleted file mode 100644 index 4b51bc3822..0000000000 --- a/content/CORE/CORETutorials/Storage/Pools/_index.md +++ /dev/null @@ -1,163 +0,0 @@ ---- -title: "Pools" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/pools/" -description: "Provides instructions on creating and pool, and lists other pool and storage articles in TrueNAS CORE." -geekdocCollapseSection: true -weight: 10 -related: false -aliases: - - /core/storage/pools/poolcreate/ - - /core/coretutorials/storage/pools/poolcreate/ -tags: -- pools ---- - - -TrueNAS uses ZFS data storage *pools* to efficiently store and protect data. - -{{< expand "What is a pool?" "v" >}} -Storage *pools* are attached drives organized into virtual devices (vdevs). -Drives are arranged inside vdevs to provide varying amounts of redundancy and performance. -This allows for high performance pools, pools that maximize data lifetime, and all situations in between. - -ZFS and TrueNAS periodically reviews and heals whenever a bad block is discovered in a pool. -{{< /expand >}} - -## Review Storage Needs -We strongly recommend that you review the available system resources and plan the storage use case before creating a storage pool. -Review when: -* Storing critical information. More drives allocated to the pool increases redundancy. -* Maximizing total available storage at the expense of redundancy or performance means allocating large volume disks and configuring the pool for minimal redundancy. -* Maximizing pool performance means installing and allocating high-speed SSD drives to the pool. - -Determining your specific storage requirements is a critical step before creating a pool. - -You can use the [ZFS Capacity Calculator]({{< relref "/References/ZFSCapacityCalculator.md" >}}) and [ZFS Capacity Graph]({{< relref "/References/ZFSCapacityGraph.md" >}}) to compare configuration options. - -## Creating a Pool - -To create a new pool, go to **Storage > Pools** and click **ADD**. -The **Create or Import Pool** screen of the pool creation screens opens. -Select **Create new pool** and click **CREATE POOL** to open the **Pool Manager**. - -{{< trueimage src="/images/CORE/Storage/CreatePoolScreen.png" alt="Create Pool Manager" id="Create Pool Manager" >}} - -To begin, enter a name for the pool in **Name**. -Do not include spaces in the pool name as this could cause problems with other functions. - -{{< expand "Encryption?" "v" >}} -Encryption algorithms are available as an option for maximizing data security, however, this also complicates how data is retrieved and risks permanent data loss! -Refer to the [Encryption article]({{< relref "/CORE/CORETutorials/Storage/Pools/StorageEncryption.md" >}}) for more details and decide if encryption is necessary for your use case before setting any encryption options. -{{< /expand >}} - -Next, configure the virtual devices (vdevs) that make up the pool. - -### Using Suggest Layout - -Clicking **SUGGEST LAYOUT** allows TrueNAS to review all available disks and populate the primary data vdevs with identically sized drives in a balanced configuration between storage capacity and data redundancy. -To clear the suggestion, click **RESET LAYOUT**. - -To manually configure the pool, add vdevs according to your use case. -Select the **Disk** checkboxes and click the   to move the disks into the **Data VDevs** list. - -{{< hint type=important title="USB-Connected Disk Warning">}} -USB-connected disks might report their serial numbers inaccurately, making them indistinguishable from each other. -{{< /hint >}} - -### Using Vdev Types - -Pools have many different kinds of vdevs available. -These store data or enable unique features for the pool: - -{{< expand "Data" >}} -Standard vdev for primary storage operations. -Each storage pool requires at least one data vdev. -**Data** vdev configuration typically affects how the other kinds of vdevs are configured. - -#### Duplicating a Data VDev -A **Data VDev** with disks is duplicated by clicking **REPEAT**. -When more disks are available and equal in size, the **REPEAT** button creates another vdev with an identical configuration called a *mirror* of vdevs. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsAddCreateVdevRepeat.png" alt="Duplicating a Data VDev" id="Duplicating a Data VDev" >}} - -When even more same-size disks are available, you can create multiple copies of the original vdev. -{{< hint type=important >}} -Do not have multiple data vdevs with different numbers of disks in each vdev as this complicates and limits the pool capabilities. -{{< /hint >}} -{{< /expand >}} -{{< expand "Cache" >}} -[ZFS L2ARC]({{< relref "/References/L2ARC.md" >}}) read-cache is used with fast devices to accelerate read operations. -You can add or remove this after creating the pool. -{{< /expand >}} -{{< expand "Log" >}} -[ZFS LOG]({{< relref "/References/SLOG.md" >}}) is a device that improves synchronous write speeds. -You can add or remove this after creating the pool. -{{< /expand >}} -{{< expand "Hot Spare" >}} -**Hot Spare** sets up drives as reserved to insert into **Data** vdevs when an active drive fails. -Hot spares are temporarily used as replacements for failed drives to prevent larger pool and data loss scenarios. - -When a failed drive is replaced with a new drive, the hot spare reverts to an inactive state and is available again as a hot spare. - -When the failed drive is only detached from the pool, the temporary hot spare is promoted to a full data vdev member and is no longer available as a hot spare. -{{< /expand >}} -{{< expand "Metadata" >}} -Metadata vdevs are a special allocation class used to create [Fusion Pools]({{< relref "/CORE/CORETutorials/Storage/Pools/FusionPool.md" >}}) for increased metadata and small block I/O performance. -{{< /expand >}} -{{< expand "Dedup" >}} -**Dedup** vdevs store [ZFS de-duplication]({{< relref "/References/ZFSDeduplication.md" >}}). -Requires allocating *X* GiB for every *X* TiB of general storage. -For example, 1 GiB of dedup vdev capacity for every 1 TiB of data vdev availability. -{{< /expand >}} - -To add a different vdev type during pool creation, click **ADD VDEV** and select the type. -Select disks from **Available Disks** and use the   (right arrow) next to the new **VDev** to add it to that section. - -### Vdev Layout - -Disks added to a vdev arrange in different layouts, according to the specific pool use case. - -{{< expand "Can I create vdevs with different layouts in one pool?" "v" >}} -Adding multiple vdevs with different layouts to a pool is not supported. -Create a new pool when a different vdev layout is required. -For example, *pool1* has a data vdev in a *mirror* layout, so create *pool2* for any *raid-z* vdevs. -{{< /expand >}} -{{< expand "Stripe" >}} -Each disk is used to store data. -Requires at least one disk and has no data redundancy. -{{< hint type=warning >}} -Never use a stripe type vdev to store critical data! -A single disk failure results in losing all data in the vdev. -{{< /hint >}} -{{< /expand >}} -{{< expand "Mirror" >}} -Data is identical in each disk. -Requires at least two disks, has the most redundancy, and the least capacity. -{{< /expand >}} -{{< expand "RAIDZ1" >}} -Uses one disk for parity while all other disks store data. -Requires at least three disks. -{{< /expand >}} -{{< expand "RAIDZ2" >}} -Uses two disks for parity while all other disks store data. -Requires at least four disks. -{{< /expand >}} -{{< expand "RAIDZ3" >}} -Uses three disks for parity while all other disks store data. -Requires at least five disks. -{{< /expand >}} - -The **Pool Manager** suggests a vdev layout from the number of disks added to the vdev. -For example, if adding two disks, TrueNAS automatically configures the vdev as a mirror, where the total available storage is the size of one added disk while the other disk provides redundancy. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsAddCreateMirror.png" alt="Mirrored Vdev" id="Mirrored Vdev" >}} - -To change the vdev layout, open the **Data VDevs** list and select the desired layout. - -
- -## Pool Articles - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/CORETutorials/Storage/SED.md b/content/CORE/CORETutorials/Storage/SED.md deleted file mode 100644 index 262b09398b..0000000000 --- a/content/CORE/CORETutorials/Storage/SED.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: "Self-Encrypting Drives" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/sed/" -description: "Describes Self-Encrypting Drive (SED) support on TrueNAS CORE." -weight: 40 -aliases: /core/storage/sed/ -tags: -- sed -- storage -- encryption ---- - -TrueNAS version 11.1-U5 introduced Self-Encrypting Drive (SED) support. - -## Supported Specifications - -* Legacy interface for older ATA devices (Not recommended for security-critical environments!) -* [TCG Opal 1](https://trustedcomputinggroup.org/wp-content/uploads/Opal_SSC_1.00_rev3.00-Final.pdf) legacy specification -* [TCG OPAL 2](https://trustedcomputinggroup.org/wp-content/uploads/TCG_Storage-Opal_SSC_v2.01_rev1.00.pdf) standard for newer consumer-grade devices -* [TCG Opalite](https://trustedcomputinggroup.org/wp-content/uploads/TCG_Storage-Opalite_SSC_FAQ.pdf) which is a reduced form of OPAL 2 -* TCG Pyrite [Version 1](https://trustedcomputinggroup.org/wp-content/uploads/TCG_Storage-Pyrite_SSC_v1.00_r1.00.pdf) and - [Version 2](https://trustedcomputinggroup.org/wp-content/uploads/TCG_Storage-Pyrite_SSC_v2.00_r1.00_PUB.pdf) are similar to Opalite, but with hardware encryption removed - Pyrite provides a logical equivalent of the legacy ATA security for non-ATA devices. Only the drive firmware protects the device. - {{< hint type=warning >}} - Pyrite Version 1 SEDs do not have PSID support and can become unusable if the password is lost. - {{< /hint >}} -* [TCG Enterprise](https://trustedcomputinggroup.org/wp-content/uploads/TCG_Storage-SSC_Enterprise-v1.01_r1.00.pdf) designed for systems with many data disks - These SEDs cannot unlock before the operating system boots. - -See this Trusted Computing Group and NVM Express® [joint white paper](https://nvmexpress.org/wp-content/uploads/TCGandNVMe_Joint_White_Paper-TCG_Storage_Opal_and_NVMe_FINAL.pdf) for more details about these specifications. - -## TrueNAS Implementation - -TrueNAS implements the security capabilities of [camcontrol](https://www.freebsd.org/cgi/man.cgi?query=camcontrol) for legacy devices and [sedutil-cli](https://www.mankier.com/8/sedutil-cli) for TCG devices. - -A SED can be configured before or after assigning the device to a pool. - -By default, SEDs are not locked until the administrator takes ownership of them. Ownership is taken by explicitly configuring a global or per-device password in the web interface and adding the password to the SEDs. Adding SED passwords in the web interface also allows TrueNAS to automatically unlock SEDs. - -A password-protected SED protects the data stored on the device when the device is physically removed from the system. This allows secure disposal of the device without having to first wipe the contents. Repurposing a SED on another system requires the SED password. - -{{< hint type=note >}} -For TrueNAS High Availability (HA) systems, SED drives only unlock on the active controller! -{{< /hint >}} - -## Deploying SEDs - -TrueNAS supports setting a global password for all detected SEDs or setting individual passwords for each SED. Using a global password for all SEDs is strongly recommended to simplify deployment and avoid maintaining separate passwords for each SED. - -### Setting a Global Password for SEDs - -Go to **System > Advanced > SED Password** and enter the password. - -{{< hint type=warning >}} -Record this password and store it in a safe place! -{{< /hint >}} - -### Creating Separate Passwords for Each SED - -Go to **Storage > Disks**. Click the **>** next to an SED, then select **Edit**. Enter and confirm the password in the **SED Password** field. - -You must configure the SED to use the new password. Repeat this process for each SED and any SEDs added to the system in the future. - -{{< hint type=warning >}} -Remember SED passwords! If you lose the SED password, you cannot unlock SEDs or access their data. -Always record SED passwords whenever they are configured or modified and store them in a secure place! -{{< /hint >}} - -## Check SED Functionality - -When SED devices are detected during system boot, TrueNAS checks for configured global and device-specific passwords. - -Unlocking SEDs allows a pool to contain a mix of SED and non-SED devices. Devices with individual passwords are unlocked with their password. Devices without a device-specific password are unlocked using the global password. diff --git a/content/CORE/CORETutorials/Storage/Snapshots.md b/content/CORE/CORETutorials/Storage/Snapshots.md deleted file mode 100644 index d3ffd92989..0000000000 --- a/content/CORE/CORETutorials/Storage/Snapshots.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: "Creating Snapshots" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/snapshots/" -description: "Describes how to create snapshots on TrueNAS CORE." -weight: 20 -aliases: - - /core/storage/snapshots/ - - /core/uireference/storage/snapshots/ -tags: -- snapshots ---- - -{{< include file="/static/includes/SnapshotsIntroSnippet.md" >}} - -Taking snapshots requires the system have all [pools]({{< relref "/CORE/CORETutorials/Storage/Pools/_index.md" >}}), [datasets]({{< relref "/CORE/CORETutorials/Storage/Pools/datasets.md" >}}), and [zvols]({{< relref "/CORE/CORETutorials/Storage/Pools/zvols.md" >}}) already configured. - -## Creating a Single Snapshot - -{{< hint type=tip >}} -Consider making a [Periodic Snapshot Task]({{< relref "/CORE/UIReference/Tasks/PeriodicSnapshotTasks.md" >}}) to save time and create regular, fresh snapshots. -{{< /hint >}} - -To perform a quick snapshot of existing storage, go to **Storage > Snapshots** and click **ADD**. - -![StorageSnapshotsAdd](/images/CORE/Storage/StorageSnapshotsAdd.png "Create a New Snapshot") - -Use the **Dataset** dropdown list to select an existing ZFS pool, dataset, or zvol to snapshot. - -The TrueNAS software displays a suggested name that you can override with any custom string. - -To include the snapshot in [local]({{< relref "LocalReplication.md" >}}) or [remote]({{< relref "RemoteReplication.md" >}}) replication tasks choose a proper naming schema. The **Naming Schema** drop-down list populates with schemas already created from periodic snapshot tasks. - -To include child datasets with the snapshot, select **Recursive**. - -## Managing Snapshots - -Go to **Storage > Snapshots** to manage created snapshots. - -![StorageSnapshots](/images/CORE/Storage/StorageSnapshots.png "List of Created Snapshots") - -Each entry in the list includes the dataset and snapshot names. -Click to view options for a snapshot. - -**DATE CREATED** shows the exact time and date of the snapshot creation. - -**USED** shows the amount of space consumed by this dataset and all of its descendants. -This value, checked against the dataset quota and reservation, shows the space used but does not include the dataset reservation. It takes into account the reservations of any descendant datasets. -The amount of space that a dataset consumes from its parent, and the amount of space freed if this dataset is recursively deleted, is the greater of its space used and its reservation. - -At creation, a snapshot shares space between the snapshot, file system, and even with previous snapshots. -File system changes reduce the shared space and count toward space used by a snapshot. -Deleting a snapshot often increases the space that is unique and used in other snapshots. - -**REFERENCED** shows the amount of data accessible by this dataset. This could be shared with other datasets in the pool. New snapshots or clones reference the same amount of space as the file system it was created from, as the contents are identical. - -### Deleting a Snapshot - -{{< include file="/static/includes/DeletingSnapshots.md" >}} - -### Cloning a Snapshot - -Use **CLONE TO NEW DATASET** to create a new snapshot *clone* (dataset) from the snapshot contents. - -{{< expand "What is a clone?" "v" >}} -A *clone* is a writable copy of the snapshot. -Because a clone is actually a mountable dataset, it appears in the **Pools** screen rather than the **Snapshots** screen. -Creating a new snapshot adds **-clone** to the name by default. -{{< /expand >}} -A dialog prompts for the new dataset name. -The suggested name derives from the snapshot name. - -### Rolling Back -Reverts the dataset back to the point in time saved by the snapshot. - -{{< hint type=important >}} -Rollback is a dangerous operation that causes any configured replication tasks to fail. -Replications use the existing snapshot when doing an incremental backup, and rolling back can put the snapshots out of order. -To restore the data within a snapshot, the recommended steps are: - -1. Clone the desired snapshot. - -2. Share the clone with the share type or service running on the TrueNAS system. - -3. Allow users to recover their needed data. - -4. Delete the clone from **Storage > Pools**. - -This approach does not destroy any on-disk data and has no impact on replication. -{{< /hint >}} - -TrueNAS asks for confirmation before rolling back to the chosen snapshot state. -Clicking **Yes** reverts all dataset files to the state they were in at the time of snapshot creation. - -## Bulk Operations - -{{< include file="/static/includes/SnapshotsBulkOperations.md" >}} - -## Browsing a Snapshot Collection - -{{< include file="/static/includes/BrowsingSnapshotCollections1.md" >}} - -A user with permission to access the hidden file can view and explore all snapshots for a dataset from the shell or the **Sharing** screen using services like **SMB**, **NFS**, and **SFTP**. - -{{< include file="/static/includes/BrowsingSnapshotCollections2.md" >}} diff --git a/content/CORE/CORETutorials/Storage/VMware-Snapshots.md b/content/CORE/CORETutorials/Storage/VMware-Snapshots.md deleted file mode 100644 index 2e1acfc3bf..0000000000 --- a/content/CORE/CORETutorials/Storage/VMware-Snapshots.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "Creating VMware-Snapshots" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/vmware-snapshots/" -description: "Describes how to create a VMWare snapshot on TrueNAS CORE." -weight: 30 -aliases: - - /core/storage/vmware-snapshots/ - - /core/uireference/storage/vmware-snapshots/ - - /core/storage/vmware-snapshots/-2 -tags: -- snapshots ---- - -**Storage** > **VMware-Snapshots** coordinates ZFS snapshots when using TrueNAS as a VMware datastore. -When a ZFS snapshot is created, TrueNAS automatically snapshots any running VMware virtual machines before taking a scheduled or manual ZFS snapshot of the dataset or zvol backing that VMware datastore. - -To copy TrueNAS snapshots to VMWare, virtual machines must be powered-on. -The temporary VMware snapshots are then deleted on the VMware side but still exist in the ZFS snapshot and are available as stable restore points. -These coordinated snapshots go on the **Storage > Snapshots** list. - -{{< hint type=note >}} -You need a paid-edition for VMware ESXi to use VMware-Snapshots. -If you try to use them with ESXi free edition you see the following error message: **Error: Can't create snapshot, current license or ESXi version prohibits execution of the requested operation.** -ESXi free has a locked (read-only) API that prevents using TrueNAS VMware-Snapshots. -The cheapest ESXi edition that is compatible with TrueNAS VMware-Snapshots is **VMware vSphere Essentials Kit**. -{{< /hint >}} - -## Create a VMware Snapshot - -Go to **Storage > VMware Snapshots** and click **ADD**. - -![StorageVMwareSnapshotsAdd](/images/CORE/Storage/StorageVMwareSnapshotsAdd.png "Creating a VMware Snapshot") - -After entering the **Hostname**, **Username**, and **Password**, click **FETCH DATASTORES** to populate the menu and then select the datastore to synchronize. - -TrueNAS connects to the VMware host after clicking *FETCH DATASTORES*. -The **ZFS Filesystem** and **Datastore** drop-down menus populate from the VMware host response. -Choosing a datastore also selects any previously mapped dataset. diff --git a/content/CORE/CORETutorials/Storage/_index.md b/content/CORE/CORETutorials/Storage/_index.md deleted file mode 100644 index e3c8c3d655..0000000000 --- a/content/CORE/CORETutorials/Storage/_index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Storage" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/storage/" -description: "Tutorials about different TrueNAS storage management topics." -geekdocCollapseSection: true -weight: 90 -related: false ---- - -{{< children depth="2" description="true" >}} diff --git a/content/CORE/CORETutorials/SystemConfiguration/ConfiguringACMEDNS.md b/content/CORE/CORETutorials/SystemConfiguration/ConfiguringACMEDNS.md deleted file mode 100644 index 89bde889c0..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/ConfiguringACMEDNS.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "Configuring ACME DNS" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/configuringacmedns/" -description: "Describes how to configure ACME on the open-source supported TrueNAS CORE." -weight: 160 -aliases: - - /core/system/acmedns -tags: -- acme -- certificates ---- - -{{< hint type=note >}} -This feature is only available in the open-source supported TrueNAS CORE. -{{< /hint >}} - -[Automatic Certificate Management Environment (ACME)](https://ietf-wg-acme.github.io/acme/draft-ietf-acme-acme.html) is available for automating certificate issuing and renewal. -The user must verify ownership of the domain before certificate automation is allowed. - -ACME certificate automation requires an ACME DNS Authenticator and a [Certificate Signing Request]({{< relref "/CORE/UIReference/System/Certificates.md" >}}). - -## Adding ACME DNS Authenticators - -Go to **System > ACME DNS** and click **ADD**. - -![SystemACMEDNSAdd](/images/CORE/System/SystemACMEDNSAdd.png "ACME DNS Add") - -Name the authenticator. -Leave **Authenticator** set to **Route53**. -Enter the **Access ID Key** and **Secret Access Key** from Amazon. - -{{< hint type=note title="Supported DNS Providers" >}} -Amazon Route 53 is the only supported DNS provider in TrueNAS CORE. -See the [AWS documentation](https://aws.amazon.com/premiumsupport/knowledge-center/create-access-key/) for more details about generating the **Access ID Key** and **Secret Access Key**. -{{< /hint >}} - -Click **SUBMIT** to register the DNS Authenticator and add it to the authenticator options for ACME Certificates. - -## Creating ACME Certificates - -![SystemCertificatesAddACMECertificate](/images/CORE/System/SystemCertificatesAddACMECertificate.png "Create an ACME Certificate") - -You can create ACME certificates for existing certificate signing requests. -The certificates use an ACME DNS authenticator to confirm domain ownership. Then, they are automatically issued and renewed. - -To create a new ACME certificate, go to **System > Certificates**, click (Options) for an existing certificate signing request, and select **Create ACME Certificate**. - -Give the ACME certificate an identifier (name), and accept the TOS by setting **Terms of Service**. - -For the **Authenticator**, select the ACME DNS authenticator you created, then click **SUBMIT**. diff --git a/content/CORE/CORETutorials/SystemConfiguration/ConfiguringFailover.md b/content/CORE/CORETutorials/SystemConfiguration/ConfiguringFailover.md deleted file mode 100644 index 68f274c927..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/ConfiguringFailover.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: "Configuring Failover (HA)" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/configuringfailover/" -description: "Describes how to configure failover on TrueNAS CORE Enterprise." -weight: 150 -aliases: - - /hub/tasks/advanced/high-availability/ - - /core/system/failover/ -tags: -- HA -- failover ---- - -{{< enterprise >}} -This article only applies to licensed TrueNAS Enterprise High availability (HA) systems. -Contact the [iXsystems Sales Team](mailto:sales@ixsystems.com) to inquire about purchasing TrueNAS Enterprise licenses. -{{< /enterprise >}} - -{{< hint type=warning >}} -**Warning:** -To avoid the potential for data loss, [contact iXsystems](https://www.truenas.com/contact-us/) before replacing a controller or upgrading to High Availability. -{{< /hint >}} - -## Configure High Availability (HA) - -Power on both system controllers and log in to the web interface for one of them. -For first-time logins, TrueNAS prompts you to upload the TrueNAS Enterprise License. -Otherwise, go to **System > Support** and update the license. - -![SystemSupportLicenseEnterprise](/images/CORE/System/SystemSupportLicenseEnterprise.png "Enterprise License") - -Paste the HA license received from iXsystems and save it. -The license contains the serial numbers for both units in the chassis. -Activating an HA license adds the **System > Failover** screen and modifies fields throughout the UI so that you can configure hostnames and IP addresses for both controllers. - -After configuring HA, an icon displays when HA is active or unavailable. -When the system administrator disables HA, the status icon changes to show HA is unavailable. -If the standby TrueNAS controller is not available because it is powered off, still starting up, disconnected from the network, or does not have failover configured, the status icon changes to show HA is unavailable. -HA also becomes unavailable if the controllers have different numbers of disks. - -If both TrueNAS controllers reboot simultaneously, you must enter the passphrase for an encrypted pool at the web interface login screen. - -### Networking - -To ensure system networking is configured for HA, go to **Network > Global Configuration**. - -![NetworkGlobalConfigurationHAEnterprise](/images/CORE/Network/NetworkGlobalConfigurationHAEnterprise.png "Network Config for Enterprise HA") - -You can set the host names for both controllers and a virtual host name that reaches whichever controller is currently active. - -Next, go to **Network > Interfaces** and edit the primary interface. - -{{< hint type=important >}} -Editing interfaces is disabled when HA is active. -To disable HA, go to **System > Failover** and disable failover. -Edit the interface, then reactivate failover immediately. -TrueNAS automatically synchronizes the configuration changes to the standby controller -{{< /hint >}} - -![NetworkInterfaceEditHAEnterprise](/images/CORE/Network/NetworkInterfaceEditHAEnterprise.png "Network Interface Edit for Enterprise HA") - -You can designate the interface as critical for failover and combine multiple interfaces into a failover group. -There are also options to configure IP addresses for each controller and a virtual IP address with virtual host ID for administrative access. - -After the network configuration is complete, log out and log back in using the virtual IP address. -You can now configure pools and shares as usual, and configuration automatically synchronizes between the active and standby TrueNAS controllers. - -All subsequent logins should use the virtual IP address. -Connecting directly to the standby TrueNAS controller with a browser does not allow web interface logins. - -When troubleshooting HA networking, the ifconfig command adds two additional fields to the output to help with failover troubleshooting: **CriticalGroup** and **Interlink**. - -## Enable Failover - -To make general changes to the Failover settings, go to **System > Failover** - -![System Failover Enterprise](/images/CORE/System/SystemFailoverEnterprise.png "HA Failover Options") - -You can manually disable failover on this screen. - -Make sure to set one of the controllers as the default so that it becomes active when both boot simultaneously. -Booting an HA pair with failover disabled causes both TrueNAS controllers to come up in standby mode. -In this situation, the web interface shows an option to force a TrueNAS controller to activate. - -To have the system wait to failover during a network timeout, replace *0* with a new number of seconds. - -{{< hint type=warning >}} -Do not sync the TrueNAS configuration unless directed by an iXsystems Support Engineer! -TrueNAS automatically synchronizes the system configuration. The manual sync options are only for dangerous or high-risk troubleshooting situations. -{{< /hint >}} diff --git a/content/CORE/CORETutorials/SystemConfiguration/ConfiguringKMIP.md b/content/CORE/CORETutorials/SystemConfiguration/ConfiguringKMIP.md deleted file mode 100644 index 30aa7c9a08..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/ConfiguringKMIP.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "Configuring KMIP" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/configuringkmip/" -description: "Describes how to configure KMIP on TrueNAS CORE Enterprise." -weight: 170 -tags: -- kmip -- enterprise ---- - -{{< enterprise >}} -KMIP is only available for TrueNAS Enterprise licensed systems. -Contact the [iXsystems Sales Team](mailto:sales@ixsystems.com) to inquire about purchasing TrueNAS Enterprise licenses. -{{< /enterprise >}} - - - -The [Key Management Interoperability Protocol (KMIP)](https://docs.oasis-open.org/kmip/spec/v1.1/os/kmip-spec-v1.1-os.html) is an extensible client/server communication protocol for storing and maintaining keys, certificates, and secret objects. -KMIP on TrueNAS Enterprise integrates the system within an existing centralized key management infrastructure and uses a single trusted source for creating, using, and destroying SED passwords and ZFS encryption keys. - -Keys can be created on a single server and then retrieved by TrueNAS. -Keys wrapped within keys, symmetric, and asymmetric keys are supported. -Alternately, KMIP can be used for clients to ask a server to encrypt or decrypt data without the client ever having direct access to a key. -KMIP also can be used to sign certificates. - -{{< expand "Requirements" "v" >}} -You need to have a KMIP server available with certificate authorities and certificates you can import into TrueNAS. -Have the KMIP server configuration open in a separate browser tab or copy the KMIP server certificate string and private key string to later paste into the TrueNAS web interface. -This helps simplify the TrueNAS connection process. -{{< /expand >}} - -## Connecting TrueNAS to a KMIP Server - -To connect TrueNAS to a KMIP server, import a [Certificate Authority (CA)]({{< relref "CAs.md" >}}) and [Certificate]({{< relref "/CORE/UIReference/System/Certificates.md" >}}) from the KMIP server, then configure the KMIP options. - -{{< expand "How do I import these?" "v" >}} -Log in to the TrueNAS web interface and go to **System** > **CAs** and click **ADD**. -In the **Type** drop down menu, select **Import CA**. -Enter a memorable **Name** for the CA, then paste the KMIP server **Certificate** and **Private Key** strings into the related fields. -Leave the **Passphrase** empty and click **Submit**. - -Next, go to **System** > **Certificates** and click **ADD**. -In the **Type** drop down menu, select **Import Certificate**. -Enter a memorable **Name** for the certificate and paste the KMIP server **Certificate** and **Private Key** strings into the related TrueNAS fields. -Leave the **Passphrase** empty and click **SUBMIT**. -{{< /expand >}} - -For security reasons, we strongly recommend protecting the CA and Certificate values. - -### Configuring KMIP in TrueNAS - -Go to **System > KMIP**. - -![SystemKMIP](/images/CORE/System/SystemKMIP.png "KMIP Options") - -Enter the central key server *Server* host name or IP address and the number of an open connection *Port* on the key server. -Select the *Certificate* and *Certificate Authority* that you imported from the central key server. -To ensure the Certificate and CA chain is correct, set *Validate Connection* and click *SAVE*. - -When the certificate chain verifies, choose the encryption values, SED passwords, or ZFS data pool encryption keys to move to the central key server. -Set *Enabled* to begin moving the passwords and keys immediately after clicking *SAVE*. - -Refresh the **KMIP** screen to show the current **KMIP Key Status**. - -![SystemKMIPKeyStatus](/images/CORE/System/SystemKMIPKeyStatus.png "Example Key Synced") - -If you want to cancel a pending key synchronization, set *Force Clear* and click *SAVE*. diff --git a/content/CORE/CORETutorials/SystemConfiguration/ConfiguringSSHConnections.md b/content/CORE/CORETutorials/SystemConfiguration/ConfiguringSSHConnections.md deleted file mode 100644 index 8458733be7..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/ConfiguringSSHConnections.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "Configuring SSH Connections" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/configuringsshconnections/" -description: "Provides information on how to configure Secure Socket Shell (SSH) connections on your TrueNAS." -weight: 110 -aliases: - - /core/system/systemssh -tags: -- ssh ---- - -[Secure Socket Shell (SSH)](https://searchsecurity.techtarget.com/definition/Secure-Shell) is a cryptographic network protocol. It provides a secure method to access and transfer files between two hosts. This is possible even if the two hosts use an unsecured network. -SSH establishes secure connections by means of user account credentials. It also uses key pairs shared between host systems for authentication. - -## Create SSH Keypairs - -TrueNAS generates and stores [RSA-encrypted](https://tools.ietf.org/html/rfc8017) SSH public and private keypairs in **System > SSH Keypairs**. -The system typically uses keypairs when configuring **SSH Connections** or SFTP **Cloud Credentials**. -Encrypted keypairs or keypairs with passphrases are not supported. - -Creating a new **SSH Connection** or **Replication** task generates new keypairs. -To manually generate a new keypair, go to **System > SSH Keypairs**, click **ADD**, and give the keypair a unique name. - -![System SSH Keypairs Add](/images/CORE/System/SystemSSHKeypairsAdd.png "System SSH Keypairs Add") - -Click **GENERATE KEYPAIR** to add values to the public and private key fields. -Copy these strings or download them into text files for later use. - -## Create SSH Connections - -### Semi-Automatic - -TrueNAS offers a semi-automatic setup mode for setting up an SSH connection. This simplifies setting up an SSH connection with another FreeNAS or TrueNAS system. In semi-automatic setup mode it is not necessary to log in to the remote system to transfer SSH keys. - -Semi-automatic setup requires an SSH keypair on the local system. You must have administrator account credentials for the remote TrueNAS. You must also configure the remote system to allow root access with SSH. - -The semi-automatic configuration can generate the needed keypair. You can manually create the keypair by going to **System > SSH Keypairs**. - -Go to **System > SSH Connections** and click **ADD**. - -![SystemSSHConnectionsAddSemiAuto](/images/CORE/System/SystemSSHConnectionsAddSemiAuto.png "Semi-Auto Connection") - -Use a valid URL scheme for the remote TrueNAS URL. -Leave the username as **root** and enter the account password for the remote TrueNAS system. -You can import the existing private key created from an SSH keypair, or create a new private key with a new SSH keypair. - -Save the new configuration. TrueNAS opens a connection to the remote TrueNAS and exchanges SSH keys. - -### Manual Configuration - -You can configure a secure SSH connection that does not generate a password prompt. This involves copying a public encryption key from the local system to the remote system. - -#### Adding a SSH Public Key to the TrueNAS Root Account - -Log in to the TrueNAS system that generated the SSH keypair and go to **System > SSH Keypairs**. -Open the keypair you want to use for the SSH connection. Copy the text of the SSH public key or download the public key as a text file. - -Log in to the TrueNAS system that needs to register the public key. Go to **Accounts > Users** and edit the *root* account. -Paste the SSH public key text into the **SSH Public Key** field. - -![Accounts Users Root SSH Key](/images/CORE/Accounts/AccountsUsersRootSSHKey.png "Accounts Users Root SSH Key") - -Generate a new SSH keypair in **System > SSH Keypairs**. Copy or download the value for the public key and add it to the remote NAS. -If the remote NAS is not a TrueNAS system, please see the system documentation on adding a SSH public key. - -#### Manually Configuring the SSH Connection on the Local TrueNAS - -Log back into the local TrueNAS system and go to **System > SSH Connections**. Add a new connection and change the setup method to **Manual**. - -![SystemSSHConnectionsAddManual](/images/CORE/System/SystemSSHConnectionsAddManual.png "SSH Connections: Manual Options") - -Select the private key from the SSH keypair you used when you transferred the public key on the remote NAS. diff --git a/content/CORE/CORETutorials/SystemConfiguration/ConfiguringTunables.md b/content/CORE/CORETutorials/SystemConfiguration/ConfiguringTunables.md deleted file mode 100644 index 70b3332142..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/ConfiguringTunables.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "Configuring Tunables" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/configuringtunables/" -description: "Describes how to add or edit tunables on TrueNAS CORE." -weight: 120 -tags: -- tunables ---- - -{{< hint type=warning >}} -Be careful when adding or editing the default tunables. -Changing the default tunables can make the system unusable. -{{< /hint >}} - -TrueNAS allows you to add system tunables from the web interface. -You can manually define tunables, or TrueNAS can run an [autotuning script]({{< relref "/CORE/UIReference/System/Advanced.md" >}}) to attempt to optimize the system. -Tunables are used to manage TrueNAS [sysctls](https://www.freebsd.org/cgi/man.cgi?query=sysctl), loaders, and [rc.conf](https://www.freebsd.org/cgi/man.cgi?query=rc.conf) options. - -* *loader* specifies parameters to pass to the kernel or load additional modules at boot time. -* *rc.conf* enables system services and daemons and only takes effect after a reboot. -* *sysctl* configures kernel parameters while the system is running and generally takes effect immediately. - -{{< hint type=important >}} -Adding a sysctl, loader, or rc.conf option is an advanced feature. -A sysctl immediately affects the kernel running the TrueNAS system, and a loader can adversely affect the TrueNAS boot process. -Do not create a tunable on a production system before testing the ramifications of that change. -{{< /hint >}} - -## Configure Tunables - -To configure a tunable, go to **System > Tunables** and click **ADD**. - -![SystemTunablesAdd](/images/CORE/System/SystemTunablesAdd.png "Adding a Tunable") - -Select the **Type** of tunable to add or modify. -Enter the name of the *loader*, *sysctl*, or *rc.conf* variable to configure. - -Next, enter the value to use for the [loader](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/boot-introduction.html#boot-loader-commands), [sysctl](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/configtuning-sysctl.html), or [rc.conf](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/config-tuning.html). - -If you wish to create the system tunable but not immediately enable it, unset the **Enabled** checkbox. -Configured tunables remain in effect until deleted or **Enabled** is unset. - -We recommend restarting the system after making sysctl changes. -Some sysctls only take effect at system startup, and restarting the system guarantees that the setting values correspond with what the running system uses. - -## Autotuning - -TrueNAS provides an autotune script that optimizes the system depending on the installed hardware. - -{{< expand "Is this script available somewhere?" "v" >}} -To see which checks are performed, find the autotune script in /usr/local/bin/autotune. -{{< /expand >}} - -For example, if a pool exists on a system with limited RAM, the autotune script automatically adjusts some ZFS sysctl values to minimize memory starvation issues. -Autotuning can introduce system performance issues. You must only use it as a temporary measure until you address the underlying hardware issue. -Autotune always slows a RAM-starved system as it caps the ARC. - -{{< hint type=warning >}} -We do not recommend TrueNAS Enterprise customers use the autotuning script, as it can override any specific tunings made by iXsystems Support. -{{< /hint >}} - -Enabling autotune runs the autotuner script at boot. -To run the script immediately, reboot the system. - -Any tuned settings appear in **System > Tunables**. - -{{< expand "Can I manually tune a setting controlled by the autotuner?" "v" >}} -Deleting tunables created by the autotune only affects the current session. -Autotune-set tunables regenerate every time the system boots. -You cannot manually tune any setting the autotuner controlls. - -To permanently change a value set by autotune, change the description of the tunable. -For example, changing the description to "*manual override*" prevents autotune from reverting the tunable back to the autotune default value. -{{< /expand >}} diff --git a/content/CORE/CORETutorials/SystemConfiguration/ConfiguringtheSystemEmail.md b/content/CORE/CORETutorials/SystemConfiguration/ConfiguringtheSystemEmail.md deleted file mode 100644 index 208d8fa25c..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/ConfiguringtheSystemEmail.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Configuring the System Email" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/configuringthesystememail/" -description: "Provides information on how to set up system email on TrueNAS CORE." -weight: 60 -aliases: - - /core/system/email -tags: -- email ---- - -An automatic script sends a nightly email to the administrator (root) account containing important information such as issues with the health of the disks, or other system functions. -Alerts sent are based on the default options set on the **Alerts Settings** screen. -TrueNAS emails alert events to the email set up for the root user account. - -## Configure the Root Email Address - -Go to **Accounts > Users**, click next to the **root** user, then click **Edit**. -Enter a remote email address for the system administrator that regularly monitors the system in **Email**, then click **SAVE**. - -Configuring user email addresses follows the same process. - -## Configure the System Email - -Go to **System > Email** and enter a **From Name** for system emails. - -Next, select a **Send Mail Method** and fill out the remaining fields (SMTP) or log in (GMail OAuth). - -Click **SEND TEST MAIL** to verify the configured email settings are working. -If the test email fails, double-check that the root user **Email** field is correctly configured. \ No newline at end of file diff --git a/content/CORE/CORETutorials/SystemConfiguration/CreatingAlerts.md b/content/CORE/CORETutorials/SystemConfiguration/CreatingAlerts.md deleted file mode 100644 index d3607b8d9f..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/CreatingAlerts.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "Creating Alerts" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/creatingalerts/" -description: "Describes how to create an alert on TrueNAS CORE." -weight: 90 -aliases: - - /core/system/alert/ -tags: -- alerts ---- - -The alert system integrates with various third-party services. -Tuning alerts helps personalize TrueNAS to any highly-sensitive issues. - -## Add an Alert Service - -Go to **System > Alert Services** and click **ADD**. - -![SystemAlertServicesAdd](/images/CORE/System/SystemAlertServicesAdd.png "New Alert Service") - -Choose a **Type** and fill out the options specific to that alert service, then test the service configuration by clicking **SEND TEST ALERT**. - -## Customize Alert Settings - -Go to **System > Alert Settings**. - -![System Alert Settings](/images/CORE/System/SystemAlertSettings.png "Alert Settings") - -The UI groups alerts based on type. -For example, alerts related to pools appear in the **Storage** alert section. - -Customize each alert **Warning Level** and **Frequency** using the drop-down menus. - -Changing any of these options affects every configured alert service. - -Click **SAVE** before leaving the page. diff --git a/content/CORE/CORETutorials/SystemConfiguration/CreatingCAsandCertificates/CreatingCertificateAuthorities.md b/content/CORE/CORETutorials/SystemConfiguration/CreatingCAsandCertificates/CreatingCertificateAuthorities.md deleted file mode 100644 index 2fff7582d3..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/CreatingCAsandCertificates/CreatingCertificateAuthorities.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: "Creating Certificate Authorities (CAs)" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/creatingcasandcertificates/creatingcertificateauthorities/" -description: "Describes how to create or import certificates using TrueNAS CORE." -weight: 10 -aliases: - - /core/system/cas -tags: -- certificates ---- - -TrueNAS can act as a certificate authority (CA). -When encrypting SSL or TLS connections to the TrueNAS system, you can import an existing CA or create a CA and certificate on the TrueNAS system. -The certificate appears on the dropdown menus for services that support SSL or TLS. - -Go to **System > CAs** and click **ADD**. Enter a name for the CA, then choose the type from the **Type** dropdown list of three, **Internal CA**, **Intermediate CA**, or **Import CA**. The process to add a CA for each type is slightly different. - -## Creating CA - -A CA must exist in CORE to add an Intermediate CA. This can be an internal or imported CA. - -To create a CA: - -1. Enter or select the **Identifier and Type** setting options. - - ![AddInternalCAIdentTypeNoProfile](/images/CORE/System/AddInternalCAIdentTypeNoProfile.png "Add Internal CA Name and Type") - - a. Enter a name for this CA. - b. Select **Internal CA** from the **Type** dropdown list to create an internal certificate. - Select **Intermediate CA** to create an intermediate certificate. This displays the **Signing Certificate Authority** field in **Certificate Options**. - -2. Select an option from the **Profiles** dropdown list. - A profile for the CA auto-fills options like **Key Type**, **Key Length**, and **Digest Algorithm**. Otherwise, you must set options manually. - - To add an OpenVPN Root CA, select **OpenVPN Root CA**. - The configuration form populates with default settings, enables **Basic Constraints**, **Authority Key Identifier**, **Extended Key Usage**, and **Key Usage**, and sets the options for each extension. - - ![AddInternalCAOpenVPNRootProfile](/images/CORE/System/AddInternalCAOpenVPNRootProfile.png "Add OpenVPN Root CA Profile") - - To add CA certificate, select **CA**. - The configuration form populates with default settings, enables **Basic Constraints**, **Authority Key Identifier**, **Extended Key Usage**, and **Key Usage**, and sets the options for each extension. - - ![AddInternalCAProfile](/images/CORE/System/AddInternalCAProfile.png "Add Internal CA Profile") - -3. Select the **Certificate Options**. - - ![AddInternalCACertOptionsNoProfile](/images/CORE/System/AddInternalCACertOptionsNoProfile.png "Add Internal CA Certificate Options") - - a. Select a **Key Type** from the dropdown list. We recommend the **RSA** key type. Use **EC** for elliptic curve certificates. - - b. Select the **Key Length**. We recommend a minimum of **2048** for security reasons. - - c. Select a **Digest Algorithm**. We recommend **SHA256**. - - d. Enter the **Lifetime** of the CA in days to set how long the CA remains valid. - -4. Enter or select the **Certificate Subject** settings. - - ![AddInternalCertSubject](/images/CORE/System/AddInternalCertSubject.png "Internal Certificate Subject Settings") - - a. Enter the geographic information in **Country**, **Locality**, **Organizational Unit** (optional), **Common Name**, **State**, **Organization**, **Email**, and **Subject Alternate Names**. - - b. (Optional) Enter a [fully-qualified hostname (FQDN)](https://kb.iu.edu/d/aiuv) that is unique within a certificate chain in **Common Name**. - -5. Select enable and select extensions to use if you did not select an option in **Profiles**. If manually selecting and entering extension: - - ![AddInternalCertExtensions](/images/CORE/System/AddInternalCertExtensions.png "Internal Certificate Extension Options") - - a. Select **Enable**, then enter the extensions for **Basic Constraints**. - - Enter a value in **Path Length** that determines how many non-self-issued intermediate certificates can follow the certificate in a valid certification path. - Entering **0** allows a single additional certificate to follow in the certificate path. Then select the extension(s) to use. - - Select an option from the **Basic Constraints Config** dropdown list. Select **CA** to use a certificate authority. - Selecting **Critical Extension** can result in rejection of the certificate by the system that is using the certificate if that system does not recognize the extension. - - b. Select **Enable**, then enter the extensions for **Authority Key Identifier**. - - Enabling **Authority Key Config** adds the authority key identifier extension which provides a means of identifying the public key corresponding to the private key used to sign the certificate. Used when an issue has multiple signing keys, possibly due to multiple concurrent key pairs or due to changeover. Options are **Authority Cert Issuer** or **Critical Extension**. - - c. Select **Enable**, then enter the extensions for **Extended Key Usage**. Select one or more usages for the public key from the **Usages** dropdown list. - TrueNAS uses Extended Key Usage for end-entity certificates. - - Enable **Critical Extension** to identify this extension as critical for the certificate. - Do not enable **Critical Extension** if **Usages** contains **ANY_EXTENDED_KEY_USAGE**. - - Using **Extended Key Usage** and **Key Usage** extensions requires that the certificate purpose is consistent with both extensions. See [RFC 3280, section 4.2.1.13](https://www.ietf.org/rfc/rfc3280.txt) for more details. - -6. Click **Submit** to create the CA. - -## Importing a CA -Use this procedure to import a CA. - -1. Enter a name for this certificate. - - ![ImportCA](/images/CORE/System/ImportCA.png "Import CA") - -2. Select **Import CA** from the **Type** dropdown list. - -3. Copy the certificate for the CA you want to import and paste it into the **Certificate** field. - -4. Paste the certificate private key of at least 1024 bits in length into **Private Key** when available. - -5. Enter and confirm the passphrase for the private key into **Passphrase** and **Confirm Passphrase**. - -6. Click **Submit**. - -## Deleting a CA - -Before deleting a CA, verify it is not used by another service such as S3, FTP, etc. You cannot delete a CA when in use by other services. - -Also, before you can delete a CA, you need to delete certificates issued by the CA or those relying on the CA. -If you receive an error that mentions foreign keys reference, ensure the certificates on your system do not use the CA you want to delete. diff --git a/content/CORE/CORETutorials/SystemConfiguration/CreatingCAsandCertificates/CreatingCertificates.md b/content/CORE/CORETutorials/SystemConfiguration/CreatingCAsandCertificates/CreatingCertificates.md deleted file mode 100644 index 280e7587d4..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/CreatingCAsandCertificates/CreatingCertificates.md +++ /dev/null @@ -1,182 +0,0 @@ ---- -title: "Adding Certificates or CSRs" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/creatingcasandcertificates/creatingcertificates/" -description: "Provides instructions on adding or importing certificates and certificate signing requests (CSRs) in TrueNAS CORE." -weight: 20 -aliases: - - /core/system/certificates -tags: -- certificates -- csr ---- - -By default, TrueNAS comes equipped with an internal, self-signed certificate that enables encrypted access to the web interface. - -You can either import or create a new certificate or signing request by navigating to **System > Certificates** and clicking **ADD**. - -## Adding Internal Certificates - -To add an internal certificate: - -1. Enter the name for the certificate, then select **Internal Certificate** from the **Type** dropdown list. - - ![AddInternalCertIdentTypeNoProfile](/images/CORE/System/AddInternalCertIdentTypeNoProfile.png "Add Internal Cert Name and Type") - -2. Select an option from the **Profiles** dropdown list. - A profile for the certificate auto-fills options like **Key Type**, **Key Length**, **Digest Algorithm**. Otherwise, you must set options manually. - - To add an HTTPS RSA certificate, the default certificate type, select **HTTPS RSA Certificate**. - The configuration form populates with default settings, enables **Basic Constraints**, **Authority Key Identifier**, **Extended Key Usage**, and **Key Usage**, and set the options for each extension. - - ![AddInternalCertRSAProfile](/images/CORE/System/AddInternalCertRSAProfile.png "Add Internal RSA Profile") - - To add an elliptical curve certificate select **HTTPS ECC Certificate**. - The configuration form populates with default settings, enables **Basic Constraints**, **Authority Key Identifier**, **Extended Key Usage**, and **Key Usage**, and set the options for each extension. - - ![AddInternalCertECCProfile](/images/CORE/System/AddInternalCertECCProfile.png "Add Internal ECC Profile") - - To add an OpenVPN certificate, select the client or server option that fits the certificate type you want to create. - The configuration form populates with default settings, enables **Basic Constraints**, **Authority Key Identifier**, **Extended Key Usage**, and **Key Usage**, and set the options for each extension. - -3. Enter or select the **Certificate Options** settings if you did not select a **Profile** option. - - ![AddInternalCertCertOptionsNoProfile](/images/CORE/System/AddInternalCertCertOptionsNoProfile.png "Add Internal Cert Certification Options") - - a. Select a **Signing Certificate Authority** from the dropdown list. - - b. Select a **Key Type** from the dropdown list. We recommend selecting **RSA**. - - c. Select the **Key Length**. We recommend a minimum of **2048** for security reasons. - - d. Select a **Digest Algorithm**. We recommend **SHA256**. - - e. Enter the **Lifetime** of the certificate CA in days to set how long the CA remains valid. - -4. Enter or select the **Certificate Subject** setting options. - - ![AddInternalCertSubject](/images/CORE/System/AddInternalCertSubject.png "Internal Certificate Subject Settings") - - Enter the geographic and other information in **Country**, **Locality**, **Organizational Unit** (optional), **Common Name**, **State**, **Organization**, **Email**, and **Subject Alternate Names**. - - Enter a [fully-qualified hostname (FQDN)](https://kb.iu.edu/d/aiuv) that us unique within a certificate chain in **Common Name**. - -5. Select enable and select extensions to use if you did not select an option in **Profiles**. If manually selecting and entering extension: - - ![AddInternalCertExtensions](/images/CORE/System/AddInternalCertExtensions.png "Internal Certificate Extension Options") - - a. Select **Enable**, then enter the extensions for **Basic Constraints**. - - Enter a value in **Path Length** that determines how many non-self-issued intermediate certificates can follow the certificate in a valid certification path. - Entering **0** allows a single additional certificate to follow in the certificate path. Then select the extension(s) to use. - - b. Select **Enable**, then enter the extensions for **Authority Key Identifier**. - - c. Select **Enable**, then enter the extensions for **Extended Key Usage**. Select one or more usages for the public key from the **Usages** dropdown list. - TrueNAS uses Extended Key Usage for end-entity certificates. - - Enable **Critical Extension** if you want to identify this extension as critical for the certificate. - Do not enable **Critical Extension** if **Usages** contains **ANY_EXTENDED_KEY_USAGE**. - - Using **Extended Key Usage** and **Key Usage** extensions requires that the certificate purpose is consistent with both extensions. See [RFC 3280, section 4.2.1.13](https://www.ietf.org/rfc/rfc3280.txt) for more details. - - d. Select **Enable**, then enter the extensions for **Key Usage**. Select any extensions from the **Key Usage Config** dropdown list. - -6. Click **Submit**. - -## Creating a Certificate Signing Request - -To add a certificate singing request (CSR) certificate: - -1. Enter the name for the certificate, then select **Certificate Signing Request** from the **Type** dropdown list. - - ![AddCSRIdentTypeNoProfile](/images/CORE/System/AddCSRIdentTypeNoProfile.png "Add CSR Name and Type") - -2. Select **Certificate Signing Request** from the **Profiles** dropdown list. - A profile for the certificate auto-fills options like **Key Type**, **Key Length**, **Digest Algorithm**. Otherwise, you must set options manually. - - To use an HTTPS RSA certificate, the default certificate type, select **HTTPS RSA Certificate**. - The configuration form populates with default settings, enables **Basic Constraints**, **Authority Key Identifier**, **Extended Key Usage**, and **Key Usage**, and set the options for each extension. - - ![AddCSRRSAProfile](/images/CORE/System/AddCSRRSAProfile.png "Add CSR RSA Profile") - - To use an elliptical curve certificate, select **HTTPS ECC Certificate**. - The configuration form populates with default settings, enables **Basic Constraints**, **Authority Key Identifier**, **Extended Key Usage**, and **Key Usage**, and set the options for each extension. - - ![AddCSRECCProfile](/images/CORE/System/AddCSRECCProfile.png "Add CSR RSA Profile") - - To use an OpenVPN certificate, select the client or server option that fits the certificate type. - The configuration form populates with default settings, enables **Basic Constraints**, **Authority Key Identifier**, **Extended Key Usage**, and **Key Usage**, and set the options for each extension. - -3. Enter or select the **Certificate Options** settings if you did not select a **Profile** option. - - ![AddCSRCertOptionsNoProfile](/images/CORE/System/AddCSRCertOptionsNoProfile.png "Add CSR Certificate Options Not Profile") - - a. Select a **Key Type** from the dropdown list. We recommend selecting **RSA**. - - b. Select a **Digest Algorithm**. We recommend **SHA256**. - -4. Enter or select the **Certificate Subject** setting options. - - ![AddInternalCertSubject](/images/CORE/System/AddInternalCertSubject.png "Internal Certificate Subject Settings") - - Enter the geographic and other information in **Country**, **Locality**, **Organizational Unit** (optional), **Common Name**, **State**, **Organization**, **Email**, and **Subject Alternate Names**. - - Enter a [fully-qualified hostname (FQDN)](https://kb.iu.edu/d/aiuv) that us unique within a certificate chain in **Common Name**. - -5. Select enable and select extensions to use if you did not select an option in **Profiles**. If manually selecting and entering extension: - - ![AddInternalCertExtensions](/images/CORE/System/AddInternalCertExtensions.png "Internal Certificate Extension Options") - - a. Select **Enable**, then enter the extensions for **Basic Constraints**. - - Enter a value in **Path Length** that determines how many non-self-issued intermediate certificates can follow the certificate in a valid certification path. - Entering **0** allows a single additional certificate to follow in the certificate path. Then select the extension(s) to use. - - b. Select **Enable**, then enter the extensions for **Authority Key Identifier**. - - c. Select **Enable**, then enter the extensions for **Extended Key Usage**. Select one or more usages for the public key from the **Usages** dropdown list. - TrueNAS uses Extended Key Usage for end-entity certificates. - - Enable **Critical Extension** if you want to identify this extension as critical for the certificate. - Do not enable **Critical Extension** if **Usages** contains **ANY_EXTENDED_KEY_USAGE**. - - Using **Extended Key Usage** and **Key Usage** extensions requires that the certificate purpose is consistent with both extensions. See [RFC 3280, section 4.2.1.13](https://www.ietf.org/rfc/rfc3280.txt) for more details. - - d. Select **Enable**, then enter the extensions for **Key Usage**. Select any extensions from the **Key Usage Config** dropdown list. - -6. Click **Submit**. - -## Importing a Certificate - -To import a certificate: - -1. Select **Import Certificate** as the **Type**. - - ![ImportCertificate](/images/CORE/System/ImportCertificate.png "Import Internal CSR" ) - -2. Select the **Certificate Options**. - To import a previously-added certificate for a CSR, select **CSR exists on this system**, then select one from the **Signing Certificate Authority** dropdown list. - -3. Copy the certificate for the CA you want to import and paste it into the **Certificate** field. - -4. Paste the certificate key that is least 1024 bits long into **Private Key** when available. - -5. Enter and confirm the Private Key **Passphrase**. - -6. Click **Submit**. - -## Importing a Certificate Signing Request - -To import a certificate signing request (CSR): - -1. Select **Import Certificate Signing Request** as the **Type**. - - ![ImportCSR](/images/CORE/System/ImportCSR.png "Import CSR") - -2. Copy the certificate for the CA you want to import and paste it into the **Certificate** field. - -3. Paste the certificate key that is least 1024 bits long into **Private Key** when available. - -4. Enter and confirm the Private Key **Passphrase**. - -5. Click **Submit**. diff --git a/content/CORE/CORETutorials/SystemConfiguration/CreatingCAsandCertificates/_index.md b/content/CORE/CORETutorials/SystemConfiguration/CreatingCAsandCertificates/_index.md deleted file mode 100644 index c82d2c5909..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/CreatingCAsandCertificates/_index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "Adding Certs, CAs, and CSRs" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/creatingcasandcertificates/" -description: "Tutorial articles about adding or importing certificates, certificate signing requests (CSRs), and certificate authorities (CAs) in TrueNAS." -weight: 140 -geekdocCollapseSection: true -related: false ---- - -TrueNAS lets users create or import certificates, certificate signing requests (CSRs), and certificate authorities (CAs) that enable encrypted connections to the web interface. - -
- -## Contents - -{{< children depth="2" description="true" >}} -
diff --git a/content/CORE/CORETutorials/SystemConfiguration/ManagingBootEnvironments.md b/content/CORE/CORETutorials/SystemConfiguration/ManagingBootEnvironments.md deleted file mode 100644 index b6063d4c03..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/ManagingBootEnvironments.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "Managing Boot Environments" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/managingbootenvironments/" -description: "Provides information about managing boot environments on TrueNAS CORE." -weight: 30 -aliases: - - /core/system/boot/bootscreen/ - - /core/coretutorials/systemconfiguration/managingbootenvironments/ -tags: -- boot -- update -slug: managing-boot-environments ---- - -TrueNAS supports a ZFS feature known as boot environments. -These are snapshot clones that TrueNAS can boot into. -You can only use one boot environment for booting. - -{{< expand "How does this help me?" "v" >}} -A boot environment allows rebooting into a specific point in time and greatly simplifies recovering from system misconfigurations or other potential system failures. -With multiple boot environments, the process of updating the operating system becomes a low-risk operation. -The updater automatically creates a snapshot of the current boot environment and adds it to the boot menu before applying the update. -If anything goes wrong during the update, the system administrator can boot TrueNAS into the previous environment to restore system functionality. -{{< /expand >}} - -## Changing Boot Environments - -Sometimes, rolling back to an older boot environment can be useful. -For example, if an update process doesn't go as planned, it is easy to roll back to a previous boot environment. -TrueNAS automatically creates a boot environment when the system updates. - -There are two different methods for changing the active boot environment: using the web interface and through a Command Line Interface (CLI) - -### Web Interface - -Go to **System > Boot** and click for the desired boot environment, then click **Activate**. - -Reboot the system to activate the new boot environment. - -### Command Line Interface - -Reboot the system. - -When the welcome screen appears, press the key that corresponds with the option **Boot Environments** (usually 7). - -{{< hint type=note >}} -The *Boot Environments* options does not appear when no additional boot environments are present. -{{< /hint >}} - -![BootMenu](/images/CORE/BootMenu.png "TrueNAS Boot Menu") - -Choose the new boot environment to activate byt pressing the key for the *Active:* option. - -![BootMenuSelectBE](/images/CORE/BootMenuSelectBE.png "Selecting a Boot Environment") - -Press the key to cycle through existing boot environments. -When you select the desired boot environment, press Backspace to return to the welcome menu, then press 4 to reboot the system. - -## Boot Actions - -Go to **System > Boot** and click **ACTIONS**. - -### Add a New Boot Environment - -Click Add to make a new boot environment from the active environment. - -![SystemBootActionsAdd](/images/CORE/System/SystemBootActionsAdd.png "Creating a new Boot Environment") - -**Name** the new boot environment and click **SUBMIT**. - -{{< hint type=note >}} -You may only use alphanumeric characters, dashes (-), and underscores (_) in the **Name**. -{{< /hint >}} - -### View Stats/Settings - -Click **Stats/Settings** to display statistics for the operating system device. - -By default, TrueNAS scrubs the operating system device every 7 days. -To change the default, input a different number in the **Scrub interval (in days)** field and click **UPDATE INTERVAL**. - -### View Boot Pool Status - -Click **Boot Pool Status** to see the status of each boot-pool device, including any read, write, or checksum errors. - -### Scrub the Boot Pool - -Click **Scrub Boot Pool** to perform a manual (data integrity check) of the operating system device. diff --git a/content/CORE/CORETutorials/SystemConfiguration/MirroringtheBootPool.md b/content/CORE/CORETutorials/SystemConfiguration/MirroringtheBootPool.md deleted file mode 100644 index 6cb9169f15..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/MirroringtheBootPool.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "Mirroring the Boot Pool" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/mirroringthebootpool/" -description: "Provides information on how to mirror the boot pool on TrueNAS CORE." -weight: 35 -tags: -- boot -aliases: - - /hub/tasks/advanced/mirror-boot-pool/ - - /core/system/boot/bootpoolmirror/ - - /core/coretutorials/systemconfiguration/mirroring-the-boot-pool/ ---- - -Adding a second storage device to the boot pool changes the configuration to a **Mirror**. -This allows one of the devices to fail and the system still boots. -If one of the two devices were to fail, that device is easily detached and replaced. - -When adding a second device to create a mirrored boot pool, consider these caveats: - -* **Capacity**: The new device must have at least the same capacity as the existing device. - Larger capacity devices can be added, but the mirror will only have the capacity of the smallest device. - Different models of devices which advertise the same nominal size are not necessarily the same actual size. - For this reason, adding another device of the same model of is recommended. - -* **Device Type**: We **strongly recommend** using SSDs rather than USB devices when creating a mirrored boot pool. - -{{< hint type=warning >}} -Removing devices from storage pools can result in data loss! -{{< /hint >}} - -Go to **System > Boot > ACTIONS > Boot Pool Status**. - -![SystemBootBootPoolStatus](/images/CORE/System/SystemBootBootPoolStatus.png "Boot Pool Status Example") - -Click on the boot device, then click attach. - -Select a new **Member Disk** from the drop-down and click **SUBMIT**. - -{{< expand "Use all disk space?" "v" >}} -By default, TrueNAS partitions the new device to the same size as the existing device. -When you select **Use all disk space**, TrueNAS uses the entire capacity of the new device. - -If the original operating system device fails and is detached, the boot mirror changes to consist of just the newer device and grows to whatever capacity it provides. -However, new devices added to this mirror must now be as large as the new capacity. -{{< /expand >}} diff --git a/content/CORE/CORETutorials/SystemConfiguration/SettingUpSyslogServer.md b/content/CORE/CORETutorials/SystemConfiguration/SettingUpSyslogServer.md deleted file mode 100644 index 7b5cdf8804..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/SettingUpSyslogServer.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "Setting Up a Remote Syslog Server" -redirect: "https://www.truenas.com/docs/core/13.3/coretutorials/systemconfiguration/settingupsyslogserver/" -description: "Describes setting up a remote syslog server in TrueNAS CORE." -weight: 75 -tags: -- settings ---- - -TrueNAS CORE allows users to configure a remote system logging server using any of the three transport protocols supported in CORE. -Options are **UDP**, **TCP**, or **TLS**. -The steps for all three protocols are the same except **UDP** and **TCP** do not require a certificate and certificate authority and **TLS** does. - -## Configuring a Syslog Server -1. (TLS only) Go to **System > CAs** and configure a [certificate authority]({{< relref "CreatingCertificateAuthorities.md" >}}) for the remote logging server. - You can use a self-signed CA. Enter the IP address for the remote server in **Subject Alternate Names**. - -2. (TLS only) Go to **System > Certificates** and configure a [certificate]({{< relref "CreatingCertificates.md" >}}) for the remote logging server. - Use the CA created for the remote syslog server. Enter the IP address for the remote server in **Subject Alternate Names**. - -3. Go to **System > Advanced** and configure the syslog server settings. - - ![SystemAdvancedSyslogTransportTLS](/images/CORE/System/SystemAdvancedSyslogTransportTLS.png "Advanced Syslog Transport TLS Settings") - - a. Select the level of logging in **Syslog Level**. - - b. Enter the IP address for the remote sever in **Syslog Server**. - - c. Select **TLS** in **Syslog Transport** or one of the other transport protocols. - The system shows the certificate and certificate authority settings after selecting **TLS**. - If selecting **UDP** or **TCL**, go to step four. - - d. Select the certificate created for the remote syslog server from the **Syslog TLS Certificate** dropdown list. - - e. Select the certificate authority created for the remote syslog server from the **Syslog TLS Certificate Authority** dropdown list. - -4. Click **SAVE**. diff --git a/content/CORE/CORETutorials/SystemConfiguration/SettingtheSystemDataset.md b/content/CORE/CORETutorials/SystemConfiguration/SettingtheSystemDataset.md deleted file mode 100644 index 7bb48c9326..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/SettingtheSystemDataset.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "Setting the System Dataset" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/settingthesystemdataset/" -description: "Describes how to configure the system dataset on TrueNAS CORE." -weight: 70 -aliases: - - /core/system/systemdataset/ - - /core/coretutorials/systemconfiguration/setting-the-system-dataset/ -tags: -- systemdataset -- datasets ---- - -The system dataset stores debugging core files, encryption keys for encrypted pools, and Samba4 metadata such as the user and group cache and share level permissions. - -To view the current location of the system dataset, go to **System > System Dataset**. - -![ConfigureSystemDataset](/images/CORE/System/ConfigureSystemDataset.png "Configure System Dataset") - -## Store the System Log - -Users can store the system log on the system dataset. -We recommend users store the log information on the system dataset when the system generates large amounts of data and has limited memory or a limited-capacity operating system device. - -Set **Syslog** to store the system log on the system dataset. -Leave unset to store the system log in /var on the operating system device. - -## Change System Dataset - -Select an existing pool from the **System Dataset Pool** dropdown. - -You can move the system dataset to unencrypted pools or encrypted pools that do not have passphrases. - -Moving the system dataset to an encrypted pool disables that volume's passphrase capability. - -You cannot move the system dataset to a passphrase-encrypted or read-only pool. - -{{< hint type=important >}} -**Reboots Required** - -* The SMB service must restart, which causes a brief outage for any active SMB connections. -* Highly Available TrueNAS systems must reboot the standby controller when the system dataset moves. - -{{< /hint >}} - -If a user changes the pool storing the system dataset later, TrueNAS migrates the existing data in the system dataset to the new location. diff --git a/content/CORE/CORETutorials/SystemConfiguration/UsingConfigurationBackups.md b/content/CORE/CORETutorials/SystemConfiguration/UsingConfigurationBackups.md deleted file mode 100644 index d8279abfb4..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/UsingConfigurationBackups.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "Using Configuration Backups" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/usingconfigurationbackups/" -description: "Provides information concerning configuration backups on TrueNAS CORE." -weight: 10 -aliases: - - /core/system/general/configbackup/ - - /core/coretutorials/systemconfiguration/usingconfigurationbackups/%E2%80%8B%E2%80%8B/ -tags: -- configbackup -- update ---- - -We highly recommend backing up the system configuration regularly. -Doing so preserves settings when migrating, restoring, or fixing the system if it runs into any issues. -Save the configuration file each time the system configuration changes. - -Backup configs store information for accounts, network, services, tasks, virtual machines, and system settings. -Backup configs also index ID's and credentials for account, network, and system services. -Users can view the contents of the backup config using database viewing software like [SQLite DB Browser](https://sqlitebrowser.org/dl/). - -## Backing Up System Configurations - -### Manual Backup - -Go to **System > General** and click **SAVE CONFIG**, then enter your password. - -![SaveUploadResetConfig](/images/CORE/System/SaveUploadResetConfig.png "Save, Upload, Reset Config") - -{{< hint type=important >}} -The configuration file contains sensitive data about the TrueNAS system. -Ensure that it is stored somewhere safe. -{{< /hint >}} - -### Automatic Backup - -TrueNAS automatically backs up the configuration database to the [system dataset]({{< relref "/CORE/UIReference/System/SystemDataset.md" >}}) every morning at 3:45 (relative to system time settings). -However, this backup does not occur if the system is off at that time. -If the system dataset is on the boot pool and it becomes unavailable, the backup also loses availability. - -{{< hint type=important >}} -You must backup SSH keys separately. TrueNAS does not store them in the configuration database. -System host keys are files with names beginning with ssh_host_ in /usr/local/etc/ssh/. -The root user keys are stored in /root/.ssh. -{{< /hint >}} - -### Passwords -The system backup affects two types of passwords: hashed and encrypted. - -**Hashed**: TrueNAS stores user account passwords for the base operating system as hashed values. The system saves them in the system configuration backup, so they do not need to be encrypted to be secure. - -**Encrypted**: The system saves other passwords, like iSCSI CHAP passwords, Active Directory bind credentials, and cloud credentials in an encrypted form to prevent them from being visible as plain text in the saved system configuration. The key or seed for this encryption is usually only on the operating system device. - -There are two options after clicking **SAVE CONFIG**: - -**Export Password Secret Seed** includes encrypted passwords in the configuration file. Encrypted passwords allow you to restore the configuration file to a different operating system device where the decryption seed is not present. Users must physically secure configuration backups containing the seed to prevent unauthorized access or password decryption. - -**Export Legacy Encryption (GELI) Keys** includes encrypted legacy encryption keys in the configuration file. Users can restore the encryption keys by uploading the configuration file to the system using **UPLOAD CONFIG**. - -![SaveConfiguration](/images/CORE/System/SaveConfiguration.png "Save Configuration") - -## Resetting and Restoring Configurations - -### Reset Configuration - -To reset the system configuration to factory settings, go to **System > General** and click **RESET CONFIG**. - -{{< hint type=warning >}} -**Save the system's current configuration before resetting.** - -If you do not save the system config before resetting it, you may lose any data that you did not back up. You cannot revert to the previous settings. -{{< /hint >}} - -After resetting the system configuration, the system restarts, and you must set a new login password. - -### Restore Configuration - -Users can restore configurations by going to **System > General** and clicking **UPLOAD CONFIG**. - -When uploading a config, you can select any previously saved config files for their system. diff --git a/content/CORE/CORETutorials/SystemConfiguration/UsingTwoFactorAuthentication.md b/content/CORE/CORETutorials/SystemConfiguration/UsingTwoFactorAuthentication.md deleted file mode 100644 index de53e35a01..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/UsingTwoFactorAuthentication.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "Using Two-Factor Authentication" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/usingtwofactorauthentication/" -description: "Describes how to use two-factor authentication on TrueNAS CORE." -weight: 180 -aliases: - - /core/system/2fa -tags: -- 2fa ---- - -We recommend two-factor authentication (2FA) for increased security. -TrueNAS offers 2FA to ensure that a compromised administrator (*root*) password alone cannot grant access to the administrator interface. -To utilize 2FA, you need a mobile device with Google Authenticator installed. -Other authenticator applications can be used, but you will need to confirm the settings and QR codes generated in TrueNAS are compatible with your particular app before permanently activating 2FA. - -{{< expand "What is 2FA, and why would I want to enable it?" "v" >}} -Two-factor authentication (2FA) is an extra layer of security that prevents someone from logging in, even if they have your password. This extra security measure requires you to verify your identity using a randomized 6-digit code that regenerates every 30 seconds (unless modified). - -## Setting Up Two-Factor Authentication - -{{< hint type=warning >}} -Set up a second 2FA device as a backup before proceeding. -{{< /hint >}} - -Go to **System > 2FA** and click **ENABLE TWO-FACTOR AUTHENTICATION**. Then, click **CONFIRM**. - -![System2FAOptionsNoSSH](/images/CORE/System/System2FAOptionsNoSSH.png "2FA Options: No SSH") - -Click **SHOW QR**, then scan it using Google Authenticator on the mobile device. - -![System2FAQRCode](/images/CORE/System/System2FAQRCode.png "2FA: QR Code") - -## Using 2FA to Log In to TrueNAS - -Enabling 2FA changes the login process for both the TrueNAS web interface and SSH logins: - -### Web UI Login - -![Login2FA](/images/CORE/System/Login2FA.png "2FA Login") - -The login screen has another field for the randomized authenticator code. If this field isn't immediately visible, refresh the browser. - -Enter the code from the mobile device (complete without the space) in the login window with the *root* username and password. - -### SSH Login - -![SSHConnect2FA](/images/CORE/SSHConnect2FA.png "SSH Connect 2FA") - -Set **Enable Two-Factor Auth for SSH** in **System > 2FA**, then go to **Services > SSH** and click . - -Set **Log in as Root with Password** and click **SAVE**. Toggle the **SSH** service and wait for the status to show that it is **RUNNING**. - -Open a Command Prompt or Terminal and SSH into TrueNAS using the system hostname or IP address, *root* account username and password, and the 2FA code from the mobile device. -{{< /expand >}} diff --git a/content/CORE/CORETutorials/SystemConfiguration/ViewingEnclosures.md b/content/CORE/CORETutorials/SystemConfiguration/ViewingEnclosures.md deleted file mode 100644 index e4136a793f..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/ViewingEnclosures.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "Managing Enclosures" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/viewingenclosures/" -description: "Provides information about hardware and expansion shelves on TrueNAS CORE." -weight: 50 -aliases: - - /core/system/viewenclosure -tags: -- enclosure ---- - -{{< hint type=tip >}} -Only compatible TrueNAS hardware and expansion shelves available from [iXsystems](https://www.ixsystems.com/) allow seeing the **View Enclosure** option. -To learn more about available iXsystems products, see the [TrueNAS Systems Overview](https://www.truenas.com/systems-overview/) or browse the [Hardware]({{< relref "/Hardware/_index.md" >}}) documentation. -{{< /hint >}} - -Go to **System > View Enclosure** to display the status of connected disks and hardware. - -![System View Enclosure M50](/images/CORE/System/SystemViewEnclosureM50.png "M50 Enclosure") - -## Checking Enclosure Components - -The screen shows the primary system. -Other detected TrueNAS hardware is available from a column on the right side of the screen. -Click an enclosure to show details about that hardware. - -![System View Enclosure ES102](/images/CORE/System/SystemViewEnclosureES102.png "System View Enclosure ES102") - -The screen is divided into different tabs which reflect the active sensors in the chosen hardware. - -You can rename a system by clicking **EDIT LABEL**. - -## Identifying Disks - -In the **Disks** tab, select a disk on the enclosure image and click **IDENTIFY DRIVE**. The drive LED on the physical system flashes so you can find it. - -{{< hint type=note >}} -The TrueNAS Mini Series models do not support drive light identification. -{{< /hint >}} diff --git a/content/CORE/CORETutorials/SystemConfiguration/_index.md b/content/CORE/CORETutorials/SystemConfiguration/_index.md deleted file mode 100644 index 9ad108ae6c..0000000000 --- a/content/CORE/CORETutorials/SystemConfiguration/_index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: System Configuration -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/systemconfiguration/" -description: "Tutorials about a wide variety of TrueNAS system management topics." -geekdocCollapseSection: true -weight: 20 -related: false ---- - -{{< children depth="2" description="true" >}} diff --git a/content/CORE/CORETutorials/Tasks/CreatingCloudSyncTasks.md b/content/CORE/CORETutorials/Tasks/CreatingCloudSyncTasks.md deleted file mode 100644 index 0224e8ef82..0000000000 --- a/content/CORE/CORETutorials/Tasks/CreatingCloudSyncTasks.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: "Creating Cloud Sync Tasks" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/creatingcloudsynctasks/" -description: "Describes how to configure cloud storage backup tasks in TrueNAS CORE." -weight: 90 -aliases: - - /core/system/cloudcredentials - - /core/system/cloudsynctasks - - /core/tasks/cloudsynctasks -tags: -- cloud -- databackup ---- - -Cloud sync tasks let TrueNAS integrate with a Cloud Storage provider for additional backup storage. -Cloud Sync tasks allow for single time transfers or recurring transfers on a schedule, and are an effective method to back up data to a remote location. - -{{< include file="/static/includes/CloudServiceProvidersCORE.md" >}} - -{{< hint type=important >}} -Using the Cloud means that data can go to a third party commercial vendor not directly affiliated with iXsystems. -Please investigate and fully understand vendor pricing policies and services before creating any Cloud Sync task. -iXsystems is not responsible for any charges incurred from the use of third party vendors with the Cloud Sync feature. -{{< /hint >}} - -## Create a Cloud Storage Credential - -Transferring data from TrueNAS to the Cloud requires saving Cloud Storage Provider credentials on the system. - -To maximize security, TrueNAS encrypts credentials after saving. -However, this means that to restore any cloud credentials from a TrueNAS configuration file, you must enable **Export Password Secret Seed** when generating that [configuration backup]({{< relref "/CORE/CORETutorials/SystemConfiguration/UsingConfigurationBackups.md" >}}). -Remember to protect any downloaded TrueNAS configuration files. - -Go to **System > Cloud Credentials** and click **ADD**. - -![SystemCloudCredentialsAddS3](/images/CORE/System/SystemCloudCredentialsAddS3.png "Adding new Cloud Credential: S3") - -Enter a credential **Name** and choose a **Provider**. -The rest of the options vary by **Provider**. - -Enter the required **Authentication** strings to enable saving the credential. - -See [Cloud Credentials]({{< relref "/core/uireference/system/cloudcredentials.md" >}}) for provider-specific fields and settings. - -### Automatic Authentication - -Some providers can automatically populate the required **Authentication** strings by logging in to the account. -To automatically configure the credential, click **Login to Provider** and entering your account username and password. - -![SystemCloudCredentialsOAuthLogin](/images/CORE/System/SystemCloudCredentialsOAuthLogin.png "Cloud Provider OAuth Login") - -We recommend verifying the credential before saving it. - -## Create a Cloud Sync Task - -{{< expand "Requirements" "v" >}} -* All system [Storage]({{< relref "CORE/CORETutorials/Storage/_index.md" >}}) configured and ready to receive or send data. -* A Cloud Storage provider account and a cloud storage location (like an Amazon S3 bucket). -* Cloud Storage account credentials must be saved in **System > Cloud Credentials**. -{{< /expand >}} - -Go to **Tasks > Cloud Sync Tasks** and click **ADD**. - -![TasksCloudSyncAdd](/images/CORE/Tasks/TasksCloudSyncAdd.png "Creating a Cloud Sync Task") - -Give the task a **Description** and select a cloud credential. -TrueNAS connects to the chosen Cloud Storage Provider and shows the available storage locations. - -Decide if data is transferring to (**PUSH**) or from (**PULL**) the Cloud Storage location (**Remote**). - -Choose a **Transfer Mode**: - -**SYNC** keeps all the files identical between the two storage locations. If a sync encounters an error, the destination does not delete the files. - -{{< hint type=note >}} -Syncing to a Backblaze B2 bucket does not delete files from the bucket, even when you delete those files locally. -Instead, Backblaze tags files with a version number or moves them to a hidden state. -To automatically delete old or unwanted files from the bucket, adjust the [Backblaze B2 Lifecycle Rules](https://www.backblaze.com/blog/backblaze-b2-lifecycle-rules/). -{{< /hint >}} - -**COPY** duplicates each source file into the destination, overwriting any destination files with the same name as the source. -Copying is the least potentially destructive option. - -**MOVE** transfers the files from the source to the destination and deletes the original source files. -It also overwrites files with the same names on the destination. - -Next, select a **Schedule** from the drop-down, or unset **Enable** to make the task available without running on a schedule. - -{{< expand "Advanced Scheduler" "v" >}} -{{< include file="/static/includes/AdvancedScheduler.md" >}} -{{< /expand >}} - -{{< expand "Advanced Options" "v" >}} -### Scripting and Environment Variables - -Advanced users can write scripts that run immediately before or after the Cloud Sync task. -The **Post-script** field runs when the Cloud Sync task successfully completes. -You can pass a variety of task environment variables into the **Pre-script** and **Post-script** fields: - -* CLOUD_SYNC_ID -* CLOUD_SYNC_DESCRIPTION -* CLOUD_SYNC_DIRECTION -* CLOUD_SYNC_TRANSFER_MODE -* CLOUD_SYNC_ENCRYPTION -* CLOUD_SYNC_FILENAME_ENCRYPTION -* CLOUD_SYNC_ENCRYPTION_PASSWORD -* CLOUD_SYNC_ENCRYPTION_SALT -* CLOUD_SYNC_SNAPSHOT - -There also are provider-specific variables like CLOUD_SYNC_CLIENT_ID or CLOUD_SYNC_TOKEN or CLOUD_SYNC_CHUNK_SIZE. - -Remote storage settings: -* CLOUD_SYNC_BUCKET -* CLOUD_SYNC_FOLDER - -Local storage settings: -* CLOUD_SYNC_PATH -{{< /expand >}} - -### Testing Settings - -Test the settings before saving by clicking **DRY RUN**. -TrueNAS connects to the Cloud Storage Provider and simulates a file transfer without sending or receiving data. - -![TasksCloudsyncAddGoogledriveDryrun](/images/CORE/Tasks/TasksCloudsyncAddGoogledriveDryrun.png "Example: Google Drive Test") - -## Cloud Sync Behavior - -Saved tasks activate based on their schedule, or when you click **RUN NOW**. -An in-progress cloud sync must finish before another can begin. -Stopping an in-progress task cancels the file transfer and requires starting the file transfer over. - -To view logs about a running task or a task most recent run, click the task status. - -## Cloud Sync Restore - -To quickly create a new cloud sync task that uses the same options but reverses the data transfer, expand () on an existing task and click **RESTORE**. - -![TasksCloudSyncRestore](/images/CORE/Tasks/TasksCloudSyncRestore.png "Cloud Sync Restore") - -Give the new task a **Description** and define the path to a storage location for the transferred data. - -TrueNAS saves the restored cloud sync task as another entry in **Tasks > Cloud Sync Tasks**. - -If the restore destination dataset is the same as the original source dataset, the restored files might have their ownership altered to _root_. If _root_ did not create the original files and they need a different owner, you can recursively reset ACL Permissions of the restored dataset through the GUI. diff --git a/content/CORE/CORETutorials/Tasks/CreatingCronJobs.md b/content/CORE/CORETutorials/Tasks/CreatingCronJobs.md deleted file mode 100644 index 496f80cc2d..0000000000 --- a/content/CORE/CORETutorials/Tasks/CreatingCronJobs.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "Creating Cron Jobs" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/creatingcronjobs/" -description: "Describes how to create a cron job on TrueNAS CORE." -weight: 10 -aliases: - - /core/tasks/cronjobs -tags: -- cronjobs -- systemleveltasks ---- - -TrueNAS allows users to run specific commands or scripts on a regular schedule using [cron(8)](https://man.openbsd.org/cron.8 "Cron Man Page"). - -## Creating a Cron Job - -Go to **Tasks > Cron Jobs** and click **ADD**. - -![TasksCronJobsAdd](/images/CORE/Tasks/TasksCronJobsAdd.png "Creating a new Cron Job") - -The **Description** helps identify the purpose of the cron job and is optional. - -Enter the **Command** to run on the **Schedule**. -Alternately, enter the path to a script file to run instead of a specific command. - -{{< hint type=important >}} -Don't forget to define the shell type when using a path to a script file. -For example, a script written for *sh* must be specified as *sh /mnt/pool1/helloWorld.sh*. -{{< /hint >}} - -Select a TrueNAS user account with the necessary permissions to run the **Command** or script. - -Next, define the **Command** **Schedule**. - -Additional Options: -* When **Hide Standard Output** (stdout) is unset, TrueNAS mails any standard output to the user account that runs the **Command**. -* When **Hide Standard Error** (stderr) is unset, TrueNAS mails any error output to the user account that runs the **Command**. Unsetting **Hide Standard Error** helps debug the **Command** or script if an error occurs. -* Unsetting **Enabled** only keeps the task from automatically running. You can still save the cron job and run it manually. - -## Managing a Cron Job - -Go to **Tasks > Cron Jobs** and click the next to an entry to see details and options. - -![TasksCronJobsOptions](/images/CORE/Tasks/TasksCronJobsOptions.png "Options for an existing cron job") - -Clicking **RUN NOW** immediately starts the job **Command**, separately from any **Schedule**. -**EDIT** changes any setting available during task creation. -**DELETE** removes the cron job from TrueNAS. Once you delete a cron job, you cannot restore the job configuration. diff --git a/content/CORE/CORETutorials/Tasks/CreatingInitShutdownScripts.md b/content/CORE/CORETutorials/Tasks/CreatingInitShutdownScripts.md deleted file mode 100644 index d9be0c45ed..0000000000 --- a/content/CORE/CORETutorials/Tasks/CreatingInitShutdownScripts.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "Creating Init/Shutdown Scripts" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/creatinginitshutdownscripts/" -description: "Explains how to create scheduled scripts on TrueNAS CORE." -weight: 20 -aliases: - - /core/tasks/initshutdownscripts -tags: -- initshutdown -- systemleveltasks ---- - -## Create an Init/Shutdown Script - -TrueNAS can schedule commands or scripts to run at system startup or shutdown. - -Go to **Tasks > Init/Shutdown Scripts** and click **ADD**. - -![TasksInitShutdownScriptsAdd](/images/CORE/Tasks/TasksInitShutdownScriptsAdd.png "Creating a new script") - -Enter a **Description**, then select a **Type**. - -### Command Type - -Enter a command with any options you want. You can find commands [here](https://www.truenas.com/community/resources/github-repository-for-freenas-scripts-including-disk-burnin-and-rsync-support.28/) or on our [Community Forums](https://forums.truenas.com/). - -{{< expand "Can I use a path for the Command?" "v" >}} -You can also include the full path to a command in the entry. -Scheduled commands must be in the default path. -You can find the path to a command by entering which COMMAND in the shell, where *COMMAND* is the command you want to locate. -When available, the path to the command displays: - -``` -[root@freenas ~]# which ls -/bin/ls -``` -{{< /expand >}} - -Select when you want the **Command** to run and fill out the rest of the fields to your needs, then click **SUBMIT**. - -### Script Type - -Select the path to the **Script**. The **Script** runs using [sh(1)](https://www.freebsd.org/cgi/man.cgi?query=sh). You can find some helpful scripts on our [Community Forums](https://forums.truenas.com/). - -Select when you want the **Script** to run and fill out the rest of the fields to your needs, then click **SUBMIT**. - -## Managing an Init/Shutdown Script - -{{< hint type=note >}} -Always test the script to verify it executes and achieves the desired results. -All init/shutdown scripts are run with `sh`. -{{< /hint >}} - -All saved Init/Shutdown tasks are in **Tasks > Init/Shutdown Scripts**. -Click (Options) next to a task to **EDIT** or **DELETE** that task. diff --git a/content/CORE/CORETutorials/Tasks/CreatingPeriodicSnapshotTasks.md b/content/CORE/CORETutorials/Tasks/CreatingPeriodicSnapshotTasks.md deleted file mode 100644 index 3c619e67d1..0000000000 --- a/content/CORE/CORETutorials/Tasks/CreatingPeriodicSnapshotTasks.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Periodic Snapshot Tasks" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/creatingperiodicsnapshottasks/" -description: "Describes how to create periodic snapshot tasks on TrueNAS CORE." -weight: 50 -tags: -- snapshots -- zfs -aliases: -- /core/tasks/periodicsnapshottasks/ ---- - -A periodic snapshot task allows scheduling the creation of read-only versions of pools and datasets at a given point in time. - -{{< expand "How should I use snapshots?" "v" >}} -Snapshots do not make copies of the data, so creating one is quick. It is common to take frequent snapshots every 15 minutes, even for large and active pools. -A snapshot with no file changes takes no storage space, but as file changes happen, the snapshot size changes to reflect the size of the changes. -In the same way as all pool data, you recover the space after deleting the last reference to the data. - -Snapshots keep a history of files, providing a way to recover an older copy or even a deleted file. -For this reason, many administrators take snapshots often, store them for a while, and store them on another system, typically using the **Replication Tasks** function. -Such a strategy allows the administrator to roll the system back to a specific point in time. -If there is a catastrophic loss, an off-site snapshot can restore data to when the last snapshot occured. -{{< /expand >}} - -## Creating a Periodic Snapshot Task - -Go to **Tasks > Periodic Snapshot Tasks** and click **ADD**. - -![TasksPeriodicSnapshotAdd](/images/CORE/Tasks/TasksPeriodicSnapshotAdd.png "Creating a new Snapshot Task") - -Choose the dataset (or zvol) to schedule as a regular backup with snapshots and determine how long to store them. -Define the task **Schedule** and configure the remaining options for your use case. - -### Snapshot Lifetimes - -TrueNAS deletes snapshots when they reach the end of their life and preserves snapshots when at least one periodic task requires it. -For example, you have two schedules created where one schedule takes a snapshot every hour and keeps them for a week, and the other takes a snapshot every day and keeps them for three years. -Each has an hourly snapshot taken. -After a week, snapshots created at *01.00* through *23.00* get deleted, but you keep snapshots timed at *00.00* because they are necessary for the second periodic task. -These snapshots get destroyed at the end of 3 years. - -### Naming Schemas - -The **Naming Schema** determines how automated snapshot names generate. -A valid schema requires the *%Y* (year), *%m* (month), *%d* (day), *%H* (hour), and *%M* (minute) time strings, but you can add more identifiers to the schema too, using any identifiers from the Python [strptime function](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior). - -{{< hint type=important >}} - -For **Periodic Snapshot Tasks** used to set up a replication task with the **Replication Task** function: - -You can use custom naming schemas for full backup replication tasks. If you are using the snapshot for incremental replication tasks, use the default naming schema. Go to [Using a Custom Schema]({{< relref "TroubleshootingTips.md" >}}) for additional information. -{{< /hint >}} - -This uses some letters differently from POSIX (Unix) time functions. -For example, including `%z` (time zone) ensures that snapshots do not have naming conflicts when daylight time starts and ends, and *%S* (second) adds finer time granularity. - -Examples: - -{{< truetable >}} -| Naming Scheme | Snapshot Names Look Like | -|---------------|--------------------------| -| replicationsnaps-1wklife-%Y%m%d_%H:%M | `replicationsnaps-1wklife-20210120_00:00`, `replicationsnaps-1wklife-20210120_06:00` | -| autosnap_%Y.%m.%d-%H.%M.%S-%z | `autosnap_2021.01.20-00.00.00-EST`, `autosnap_2021.01.20-06.00.00-EST` | -{{< /truetable >}} - -{{< hint type=important >}} -When referencing snapshots from a Windows computer, avoid using characters like `:` that are invalid in a Windows file path. -Some applications limit filename or path length, and there might be limitations related to spaces and other characters. -Always consider future uses and ensure the name given to a periodic snapshot is acceptable. -{{< /hint >}} - -## Managing Periodic Snapshot Tasks - -Click **SUBMIT** to save the task in **Tasks > Periodic Snapshot Tasks**. -You can find any snapshots from this task in **Storage > Snapshots**. - -To check the log for a saved snapshot schedule, go to **Tasks > Periodic Snapshot Tasks** and click the task **State**. diff --git a/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/AdvancedReplication.md b/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/AdvancedReplication.md deleted file mode 100644 index 197017c738..0000000000 --- a/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/AdvancedReplication.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -title: "Advanced Replication" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/creatingreplicationtasks/advancedreplication/" -description: "Describes how to configure advanced replication tasks on TrueNAS CORE." -weight: 30 -aliases: - - /core/coretutorials/tasks/replicationtasks/advanced/ - - /hub/tasks/scheduled/replication/advanced/ -tags: -- replication ---- - -Requirements: -* Storage pools with datasets and data to snapshot. -* SSH configured with a connection to the remote system saved in **System > SSH Connections**. -* Dataset snapshot task saved in **Tasks > Periodic Snapshot Tasks**. - -{{< expand "Process Summary" "v" >}} -Go to **Tasks > Replication Tasks** and click **ADD**, then select **ADVANCED REPLICATION CREATION**. - -* General Options: - * Name the task. - * Select Push or Pull for the local system. - * Select a replication transport method. - * SSH is recommended. - * SSH+Netcat is used for secured networks. - * Local is for in-system replication. -* Configure the replication transport method: - * Remote options require an SSH connection. - * SSH+Netcat requires defining Netcat ports and addresses. -* Sources: - * Select sources for replication. - * Choose a periodic snapshot task as the source of snapshots to replicate. - * Remote sources require defining a snapshot naming schema. -* Destination: - * Remote destination requires an SSH connection. - * Select a destination or type a path in the field. - * Define how long to keep snapshots in the destination. -* Scheduling: - * Run automatically starts the replication after a related periodic snapshot task completes. - * To automate the task according to its schedule, set that option and define a schedule for the replication task. -{{< /expand >}} - -## Creating an Advanced Replication Task - -To use the advanced editor to create a replication task, go to **Tasks > Replication Tasks**, click **ADD** to open the Wizard, then click **ADVANCED REPLICATION CREATION**. - -![TasksReplicationAddAdvanced](/images/CORE/Tasks/TasksReplicationAddAdvanced.png "Advanced Replication Tasks") - -Options group by category. -Options can appear, disappear, or be disabled depending on the configuration choices you make. -Start by configuring the **General** options first, then the **Transport** options before configuring replication **Sources** and **Destination**. - -Name the task. -Each task name must be unique, and we recommend you name it in a way that makes it easy to remember what the task is doing. - -Choose whether the local system is sending (*Push*) or receiving data (*Pull*) and decide what **Transport** method to use for the replication before configuring the other sections. - -### Transport Options - -The **Transport** selector determines the method to use for the replication: -*SSH* is the standard option for sending or receiving data from a remote system, but *SSH+NETCAT* is faster for replications within completely secure networks. -*Local* is only used for replicating data to another location on the same system. - -With SSH-based replications, configure the transport method by selecting the **SSH Connection** to the remote system that sends or receives snapshots. -Options for compressing data, adding a bandwidth limit, or other data stream customizations are available. **Stream Compression** options are only available when using SSH. Before enabling **Compressed WRITE Records**, verify that the destination system supports compressed WRITE records. - -![TasksReplicationAddAvancedTransportOptions](/images/CORE/Tasks/TasksReplicationAddAdvancedTransportOptions.png "Advanced Replication: Transport") - -For *SSH+NETCAT* replications, you also need to define the addresses and ports to use for the Netcat connection. - -{{< hint type=important >}} -**Allow Blocks Larger than 128KB** is a one-way toggle. -Replication tasks using large block replication only continue to work as long as this option remains enabled. -{{< /hint >}} - -### Source - -The replication **Source** is the datasets or zvols to replicate. -Select the sources for the replication task by opening the file browser or entering dataset names in the field. -Pulling snapshots from a remote source requires a valid **SSH Connection** before the file browser can show any directories. -If the file browser shows a connection error after selecting the correct **SSH Connection**, you might need to log in to the remote system and ensure it allows SSH connections. -Go to the **Services** screen and check the **SSH** service configuration. Start the service. - -![TasksReplicationAddAdvancedSource](/images/CORE/Tasks/TasksReplicationAddAdvancedSource.png "Advanced Replication: Source") - -By default, replication tasks use snapshots to quickly transfer data to the receiving system. -When **Full Filesystem Replication** is set, the chosen **Source** completely replicates, including all dataset properties, snapshots, child datasets, and clones. -When choosing this option, we recommend allocating additional time for the replication task to run. -Leaving **Full Filesystem Replication** unset but setting **Include Dataset Properties** includes just the dataset properties in the snapshots to be replicated. -Additional options allow you to recursively replicate child dataset snapshots or exclude specific child datasets or properties from the replication. - -Local sources replicate by snapshots you generated from a periodic snapshot task or from a defined naming schema that matches manually created snapshots. -Remote sources require entering a snapshot naming schema to identify the snapshots to replicate. -A naming schema is a collection of [strftime](https://www.freebsd.org/cgi/man.cgi?query=strftime) time and date strings and any identifiers that a user might have added to the snapshot name. -For example, entering the naming schema `custom-%Y-%m-%d_%H-%M` finds and replicates snapshots like `custom-2020-03-25_09-15`. -Multiple schemas can be entered by pressing Enter to separate each schema. - -To define specific snapshots from the periodic task to replicate, set **Replicate Specific Snapshots** and enter a schedule. -The only periodically generated snapshots in the replication task are those that match your defined schedule. -Alternately, you can use your **Replication Schedule** to determine which snapshots replicate by setting **Run Automatically**, **Only Replicate Snapshots Matching Schedule**, and defining when the replication task runs. - -When a replication task has difficulty completing, set **Save Pending Snapshots**. -**Save Pending Snapshots** prevents the source TrueNAS from automatically deleting any snapshots that fail to replicate to the destination system. - -### Destination - -The destination is where replicated data is stored. -Choosing a remote destination requires an *[SSH Connection]({{< relref "ConfiguringSSHConnections.md" >}})* to that system. -Expanding the file browser shows the current available datasets on the destination system. -You can click a destination or manually type a path in the field. -Adding a name to the end of the path creates a new dataset in that location. - -{{< hint type=important >}} -**DO NOT** use zvols for a remote destination -{{< /hint >}} - -![TasksReplicationAddAdvancedDestination](/images/CORE/Tasks/TasksReplicationAddAdvancedDestination.png "Advanced Replication: Destination") - -By default, the destination dataset is *SET* to be **read-only** after the replication is complete. -You can change the **Destination Dataset Read-only Policy** to only start replication when the destination is read-only (*REQUIRE*) or to disable checking the dataset's read-only state (*IGNORE*). - -**Encryption** adds another layer of security to replicated data by encrypting the data before transfer and decrypting it on the destination system. -Setting the checkbox allows using a *HEX* key or defining your own encryption *PASSPHRASE*. -The encryption key can be stored in the TrueNAS system database or in a custom-defined location. - -{{< hint type=important >}} -**Synchronizing Destination Snapshots With Source** destroys any snapshots in the destination that do not match the source snapshots. -TrueNAS also fully replicates the source snapshots as if the replication task had never run before, which leads to excessive bandwidth consumption. -This can be a destructive option, so be sure that any snapshots that the task deletes from the destination are obsolete or otherwise backed up in a different location. -{{< /hint >}} - -Defining the **Snapshot Retention Policy** is generally recommended to prevent cluttering the system with obsolete snapshots. -Choosing **Same as Source** keeps the snapshots on the destination system for the same duration as the defined snapshot lifetime from the source system periodic snapshot task. -You can also define your own *Custom* lifetime for snapshots on the destination system. - -### Schedule - -By default, setting the task to **Run Automatically** starts the replication immediately after the related periodic snapshot task is complete. - -Setting the **Schedule** checkbox allows scheduling the replication to run at a separate time. - -Setting **Only Replicate Snapshots Matching Schedule** restricts the replication to only replicate those snapshots created at the same time as the replication schedule. - -![TasksReplicationAddAdvancedSchedule](/images/CORE/Tasks/TasksReplicationAddAdvancedSchedule.png "Advanced Replication: Schedule") diff --git a/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/LocalReplication.md b/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/LocalReplication.md deleted file mode 100644 index 22ac433c88..0000000000 --- a/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/LocalReplication.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: "Local Replication" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/creatingreplicationtasks/localreplication/" -description: "Describes how to create local replication tasks on TrueNAS CORE." -weight: 10 -aliases: - - /core/coretutorials/tasks/replicationtasks/localreplication/ - - /core/tasks/replicationtasks/ - - /core/tasks/replicationtasks/local/ -tags: -- replication ---- - -{{< expand "Process Summary" "v" >}} -## Process Summary - -* Requirements: Storage pools and datasets created in **Storage > Pools**. - -* Go to **Tasks > Replication Tasks** and click **ADD** - * Choose Sources. - * Set the source location to the local system. - * Use the file browser or type paths to the sources. - * Define a Destination path. - * Set the destination location to the local system. - * Select or manually define a path to the single destination location for the snapshot copies. - * Set the Replication schedule to run once. - * Define how long the snapshots is stored in the **Destination**. - * Clicking **START REPLICATION** immediately snapshots the chosen. Sources and copies those snapshots to the **Destination**. - * Dialog might ask to delete existing snapshots from the **Destination**. Be sure to protect that all-important data before deleting anything. -* Clicking the task **State** shows the logs for that replication task. -{{< /expand >}} - -## Quick Backups with the Replication Wizard - -TrueNAS provides a wizard for quickly configuring different simple replication scenarios. - -![TasksReplicationTasksAdd](/images/CORE/Tasks/TasksReplicationTasksAdd.png "New Replication Task") - -While we recommend regularly scheduled replications to a remote location as the optimal backup scenario, the wizard can quickly create and copy ZFS snapshots to another location on the same system. -This is useful when you have no remote backup locations or when a disk is in danger of failure. - -All you need to create a local replication are datasets or zvols in a storage pool to use as the replication source and (preferably) a second storage pool to store replicated snapshots. -You can set up the local replication entirely in the Replication Wizard. - -To open the Replication Wizard, go to **Tasks > Replication Tasks** and click **ADD**. -Set the source location to the local system and pick which datasets to snapshot. -The wizard takes new snapshots of the sources when it can't find existing source snapshots. -Enabling **Recursive** replicates all snapshots contained within the selected source dataset snapshots. -Local sources can also use a naming schema to identify and include custom snapshots in the replication. -A naming schema is a collection of [strftime](https://www.freebsd.org/cgi/man.cgi?query=strftime) time and date strings and any identifiers that a user might have added to the snapshot name. - -![TasksReplicationTasksAddLocalSource](/images/CORE/Tasks/TasksReplicationTasksAddLocalSource.png "Replication with Local Source") - -Set the **Destination** to the local system and define the path to the storage location for replicated snapshots. -When manually defining the **Destination**, type the full path to the destination location. - -![TasksReplicationTasksAddLocalSourceLocalDest](/images/CORE/Tasks/TasksReplicationTasksAddLocalSourceLocalDest.png "Local Source and Destination") - -TrueNAS suggests a default name for the task based on the selected source and destination locations, but you can type your name for the replication. -You can load any saved replication task into the wizard to make creating new replication schedules even easier. - -You can define a specific schedule for this replication or choose to run it immediately after saving the new task. -Unscheduled tasks are still saved in the replication task list and can be run manually or edited later to add a schedule. - -The destination lifetime is how long copied snapshots store in the **Destination** before the system deletes them. -We usually recommend defining a snapshot lifetime to prevent storage issues. -Choosing to keep snapshots indefinitely can require you to manually clean old ones from the system if or when the **Destination** fills to capacity. - -![TasksReplicationTasksAddLocalSourceLocalDestCustomLife](/images/CORE/Tasks/TasksReplicationTasksAddLocalSourceLocalDestCustomLife.png "Custom Lifetime") - -Clicking **START REPLICATION** saves the new task and immediately attempts to replicate snapshots to the **Destination**. -When TrueNAS detects that the **Destination** already has unrelated snapshots, it asks to delete the unrelated ones and do a full copy of the new ones. -**START REPLICATION** can delete data, so be sure you are okay with deleting any existing snapshots. Alternatively, back them up in another location. - -The simple replication is added to the replication task list and shows that it is currently running. -Clicking the task state shows the replication log with an option to download it to your local system. - -![TasksReplicationTasksLocalLogs](/images/CORE/Tasks/TasksReplicationTasksLocalLogs.png "Local Replication Log") - -To confirm that snapshots replicated, go to **Storage > Snapshots** and verify the destination dataset has new snapshots with correct timestamps. - -![TasksReplicationTasksLocalSnapshots](/images/CORE/Tasks/TasksReplicationTasksLocalSnapshots.png "Finding Replicated Snapshots") diff --git a/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/RemoteReplication.md b/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/RemoteReplication.md deleted file mode 100644 index 65b9fe1d9a..0000000000 --- a/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/RemoteReplication.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: "Remote Replication" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/creatingreplicationtasks/remotereplication/" -description: "Describes how to create a remote replication task on TrueNAS CORE." -weight: 20 -aliases: - - /core/coretutorials/tasks/replicationtasks/remote/ - - /core/tasks/replicationtasks/remote/ -tags: -- replication ---- - -Configure [SSH]({{< relref "CORE/CORETutorials/SystemConfiguration/ConfiguringSSHConnections.md" >}}) and [automatic dataset snapshots]({{< relref "CreatingPeriodicSnapshotTasks.md" >}}) in TrueNAS before creating a remote replication task. -This ensures that both systems can connect and new snapshots are regularly available for replication. - -To streamline creating simple replication configurations, the replication wizard assists with creating a new SSH connection and automatically creates a periodic snapshot task for sources with no existing snapshots. - -{{< expand "Process Summary" "v" >}} -## Process Summary - -* **Tasks > Replication Tasks** - * Choose sources for snapshot replication. - * Remote sources require an SSH connection. - * TrueNAS shows how many snapshots will replicate. - * Define the snapshot destination. - * A remote destination requires an SSH connection. - * Choose a destination or define it manually by typing a path. - * Adding a new name at the end of the path creates a new dataset. - * Choose replication security. - * We always recommend replication with encryption. - * Disabling encryption is only meant for absolutely secure networks. - * Schedule the replication. - * Schedule can be standardized presets or a custom-defined schedule. - * Running once runs the replication immediately after creation. - * Task is still saved and can be rerun or edited. - * Choose how long to keep the replicated snapshots. -{{< /expand >}} - -## Creating a Remote Replication Task - -Go to **Tasks > Replication Tasks** and click **ADD**. - -![TasksReplicationTasksAdd](/images/CORE/Tasks/TasksReplicationTasksAdd.png "Add new Replication Task") - -You can load any saved replication to prepopulate the wizard with that configuration. -Saving changes to the configuration creates a new replication task without altering the one you loaded into the wizard. -This saves time when creating multiple replication tasks between the same two systems. - -### Sources - -Start by configuring the replication sources. -Sources are the datasets or zvols with snapshots to use for replication. -Choosing a remote source requires selecting an SSH connection to that system. -Expanding the directory browser shows the current datasets or zvols available for replication. -You can select multiple sources or manually type the names into the field. - -TrueNAS shows how many snapshots are available for replication. -We recommend you manually snapshot the sources or create a periodic snapshot task before creating the replication task. -However, when the sources are on the local system and don't have any existing snapshots, TrueNAS can create a basic periodic snapshot task and snapshot the sources immediately before starting the replication. Enabling **Recursive** replicates all snapshots contained within the selected source dataset snapshots. - -![TasksReplicationTasksAddRemoteSource](/images/CORE/Tasks/TasksReplicationTasksAddRemoteSource.png "Choosing a Remote Source") - -Remote sources require entering a **Snapshot Naming Schema** to identify the snapshots to replicate. -A naming schema is a collection of [strftime](https://www.freebsd.org/cgi/man.cgi?query=strftime) time and date strings and any identifiers that a user might have added to the snapshot name. - -Local sources can also use a naming schema to identify and include custom snapshots in the replication. - -### Destination - -The destination is where replicated snapshots are stored. -Choosing a remote destination requires an SSH connection to that system. -Expanding the directory browser shows the current datasets that are available for replication. -You can select a destination dataset or manually type a path in the field. -You cannot use Zvols as a remote replication destination. -Adding a name to the end of the path creates a new dataset in that location. - -![TasksReplicationTasksAddRemoteDest](/images/CORE/Tasks/TasksReplicationTasksAddRemoteDest.png "Replication with Remote Destination") - -![TasksReplicationTasksAddRemoteDestEncrypt](/images/CORE/Tasks/remote_rep_encrypt.png "Remote Destination Encryption Options") - -**Encryption**: To use encryption when replicating data, check the Encryption box. -* *Encryption Key Format* allows the user to choose between a Hex (base 16 numeral) or Passphrase (alphanumeric) style encryption key. -* *Store Encryption key in Sending TrueNAS database* allows the user to either store the Encryption key in the sending TrueNAS database (box checked) or choose a temporary location for the encryption key to decrypt replicated data (box unchecked). - -### Security and Task Name - -{{< hint type=note >}} -Using encryption for SSH transfer security is always recommended. -{{< /hint >}} - -If you are using two systems within a secure network for replication, disabling encryption speeds up the transfer. -However, the data is not protected from malicious sources. - -Choosing no encryption for the task is the same as choosing the *SSH+NETCAT* transport method from the advanced options screen. -NETCAT uses common port settings, but these can be overridden by switching to the advanced options screen or editing the task after creation. - -TrueNAS suggests a name based on the selected sources and destination, but you can overwrite it with a custom name. - -Adding a schedule automates the task to run according to your chosen times. -You can choose between several preset schedules or create a custom schedule for when the replication runs. -Choosing to run the replication once runs the replication immediately after saving the task, but you must manually trigger any additional replications. - -Finally, define how long you want to keep snapshots on the destination system. -We recommend defining snapshot lifetime to prevent cluttering the system with obsolete snapshots. - -![TasksReplicationTasksAddLocalSourceLocalDestCustomLife](/images/CORE/Tasks/TasksReplicationTasksAddLocalSourceLocalDestCustomLife.png "Custom Lifetimes") - -## Starting the Replication - -**Start Replication** saves the new replication task. -TrueNAS enables new tasks by default and activates them according to their schedule (or immediately if you didn't choose a schedule). -The first time a replication task runs, it takes longer because the snapshots must copy entirely fresh to the destination. -Later replications run faster, as only the subsequent changes to snapshots replicate. -Clicking the task state opens the log for that task. - -![TasksReplicationTasksRemoteLogs](/images/CORE/Tasks/TasksReplicationTasksRemoteLogs.png "Remote Replication Log") diff --git a/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/TroubleshootingTips.md b/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/TroubleshootingTips.md deleted file mode 100644 index d5b768ec4f..0000000000 --- a/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/TroubleshootingTips.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "Troubleshooting Tips" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/creatingreplicationtasks/troubleshootingtips/" -description: "Provides troubleshooting tips for replication tasks on TrueNAS CORE." -weight: 40 -aliases: - - /core/coretutorials/tasks/replicationtasks/troubleshootingtips -tags: -- replication ---- - -## Using a Custom Schema - -You can use **Snapshot Tasks** set up or imported with a custom schema name for "full backup" replication tasks. Incremental replication tasks will not work. - -There are several ways to create a custom schema: -* Importing a ZFS dataset with snapshots into TrueNAS with a schema that doesn't match the TrueNAS schema. -* Creating a custom schema name in the **Snapshot Task** occurs when the *Naming Schema* field in a **Periodic Snapshot Task** is not the default. - -## Replication Task Log - -To view and download the replication task log, go to **Tasks > Replication Tasks**. -Click on the *state* of the replication task. - -![TasksReplicationTasksState](/images/CORE/Tasks/RepTaskErrorCORE.png "Replication Task State") - -![TasksReplicationTasksLog](/images/CORE/Tasks/RepTaskLogDownloadCORE.png "Replication Task Log") - -Click the *DOWNLOAD LOGS* button to download the log file. - -## Editing a Replication Task - -To edit the replication task, go to **Tasks > Replication Tasks**. -Click the `>` to expand the replication task information, then click **EDIT**. - -![TasksReplicationTasksEdit](/images/CORE/Tasks/RepEditTaskCORE.png "Replication Task Edit") - -See [**Replication Advanced Options**]({{< relref "AdvancedReplication.md" >}}) for descriptions of the available fields. - -## Replication Task Alert Priorities - -To customize the importance and frequency of a Replication task alert (success or failure), go to **System > Alert Settings** and scroll down to the *Tasks* area. -Set the *Warning Level* and how often the alert notification sends. - -![TasksSetReplicationAlert](/images/CORE/System/AlertTaskReplication.png "Set Replication Alert") - -See [**Alert Settings**]({{< relref "CORE/UIReference/System/AlertSettings.md" >}}) for more information about this UI screen. - -## FAQ - -**Question**: If the internet connection goes down for a while, does the replication restart where it left off - including any intermediate snapshots? - -**Answer**: Yes. - -**Question**: If a site changes a lot of data at once and the internet bandwidth is not enough to finish sending the snapshot before the next one begins, do the replication jobs run one after the other and not stomp on each other? - -**Answer**: Yes. diff --git a/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/_index.md b/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/_index.md deleted file mode 100644 index ad63cb9fae..0000000000 --- a/content/CORE/CORETutorials/Tasks/CreatingReplicationTasks/_index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "Creating Replication Tasks" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/creatingreplicationtasks/" -description: "TrueNAS CORE replication tutorials." -geekdocCollapseSection: true -weight: 60 -related: false ---- - -{{< children depth="2" description="true" >}} diff --git a/content/CORE/CORETutorials/Tasks/CreatingRsyncTasks.md b/content/CORE/CORETutorials/Tasks/CreatingRsyncTasks.md deleted file mode 100644 index 27f461974b..0000000000 --- a/content/CORE/CORETutorials/Tasks/CreatingRsyncTasks.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -title: "Creating Rsync Tasks" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/creatingrsynctasks/" -description: "Provides information on how to create a remote sync (rsync) task on your TrueNAS." -weight: 30 -aliases: - - /core/tasks/rsync/ -tags: -- rsync -- databackup ---- - -Rsync is a fast and secure way to copy data to another system, either for backup or data migration purposes. -An [rsync](https://rsync.samba.org/) task requires configuration of both a **Host** and **Remote** system. These instructions assume a TrueNAS system for both the **Host** and **Remote** configurations. - -## Basic Requirements - -Rsync requires a [dataset]({{< relref "CORE/CORETutorials/Storage/Pools/Datasets.md" >}}) with the needed data on the **Host** or **Remote** system. -Rsync provides the ability to either push or pull data. -When using rsync to push, data copies from a **Host** system to a **Remote** system. -When using rsync to pull, data pulls from a **Remote** system. It is then put on the **Host** system. - -TrueNAS has extra requirements depending on if you choose the **Module** or **SSH** rsync mode. - -### Rsync Services Requirements - -Before you create an rsync task on the **Host** system, you must create a module on the **Remote** system. The **Remote** system must have rsync service activated. -When TrueNAS is the **Remote** system, create a module by going to **Services** and clicking for the rsync service. Click the **Rsync Module** tab, then click **ADD**. See [ConfiguringRsync]({{< relref "ConfiguringRsync.md" >}}) for more information. - -## Creating a Module Mode Rsync Task - -Log in to the **Host** system interface, go to **Tasks > Rsync Tasks**, and click **ADD**. - -![TasksRsyncTasksAddModeModule](/images/CORE/Tasks/TasksRsyncTasksAddModeModule.png "Rsync Task: Module Mode") - -Select the **Source** dataset to use with the rsync task and a **User** account to run the rsync task. -Select a **Direction** for the rsync task. - -Select a **Schedule** for the rsync task. - -Enter the **Remote Host** IP address or host name. -Use the format `username@remote_host` when the user name differs on the **Remote** host. -Select **Module** in the **Rsync Mode** dropdown list. -Enter the **Remote Module Name** as it appears on the **Remote** system. - -Configure the remaining options according to your specific needs. - -Clearing **Enabled** disables the task schedule. -You can still save the rsync task and run it as a manual task. - -## Creating an SSH Mode Rsync Task - -### SSH Requirements - -The **Remote** system must have **SSH** enabled. -To enable SSH in TrueNAS, go to **Services** and click the **SSH** toggle button. The toggle button turns blue when the service is on. - -The **Host** system needs an established [SSH connection]({{< relref "CORE/CORETutorials/SystemConfiguration/ConfiguringSSHConnections.md" >}}) to the **Remote** for the rsync task. -To create the connection, go to **System > SSH Connections** and click **ADD**. -Configure a **Semi-automatic** connection and from the **Private Key** dropdown list select **Generate New**. - -{{< expand "Can this be set up in a command line instead?" "v" >}} -Go to the shell on the system entered in the **Host** field. -When a TrueNAS account other than *root* manages the rsync task, enter `su - USERNAME`, where *USERNAME* is the TrueNAS user account that runs the rsync task. -Enter `ssh-keygen -t rsa` to create the key pair. -When prompted for a password, press Enter without setting a password (a password breaks the automated task). -Here is an example of running the command: - -```zsh -truenas# ssh-keygen -t rsa -Generating public/private rsa key pair. -Enter file in which to save the key (/root/.ssh/id_rsa): -Created directory '/root/.ssh'. -Enter passphrase (empty for no passphrase): -Enter the same passphrase again: -Your identification has been saved in /root/.ssh/id_rsa. -Your public key has been saved in /root/.ssh/id_rsa.pub. -The key fingerprint is: -SHA256:NZMgbuPvTHeEqi3SA/U5wW8un6AWrx8ZsRQdbJJHmR4 tester@truenas.local -The key randomart image is: -+---[RSA 2048]----+ -| . o=o+ | -| . .ooE. | -| +.o==. | -| o.oo+.+ | -| ...S+. . | -| . ..++o. | -| o oB+. . | -| . =Bo+.o | -| o+==oo | -+----[SHA256]-----+ -``` -The default public key location is \~/.ssh/id_rsa.pub. -Enter `cat ~/.ssh/id_rsa.pub` to see the key and copy the file contents. -Copy it to the corresponding user account on the **Remote** system in **Accounts > Users**. -Click **EDIT** and paste the key into **SSH Public Key**. - -Next, copy the host key from the **Remote** system to the **Host** system user .ssh/known_hosts directory, using `ssh-keyscan`. - -On the host system, open the shell and enter ssh-keyscan -t rsa remoteIPaddress >> userknown_hostsDir where *remoteIPaddress* is the **Remote** system IP address and *userknown_hostsDir* is the known_hosts directory on the host system. -Example: `ssh-keyscan -t rsa 192.168.2.6 >> /root/.ssh/known_hosts`. -{{< /expand >}} - -### SSH Mode Process - -Go to **Tasks > Rsync Tasks** and click **ADD**. - -![TasksRsyncTasksAddModeSSH](/images/CORE/Tasks/TasksRsyncTasksAddModeSSH.png "Rsync Task: SSH Mode") - -Configure the SSH settings first by selecting **SSH** in the **Rsync Mode** dropdown list. Enter the **Port** number and **Remote Path**. - -Define the **Source** dataset for the rsync task and select an account in **User**. -The name in **User** must be identical to the [SSH Connection]({{< relref "CORE/CORETutorials/SystemConfiguration/ConfiguringSSHConnections" >}}) **Username**. - -Select a direction for the rsync task, either **Push** or **Pull**, and define the task **Schedule**. - -Enter the **Remote** host IP address or host name. -Use the format `username@remote_host` if the user name differs on the **Remote** host. -Configure the remaining options according to your specific needs. - -Clearing the **Enabled** checkbox disables the task schedule without deleting the configuration. -You can still run the rsync task by going to **Tasks > Rsync Tasks** and clicking , then **RUN NOW**. - -## Rsync Service and Modules - -The rsync task does not work when the related system service is off. -To turn the rsync service on, go to **Services** and click the **rsync** toggle button. The toggle button turns blue when the service is on. -See [Configuring Rsync]({{< relref "ConfiguringRsync.md" >}}) for more information on rsync configuration and module creation. diff --git a/content/CORE/CORETutorials/Tasks/CreatingScrubTasks.md b/content/CORE/CORETutorials/Tasks/CreatingScrubTasks.md deleted file mode 100644 index 6434d6555d..0000000000 --- a/content/CORE/CORETutorials/Tasks/CreatingScrubTasks.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "Creating Scrub Tasks" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/creatingscrubtasks/" -description: "Describes how to create scrub tasks on TrueNAS CORE." -weight: 80 -aliases: - - /core/tasks/scrubtasks/ -tags: -- scrub ---- - -A "scrub" is when ZFS scans the data on a pool. -Scrubs identify data integrity problems, detect silent data corruptions caused by transient hardware issues, and provide early disk failure alerts. - -## Edit Default Scrub Tasks - -By default, TrueNAS creates a scrub task when you create a new pool. -The default schedule for a scrub is to run every Sunday at 12:00 AM. -To edit the default scrub, go to **Tasks > Scrub Tasks**, click , and **EDIT**. - -## Create New Scrub Tasks - -To create a scrub task for a pool, go to **Tasks > Scrub Tasks** and click **ADD**. - -![TasksScrubTasksAdd](/images/CORE/Tasks/TasksScrubTasksAdd.png "Creating a new Scrub Task") - -Select a **Pool**, enter the **Threshold** (in days), and give the scrub a description. Assign a **Schedule** and click **SUBMIT**. diff --git a/content/CORE/CORETutorials/Tasks/GoogleDriveSync.md b/content/CORE/CORETutorials/Tasks/GoogleDriveSync.md deleted file mode 100644 index 50a3c6571c..0000000000 --- a/content/CORE/CORETutorials/Tasks/GoogleDriveSync.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: "Backing Up Google Drive to TrueNAS" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/googledrivesync/" -description: "Describes how to back up Google Drive to TrueNAS CORE." -weight: 100 -tags: -- cloud ---- - -Google Drive and G Suite are widely used to create and share documents, spreadsheets, and presentations with team members. - -Although cloud-based tools have inherent backups and replications included by the cloud provider, certain users may require additional backup or archive capabilities. - -For example, companies using G Suite for important work may need to keep records for years, potentially beyond the scope of the G Suite subscription. - -TrueNAS can easily back up Google Drive using its built-in cloud sync. - -### Set up Google Drive Credentials - -Go to **System > Cloud Credentials** and click **ADD**. -Name the Credential and select **Google Drive** as the Provider. -Click **LOGIN TO PROVIDER** and log in with the appropriate Google user account. - -![CloudCredentialsAddCredentials](/images/CORE/System/CloudCredentialsAddCredentials.png "Cloud Credentials Add Credentials") - -Google requests permission to access all the Google Drive files for the FreeNAS device. - -![GoogleOAuthProceed](/images/TrueNASCommon/GoogleOAuthProceed.png "Google OAuth Proceed") - -![GoogleOAuthAccount](/images/TrueNASCommon/GoogleOAuthAccount.png "Google OAuth Account") - -![GoogleOAuthPermissions](/images/TrueNASCommon/GoogleOAuthPermissions.png "Google OAuth Permissions") - -Allow access. The appropriate access key generates in the FreeNAS access token. You may assign a Team ID if necessary. - -Click **VERIFY CREDENTIAL** and wait for it to verify, then click **SUBMIT** - -![CredentialsVerify](/images/TrueNASCommon/CredentialsVerify.png "Credentials Verify") - -### Create the Cloud Sync Task - -Go to **Tasks > Cloud Sync Tasks** and set the backup time frame, frequency, and folders (cloud-based folder and TrueNAS dataset). -Set whether the synchronization should sync all changes, copy new files, or move files. -Add a description for the task and select the cloud credentials. -Choose the appropriate cloud folder target and TrueNAS storage location. - -Select the file transfer mode: - -+ **Sync**: Keep files newly created or deleted the same. -+ **Copy**: Copy new files to the appropriate target (i.e., TrueNAS pulls files from Google Drive or pushes files to Google Drive). -+ **Move**: Copy files to the target and delete them from the source. With **Move**, users can set a folder in Google Drive for archival and move older documents to that folder from their Drive account. The task would automatically back up the files to the TrueNAS storage. - -![TasksCloudSyncCreate](/images/CORE/Tasks/TasksCloudSyncCreate.png "Tasks Cloud Sync Create") - -Once you create the task, attempt a **Dry Run**. - -![CloudSyncDryRun](/images/TrueNASCommon/CloudSyncDryRun.png "Cloud Sync Dry Run") - -![CloudSyncDryRunLog](/images/CORE/Tasks/CloudSyncDryRunLog.png "Cloud Sync Dry Run Log") - -If the Dry Run succeeds, click **SAVE**.. - -![CloudSyncTaskNew](/images/CORE/Tasks/CloudSyncTaskNew.png "Cloud Sync Task New") - -Expand the section down to see the task options. - -![CloudSyncTaskNewExpanded](/images/CORE/Tasks/CloudSyncTaskNewExpanded.png "Cloud Sync Task New Expanded") - -Clicking **RUN NOW** prompts the task to start immediately. - -![CloudSyncRunNow](/images/CORE/Tasks/CloudSyncRunNow.png "Cloud Sync Run Now") - -![CloudSyncTaskStarted](/images/CORE/Tasks/CloudSyncTaskStarted.png "Cloud Sync Task Started") - -![CloudSyncTaskRunning](/images/CORE/Tasks/CloudSyncTaskRunning.png "Cloud Sync Task Running") - -The web interface shows the status as **RUNNING** and **SUCCESS** upon completion. You can see details in the **Task Manager**. While the task runs, clicking on the **RUNNING** button reveals a popup log. - -![CloudSyncTaskRunningLog](/images/CORE/Tasks/CloudSyncTaskRunningLog.png "Cloud Sync Task Running Log") - -Once the sync reports **SUCCESS**, you can verify it by opening the folder on another computer if it is a share, through SSH access, or by checking the destination directory through the TrueNAS CLI. - -![CloudSyncTaskSuccess](/images/CORE/Tasks/CloudSyncTaskSuccess.png "Cloud Sync Task Success") - -## Working with Google-Created Content - -{{< include file="/static/includes/GoogleDriveBadPermissions.md" >}} diff --git a/content/CORE/CORETutorials/Tasks/RunningSMARTTests.md b/content/CORE/CORETutorials/Tasks/RunningSMARTTests.md deleted file mode 100644 index 7485254336..0000000000 --- a/content/CORE/CORETutorials/Tasks/RunningSMARTTests.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "Running S.M.A.R.T. Tests" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/runningsmarttests/" -description: "Provides information on how to run Self-Monitoring, Analysis and Reporting Technology (S.M.A.R.T.) tests on your TrueNAS." -weight: 40 -aliases: - - /core/tasks/smarttests/ -tags: -- smart -- systemleveltasks ---- - -[S.M.A.R.T.](https://en.wikipedia.org/wiki/S.M.A.R.T.) (Self-Monitoring, Analysis and Reporting Technology) is an industry standard for disk monitoring and testing. -Disks are monitored for problems using several different kinds of self-tests. -TrueNAS can adjust when and how [alerts]({{< relref "CORE/CORETutorials/SystemConfiguration/CreatingAlerts.md" >}}) for S.M.A.R.T. are issued. -When S.M.A.R.T. monitoring reports an issue, we recommend you replace that disk. -Most modern ATA, IDE, and SCSI-3 hard drives support S.M.A.R.T. -Refer to your respective drive documentation for confirmation. - -S.M.A.R.T. tests run on a disk. -Running tests can reduce drive performance, so we recommend scheduling tests when the system is in a low-usage state. -Avoid scheduling disk-intensive tests at the same time! -For example, do not schedule S.M.A.R.T. tests on the same day as a disk [scrub]({{< relref "CORE/CORETutorials/Tasks/CreatingScrubTasks.md" >}}) or [resilver]({{< relref "CORE/CORETutorials/Tasks/UsingResilverPriority.md" >}}). - -{{< expand "How do I check or change S.M.A.R.T. testing for a disk?" "v" >}} -Go to **Storage > Disks** and click to expand an entry. -**Enable S.M.A.R.T.** shows as **true** or **false**. - -To enable or disable testing, click **EDIT DISK(S)** and find the **Enable S.M.A.R.T.** option. -{{< /expand >}} - -## Manual S.M.A.R.T. Tests - -To quickly test a disk for errors, go to **Storage > Disks** and select the disks to be tested. -After selecting the desired disks, click **MANUAL TEST**. - -![StorageDisksManualTest Options](/images/CORE/Storage/StorageDisksManualTestOptions.png "Manual Test Options") - -Next, select the test **Type**. -Each test type can differ based on the drive connection, ATA or SCSI: - -### ATA Connection - -* **Long** - runs S.M.A.R.T. Extended Self-Test. This scans the entire disk surface and can take many hours on large-volume disks. -* **Short** - runs S.M.A.R.T. Short Self-Test (usually under ten minutes). These are basic disk tests that vary by manufacturer. -* **Conveyance** - runs S.M.A.R.T. Conveyance Self-Test. - This self-test routine identifies damage incurred during transporting of the device. - This self-test routine requires only minutes to complete. -* **Offline** - runs S.M.A.R.T. Immediate Offline Test. - Updates the S.M.A.R.T. attribute values. If the test finds errors, the errors only appear in the SMART error log. - -### SCSI Connection -* **Long** - runs the *Background long* self-test. -* **Short** - runs the *Background short* self-test. -* **Offline** - runs the default self-test in foreground. - No entry is placed in the self-test log. - -Click **START** to begin the test. -Depending on the test type you choose, the test can take some time to complete. -TrueNAS generates alerts when tests discover issues. - -To view results, go to **Storage > Disks**, expand an entry, and click **S.M.A.R.T. TEST RESULTS**. - -## Automatic S.M.A.R.T. Tests - -Go to **Tasks > S.M.A.R.T. Tests** and click **ADD**. - -![TasksSMARTTestsAdd](/images/CORE/Tasks/TasksSMARTTestsAdd.png "Add recurring S.M.A.R.T. test") - -Select the **Disks** to test, **Type** of test to run, and **Schedule** for the task. - -{{< hint type=important >}} -S.M.A.R.T. tests can offline disks! Avoid scheduling S.M.A.R.T. tests simultaneously with scrub or resilver operations. -{{< /hint >}} - -Saved schedules appear in the **Tasks > S.M.A.R.T. Tests** list. - -## Service Options - -You must [enable S.M.A.R.T. service]({{< relref "CORE/CORETutorials/Services/ConfiguringSMART.md" >}}) to run automatic S.M.A.R.T. tests. - -{{< expand "RAID controllers?" "v" >}} -Disable the S.M.A.R.T. service when using a RAID disk controller. -The controller monitors S.M.A.R.T. separately and marks disks as a **Predictive Failure** on a test failure. -{{< /expand >}} diff --git a/content/CORE/CORETutorials/Tasks/UsingAdvancedScheduler.md b/content/CORE/CORETutorials/Tasks/UsingAdvancedScheduler.md deleted file mode 100644 index 23c5b18b57..0000000000 --- a/content/CORE/CORETutorials/Tasks/UsingAdvancedScheduler.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: "Using the Advanced Scheduler" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/usingadvancedscheduler/" -description: "Describes how to use the Advanced Scheduler on TrueNAS CORE." -weight: 95 -tags: -- advancedscheduler ---- - -![Tasks Advanced Scheduler](/images/CORE/Tasks/TasksAdvancedScheduler.png "Tasks Advanced Scheduler") - -Choosing a **Presets** option automatically populates all fields. - -To customize a schedule, enter [crontab](https://www.freebsd.org/cgi/man.cgi?crontab(5)) values for the **Minutes**/**Hours**/**Days**. - -The simplest option is to enter a single number in the field. -The task runs when the time value matches that number. -Entering *10* runs the task when the time is ten minutes past the hour. - -An asterisk (_*_) matches all values. - -Set specific time ranges by entering hyphenated number values. -Entering *30-35* in the **Minutes** field runs the task at minutes 30, 31, 32, 33, 34, and 35. - -You can list individual values separated by a comma (*,*). -Entering *1,14* in the **Hours** field runs the task at 1:00 AM (0100) and 2:00 PM (1400). - -A slash (*/*) designates a step value. -Entering _*_ in **Days** runs the task every day of the month, while _*/2_ runs it every other day. - -Combining all the above examples creates a schedule running a task each minute from 1:30-1:35 AM and 2:30-2:35 PM every other day. - -There is an option to select which **Months** the task runs. -Leaving each month unset is the same as selecting every month. - -The **Days of Week** schedules the task to run on specific days plus any listed days. -Entering *1* in **Days** and setting *Wed* for **Days of Week** creates a schedule that starts a task on the first day of the month *and* every Wednesday of the month. - -The **Schedule Preview** displays when the current settings mean the task runs. - -{{< expand "Examples of CRON syntax" "v" >}} - - - - - - - - - - - - - - - - - - - - - - - - - -
SyntaxMeaningExamples
* Every item.* (minutes) = every minute of the hour.
* (days) = every day.
*/N Every Nth item.*/15 (minutes) = every 15th minute of the hour (every quarter hour).
*/3 (days) = every 3rd day.
*/3 (months) = every 3rd month.
Comma and hyphen/dashEach stated item (comma)
Each item in a range (hyphen/dash).
1,31 (minutes) = on the 1st and 31st minute of the hour.
1-3,31 (minutes) = on the 1st to 3rd minutes inclusive, and the 31st minute, of the hour.
mon-fri (days) = every Monday to Friday inclusive (every weekday).
mar,jun,sep,dec (months) = every March, June, September, December.
- -You can specify days as days of the month or days of the week. - -With these options, you can create flexible schedules similar to these examples: - - - - - - - - - - - - - - - - - - - - - - - - - - -
Desired scheduleValues to enter
3 times a day (at midnight, 08:00 and 16:00)months=*; days=*; hours=0/8 or 0,8,16; minutes=0
(Meaning: every day of every month, when hours=0/8/16 and minutes=0)
Every Monday, Wednesday and Friday, at 8.30 pmmonths=*; days=mon,wed,fri; hours=20; minutes=30
1st and 15th day of the month, during October to June, at 00:01 ammonths=oct-dec,jan-jun; days=1,15; hours=0; minutes=1
Every 15 minutes during the working week, which is 8am - 7pm (08:00 - 19:00) Monday to FridayNote that this requires two tasks to achieve:
(1) months=*; days=mon-fri; hours=8-18; minutes=*/15
(2) months=*; days=mon-fri; hours=19; minutes=0
We need the second scheduled item, to execute at 19:00, otherwise we would stop at 18:45. Another workaround is to stop at 18:45 or 19:45 rather than 19:00.
-{{< /expand >}} diff --git a/content/CORE/CORETutorials/Tasks/UsingResilverPriority.md b/content/CORE/CORETutorials/Tasks/UsingResilverPriority.md deleted file mode 100644 index 2839403b60..0000000000 --- a/content/CORE/CORETutorials/Tasks/UsingResilverPriority.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "Using Resilver Priority" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/usingresilverpriority/" -description: "Describes how to configure resilver priority tasks on TrueNAS CORE." -weight: 70 -tags: -- zfs -- resilver ---- - -{{< include file="/static/includes/ResilverPriority.md" >}} - -Go to **Tasks > Resilver Priority** to configure the priority to the best time for your environment. - -![TasksResilverPriority](/images/CORE/Tasks/TasksResilverPriority.png "Scheduling Resilver Priority Times") - -{{< include file="/static/includes/ResilverPrioritySetWhen.md" >}} diff --git a/content/CORE/CORETutorials/Tasks/_index.md b/content/CORE/CORETutorials/Tasks/_index.md deleted file mode 100644 index c341b57a03..0000000000 --- a/content/CORE/CORETutorials/Tasks/_index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Tasks" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/tasks/" -description: "Tutorial articles about a wide variety of TrueNAS system tasks." -geekdocCollapseSection: true -weight: 70 -related: false ---- - -TrueNAS includes an easy to use interface for common tasks a sysadmin needs to preform on a NAS on a regular basis. These can roughly be broken down into three groups. - -{{< children depth="2" description="true" >}} diff --git a/content/CORE/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md b/content/CORE/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md deleted file mode 100644 index 4a1aaf5264..0000000000 --- a/content/CORE/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -title: "Updating CORE Enterprise" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/updatingtruenas/updatingenterprise/" -description: "Describes how to update Enterprise-licensed TrueNAS CORE deployments." -geekdocCollapseSection: true -weight: 20 -aliases: - - /core/system/update/updateenterprise/ -tags: -- enterprise ---- - -{{< enterprise >}} -This is Enterprise content that specifically applies to High Availability (HA) systems with a TrueNAS Enterprise license active. -{{< /enterprise >}} - -Updating a TrueNAS Enterprise system configured for High Availability (HA) has a slightly different flow from non-HA systems on TrueNAS Core. -The system downloads the update to both controllers, updates and reboots the standby TrueNAS controller, and finally fails over from and updates the active TrueNAS controller. - -## Prepare the System - -An update usually takes between thirty minutes and an hour. -The system must reboot after the update, so it is recommended to schedule updates during a maintenance window, allowing two to three hours to update, test, and possibly roll back if issues appear. -On large systems, we recommend a proportionally longer maintenance window. - -For individual support during an upgrade, please contact iXsystems Support to schedule your upgrade. -{{< expand "Contacting iXsystems Support" "v" >}} -{{< include file="/static/includes/iXsystemsSupportContact.md" >}} -{{< /expand >}} -Scheduling at least two days ahead of a planned upgrade gives time to ensure a specialist is available for assistance. -Updating from earlier than version 9.3 of TrueNAS must be scheduled with iXsystems Support. - -The update process will not proceed unless there is enough free space in the boot pool for the new update files. -If a space warning displays, go to **System > Boot** and remove any unneeded boot environments. - -Operating system updates only modify the OS devices and do not affect end-user data on storage drives. - -{{< hint type=note >}} -An update could involve upgrading the version of ZFS installed on the storage drives. -When a ZFS version upgrade is available, an **Alert** appears in the web interface. -We do not recommend upgrading the ZFS version on storage drives until you verify that you do not need to roll back to previous operating system versions or swap the storage drives with another system with an earlier ZFS version. -After a ZFS version upgrade, the storage devices are not accessible by earlier TrueNAS versions. -{{< /hint >}} - -## Start the Update - -In the web interface **Dashboard**, find the entry for the active TrueNAS controller and click **CHECK FOR UPDATES**. -This button changes to **UPDATES AVAILABLE** when there is an available update. - -![Dashboard Enterprise](/images/CORE/Dashboard/DashboardEnterprise.png "Dashboard Enterprise") - -Clicking the button goes to **System > Update** and shows the option to **Download Updates** or, when the system has detected and staged an update, **Apply Pending Update**. - -When you click **Download Updates** or **Apply Pending Update**, TrueNAS gives an opportunity to save the current system configuration. -We recommend backing up the system configuration before starting the update. -Including the **Password Secret Seed** in the system configuration removes the encryption from sensitive system data, like stored passwords. -When enabling this option, take extra precautions to store the downloaded system configuration file in a secure location. - -After downloading the system configuration, you can continue the system update. -While updating and rebooting controllers, HA and other system services are briefly unavailable. - -Other users logged in to the web interface see a warning dialog. -A **System Updating** icon displays in the top bar of the web interface while the update is in progress. - -Update progress displays for both TrueNAS controllers. -The standby TrueNAS controller reboots when it finishes updating. -This can take several minutes. -When the standby controller finishes booting, the system must fail over to update and reboot the active TrueNAS controller. - -## Failover to Complete the Update - -To deactivate the active TrueNAS controller and finish the update, go to the **Dashboard**, find the entry for the Standby controller, and click **INITIATE FAILOVER**. - -![DashboardInitiateFailover](/images/CORE/Dashboard/DashboardInitiateFailover.png "Initiate Failover") - -The failover briefly interrupts TrueNAS services and availability. -The browser logs out of the web interface while the active TrueNAS controller deactivates and the standby TrueNAS controller is brought online. -The web interface login screen reappears when the standby TrueNAS controller finishes activating. - -![LoginFailoverEnterprise](/images/CORE/LoginFailoverEnterprise.png "Login after Failover") - -Log in to the web interface and check the HA status in the top toolbar. -This icon shows that HA is unavailable while the previously active TrueNAS controller reboots. -When HA is available, a dialog asks to finish the update. -Click **CONTINUE** to finish updating the previously active TrueNAS controller. - -Verify that the update is complete by going to the **Dashboard** and confirming that the **Version** is the same on both TrueNAS controllers. - -{{< expand "Reverting an Update" "v" >}} -If the update did not install on one of the controllers, the web interface generates an alert about a mismatch between controller versions. - -![HA Controller Versions Error Enterprise](/images/CORE/Dashboard/HAControllerVersionsErrorEnterprise.png "HA Controller Versions Error Enterprise") - -If something else goes wrong with the update, the system generates an alert and writes details to /data/update.failed. - -You can return the system to its pre-update state by activating a previous boot environment during system boot. -To ensure the versions match, do this procedure for both TrueNAS controllers. -This requires physical or IPMI access to the TrueNAS controller console. - -Reboot the system and press the space bar when the boot menu appears, pausing the boot process. - -![BootMenu](/images/CORE/BootMenu.png "TrueNAS Boot Menu") - -Open the **Boot Environments** menu and cycle the **Active** boot environment until one dated prior to the update displays. - -![BootMenuSelectBE](/images/CORE/BootMenuSelectBE.png "Selecting a Boot Environment") - -Return to the first screen and press Enter to boot into that version of TrueNAS. -{{< /expand >}} - -{{< expand "Manually Updating an Enterprise HA System" "v" >}} -Enterprise customers should contact iX Support for assistance updating their TrueNAS system. - -* Download the manual update file located at the [TrueNAS/FreeNAS Download Page](https://download.freenas.org/). -* Go to **System -> Update**. -* Click the **INSTALL MANUAL UPDATE** button. -* Set the **Include Password Secret Seed** checkbox and click the **Save Configuration** button. -* Select the **Update File Temporary Storage Location** and click **Choose File**. Select the manual upgrade file you downloaded. Wait for the file to upload, then click **APPLY UPDATE**. -* The Manual update uploads the file, installs it to both controllers, then reboots the Standby Controller. To complete the upgrade, click **Close** in the dialog box. Initiate a failover of the standby controller, as instructed, by clicking **INITIATE FAILOVER** from the Standby Controller's Dashboard card. -* Log into the system. -* Click **Continue** in the **Pending Upgrade** dialog box. The standby controller reboots completing the upgrade. -{{< /expand >}} diff --git a/content/CORE/CORETutorials/UpdatingTrueNAS/_index.md b/content/CORE/CORETutorials/UpdatingTrueNAS/_index.md deleted file mode 100644 index d864189bc1..0000000000 --- a/content/CORE/CORETutorials/UpdatingTrueNAS/_index.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -title: "Updating CORE" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/updatingtruenas/updatingcore/" -description: "Tutorials for updating or upgrading a TrueNAS CORE system." -geekdocCollapseSection: true -weight: 900 -related: false -tags: -- configbackup -- update -aliases: - - /core/coretutorials/updatingtruenas/updatingcore/ - - /core/coretutorials/updatingtruenas/updatingsoftwareforamajorversion/ - - /core/system/update/updatecore/ - - /core/system/update/majorupgrade/ - - /core/system/update/ ---- - -TrueNAS CORE has an integrated update system to make it easy to keep up to date. - -{{< enterprise >}} -TrueNAS CORE Enterprise High Availability (HA) customers should see [Updating CORE Enterprise]({{< relref "/CORE/CORETutorials/UpdatingTrueNAS/UpdatingENTERPRISE.md" >}}) for additional considerations. -{{< /enterprise >}} - -## Prepare the System - -We recommend performing updates when the TrueNAS system is idle, with no clients connected and no scrubs or other disk activity happening. -Most updates require a system reboot. -Plan updates around scheduled maintenance times to avoid disrupting user activities. - -The update process does not proceed unless there is enough free space in the boot pool for the new update files. -If a space warning displays, go to **System > Boot** to remove unneeded boot environments. - -{{< expand "Updates and Trains" "v" >}} -TrueNAS uses cryptographically signed update files to update. -Update files provide flexibility in deciding when to upgrade the system. -TrueNAS installs updates in a new Boot Environment, allowing you to install and test an update, but revert to a previous Boot Environment in **System > Boot** if anything goes wrong. - -TrueNAS defines software branches known as trains. -We have several trains available for updates, but the web interface only displays trains you can select as an upgrade. - -Update trains have a numeric version followed by a short description. -The current version receives regular bug fixes and new features. -Supported older versions of TrueNAS only receive maintenance updates. -See the [Software Development Life Cycle]({{< relref "SofDevLifecycle.md" >}}) for more details about the development and support timeline for TrueNAS versions. - -We use three different terms to describe train types: - -**STABLE**: Bug fixes and new features are available from this train. Upgrades available from a STABLE train are tested and ready to apply to a production environment. - -**Nightlies**: Experimental train used for testing future versions of TrueNAS. - -**SDK**: Software Developer Kit train has additional tools for testing and debugging TrueNAS. - -{{< hint type=important >}} -The UI shows a warning when the selected train does not suit production use. -Before using a non-production train, be prepared to experience bugs or problems. -Testers are encouraged to submit bug reports at https://ixsystems.atlassian.net. -{{< /hint >}} -{{< /expand >}} - -### Check for Updates - -![System Update](/images/CORE/System/SystemUpdate.png "System Update") - -The system checks daily for updates and downloads an update if one is available. -An alert is issued when a new update becomes available. -The automatic check and download of updates are disabled by unsetting **Check for Updates Daily and Download if Available**. -Click (Refresh) to perform another check for updates. -To change the train, use the drop-down menu to make a different selection. - -{{< hint type=note >}} -The train selector does not allow downgrades. -For example, you cannot select the STABLE train while booted into a Nightly boot environment or a 9.10 train while booted into an 11 boot environment. -To go back to an earlier version after testing or running a more recent version, reboot and select a boot environment for that earlier version. -{{< /hint >}} - -Information about the update displays with a link to the release notes. -Alwys read the release notes before updating to determine if any of the changes in that release impact system use. - -### Save the Configuration File - -A dialog to save the system configuration file appears before installing updates. - -![Save Config](/images/CORE/System/SaveConfig.png "Save Config") - -{{< hint type=important >}} -Keep the system configuration file secure after saving it. -The security information in the configuration file can grant unauthorized access to your TrueNAS system. -{{< /hint >}} - -## Update the System - -Ensure the system is in a low-usage state as described above in [Preparing for Updates](#prepare-the-system). -Click **DOWNLOAD UPDATES** to download and install an update. - -The **Save Configuration** dialog appears so you can save the current configuration to external media. - -A confirmation window appears before installing the update. -If you set **Apply updates and reboot system after downloading**, clicking **CONTINUE** downloads and applies the update, then reboots the system. -The update can be downloaded for a later manual installation by unsetting **Apply updates and reboot system after downloading**. - -**APPLY PENDING UPDATE** displays when an update is downloaded and ready to install. -Setting **Confirm** and clicking **CONTINUE** updates and reboots the system. - -{{< hint type=important >}} -Each update creates a boot environment. -If the update process needs more space, it attempts to remove old boot environments. -TrueNAS does not remove boot environments marked with the *Keep* attribute as shown in **System > Boot**. -The upgrade fails if your system does not have space for a new boot environment. -Space on the operating system device can be manually freed by going to **System > Boot** and removing the *Keep* attribute or deleting any boot environments that are no longer needed. -{{< /hint >}} - -{{< expand "Can I force a full update?" "v" >}} -TrueNAS defaults to delta packages for updates. -While updating, TrueNAS only downloads files that changed in the base operating system since the previous update. -Delta update packages are more efficient than full update packages, providing a faster update and taking less bandwidth. -By contrast, a full update package downloads all the files included in the base system, even if those files have not changed. - -While the full package might require more time to install, there are some rare cases where it is necessary, such as when aplying a patch as a temporary fix to a local system. -A patch fixes a bug within the main codebase. -While software patches often fix bugs, they can also repair security issues or add new features. - -To force a full update, open the shell and enter this command: - -`freenas-update -C /tmp/update-$$ –no-delta –reboot update` - -The updater downloads the full package containing all the files from the latest software release. -When the download completes, the system reboots with the standard configuration. -{{< /expand >}} - -### Manual Updates - -You can manually download and apply updates in **System > Update**. - -{{< hint type=note >}} -You cannot use manual updates to upgrade from older major versions. -{{< /hint >}} - -Go to https://download.freenas.org/ and find an update file of the desired version. -Manual update file names end with manual-update.tar. - -Download the desired update file to your local system. -Log in to the TrueNAS web interface and go to **System > Update**. -Click **INSTALL MANUAL UPDATE FILE**. - -The **Save Configuration** dialog opens. -You can save a copy of the current configuration to external media for backup in case of an update problem. - -After the dialog closes, the manual update screen displays. - -The current version of TrueNAS displays for verification. - -![Update Manual](/images/CORE/System/UpdateManual.png "Manual Update") - -Select the manual update file saved to your local system using **Browse**. -Set **Reboot After Update** to reboot the system after the update installs. -Click **APPLY UPDATE** to begin the update. - -{{< hint type=important >}} -**Update in Progress** - -Starting an update shows a progress dialog. -When an update is in progress, the web interface shows an animated icon in the top row. -Dialogs also appear in every active web interface session to warn that a system update is in progress. -**Do not** interrupt a system update. -{{< /hint >}} - -## Upgrade Via ISO - -To upgrade TrueNAS to a new major version using an .iso file, use the [Release List](https://www.truenas.com/docs/truenasupgrades/) to download the .iso to the computer that prepares the installation media. - -Burn the downloaded .iso file to a CD or USB stick. Refer to the [Prepare the Install File]({{< relref "/CORE/GettingStarted/Install.md#prepare-the-install-file" >}}) instructions in the Installation article for tips about burning the .iso to media using different Operating Systems. - -Insert the prepared media into the system and boot from it. -The installer waits ten seconds in the installer boot menu before booting the default option. -If needed, press Spacebar to stop the timer and choose another boot option. -After the media finishes booting into the installation menu, press Enter to select the default option `1 Install/Upgrade`. -The installer presents a screen showing all available drives. - -{{< hint type=important >}} -All drives display, including boot drives and storage drives. -Only choose boot drives when upgrading. -**Choosing the wrong drives to upgrade or install causes data loss.** -If you are unsure which drives contain the TrueNAS operating system, reboot and remove the install media. -Log in to the TrueNAS web interface and go to **System > Boot > ACTIONS > Boot Pool Status** to identify the boot drives. -More than one drive displays when using a mirror. -{{< /hint >}} - -Highlight the drive where TrueNAS is installed and press Spacebar to mark it with a star. -If using a mirror for the operating system, mark all the drives where the TrueNAS operating system is installed. -Press Enter when done. - -The installer recognizes earlier versions of FreeNAS/TrueNAS installed on the boot drives and asks to either upgrade or do a fresh install: - -![InstallerUpgradeChoice](/images/CORE/Install/InstallerUpgradeChoice.png "Upgrade Choice") - -To perform an upgrade, press Enter to accept the default Upgrade Install. -The installer displays another reminder that you should install the operating system on a disk you are not using for storage. - -![InstallerUpgradeMethod](/images/CORE/Install/InstallerUpgradeMethod.png "Upgrade Method") - -You can install the updated system in a new boot environment or format the entire operating system device to start fresh. -Installing into a new boot environment preserves the old code, allowing a roll-back to previous versions if necessary. -Formatting the boot device is usually not necessary but can reclaim space. -TrueNAS preserves user data and settings when installing in a new boot environment and formatting the operating system device. -Move the highlight to one of the options and press Enter to start the upgrade. - -The installer unpacks the new image and checks for upgrades to the existing database file. -The database file that is preserved and migrated contains your TrueNAS configuration settings. - -![Installer Upgrade Preserved Database](/images/CORE/Install/InstallerUpgradePreservedDatabase.png "Preserved Database") - -Press Enter. -TrueNAS indicates that the upgrade is complete and a reboot is required. -Press *OK*, highlight `3 Reboot System`, then press Enter to reboot the system. -If the upgrade installer was booted from CD, remove the CD. - -During reboot, the previous configuration database can convert to the new version. -The conversion happens during the reboot `Applying database schema changes` line. -The conversion can take a long time to finish, sometimes fifteen minutes or more, and can cause the system to reboot again. -The system boots normally afterwards. -If database errors display but the web interface is accessible, log in, go to **System > General**, and use the **UPLOAD CONFIG** button to upload the configuration backup you downloaded before starting the upgrade. diff --git a/content/CORE/CORETutorials/UsingTaskManager.md b/content/CORE/CORETutorials/UsingTaskManager.md deleted file mode 100644 index d941c3ac37..0000000000 --- a/content/CORE/CORETutorials/UsingTaskManager.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Task Manager" -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/usingtaskmanager/" -description: "Use the Task Manager screen to display a list of tasks performed by your TrueNAS and to view logs related to system tasks." -weight: 14 -aliases: [/administration/taskmanager/] -tags: -- topmenu -- taskmanager ---- - -The **Task Manager** displays a list of tasks performed by the TrueNAS system. It starts with the most recent task. - -Click the assignment to open the **Task Manager**. - -![TaskManager](/images/CORE/Dashboard/TaskManager.png "Task Manager") - -Click a task name to display its start time, finish time, and whether the task succeeded. -If a task fails, the error status shows. - -Tasks with log file output have a **View Logs** button to show the log files. - -Click **CLOSE** or anywhere outside the **Task Manager** dialog to close it, or press Esc. diff --git a/content/CORE/CORETutorials/_index.md b/content/CORE/CORETutorials/_index.md deleted file mode 100644 index 02f109cbf1..0000000000 --- a/content/CORE/CORETutorials/_index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: CORE Tutorials -redirect: "https://www.truenas.com/docs/core/13.0/coretutorials/" -description: "Standalone tutorials. Tutorials are organized parallel to the CORE interface layout." -geekdocCollapseSection: true -weight: 40 -cascade: - - _target: - book: "CORETutorials" -related: false ---- -Welcome to TrueNAS CORE tutorials! - -{{< include file="/static/includes/TutorialsIntro.md" >}} - -
- -## Table of Contents - -{{< children depth="1" description="true" >}} -
diff --git a/content/CORE/CoreSecurityReports/SMB1Advisory.md b/content/CORE/CoreSecurityReports/SMB1Advisory.md deleted file mode 100644 index caa20f32a5..0000000000 --- a/content/CORE/CoreSecurityReports/SMB1Advisory.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "SMB1 Security Advisory" -redirect: "https://www.truenas.com/docs/core/13.0/coresecurityreports/smb1advisory/" -description: "Contains advisory information on the deprecated SMB1 file-sharing protocol." -weight: 10 ---- - -**Do not use SMB1** - -SMB1, also known as SMBv1, is an early version of the Windows SMB file-sharing protocol. [Microsoft has deprecated the SMB1 protocol for security reasons and strongly recommends removing SMB1](https://support.microsoft.com/en-us/help/4034314/smbv1-is-not-installed-by-default-in-windows). SMB1 is disabled by default in FreeNAS and TrueNAS. Current SMB networking clients use later versions of the SMB protocol. - -Microsoft maintains a list of [older products that still require SMB1](https://blogs.technet.microsoft.com/filecab/2017/06/01/smb1-product-clearinghouse/). - -Windows Explorer (File Explorer) does not need SMB1, or a separate protocol called NetBIOS (sometimes called "NetBIOS over TCP/IP"), to discover and list SMB shares from a TrueNAS server. All modern versions of Windows use a newer protocol called WS-Discovery, which is more reliable and faster. TrueNAS automatically enables WS-Discovery to allow discovery of SMB shares by client devices. - -**Do not enable SMB1 on TrueNAS without understanding the security implications and taking measures to protect the network from those risks.** Contact the vendor of older products for upgrades to support newer, more secure versions of SMB, or replace older products with ones that do not require the security risks of SMB1. - -**Do not enable SMB1** unless it is absolutely required for essential equipment that cannot be upgraded or replaced, the security implications are understood, and steps have been taken to protect the network from those security risks. diff --git a/content/CORE/CoreSecurityReports/_index.md b/content/CORE/CoreSecurityReports/_index.md deleted file mode 100644 index c7dd252ef0..0000000000 --- a/content/CORE/CoreSecurityReports/_index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "CORE Security Reports" -redirect: "https://www.truenas.com/docs/core/13.0/coresecurityreports/" -description: "CORE-specific security notices and links to the TrueNAS Security Hub." -geekdocCollapseSection: true -weight: 175 -related: false ---- - -See the [TrueNAS Security Hub](https://security.truenas.com/) to get the latest responses to TrueNAS CORE-related security advisories. - -[Security Best Practices]({{< relref "Security.md" >}}) are available for both TrueNAS CORE and SCALE. ---- - -
- -## Special Security Notices - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/GettingStarted/Applications.md b/content/CORE/GettingStarted/Applications.md deleted file mode 100644 index 49b761b1c3..0000000000 --- a/content/CORE/GettingStarted/Applications.md +++ /dev/null @@ -1,139 +0,0 @@ ---- -title: "Applications" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/applications/" -description: "Describes how to install applications on TrueNAS CORE." -weight: 90 -tags: -- gettingstarted -- apps -- plugins ---- - -With the rest of the system configured and data being shared over a network, the final step to consider for first time setup is installing any of the application solutions. - -Applications or features added to TrueNAS are created in separate plugins, jails, or virtual machines that are kept separate from the base TrueNAS operating system. -If anything goes wrong or a security vulnerability is exploited in one of these application environments, TrueNAS remains unaffected. -These solutions safely expand TrueNAS capabilities in a restricted, safeguarded way. - -The primary method to install applications is to use *plugins*. -These are pre-packaged applications that quickly install in a tailor-made environment. -Some plugins are supported by iXsystems while others are provided and maintained by the open source community. - -A *jail* is a restricted FreeBSD operating system installed as a separate subset of TrueNAS. -Jails can install a wide variety of applications and be tuned to very specific use cases, but they require more extensive knowledge of FreeBSD and command line operation. - -A *virtual machine* is a fully independent operating system installation. -This reserves or splits the available hardware resources to create a different, full operating system experience. -TrueNAS can install Windows or Unix-like operating systems in a virtual machine (VM), but regular system performance is reduced while virtual machines are running. - -Click one of the tabs below to see instructions on installing your preferred application solution. - -{{< expand "Network Hardware Offloading" "v" >}} -Plugins that use a network interface need to Disable Hardware Offloading in **Network -> Interface**. -Disabling hardware offloading can reduce general network performance for that interface, so it is recommended to use a secondary interface for application environments. -{{< /expand >}} - -{{< tabs "Application Solutions" >}} -{{< tab "Plugins" >}} -This instruction demonstrates adding a plugin by walking you through installing the community-favorite [Plex](https://www.plex.tv/) application. -You need an account with Plex to complete these instructions. - -{{< include file="/static/includes/COREPlexPlugin.md" >}} - -{{< /tab >}} -{{< tab "FreeBSD Jails" >}} -## Installing a Jail -1. Go to the **Jails** page and click **ADD**. - - ![Jails](/images/CORE/Jails/Jails.png "Adding a new Jail") - -2. Enter a name for the jail in **Name**, select the **Release** version, then click **NEXT**. - - ![JailsAddName](/images/CORE/Jails/JailsAddName.png "Jail Creation: Name and Release") - -3. To allow the jail access to the internet, set **DHCP Autoconfigure IPv4** and click **NEXT**. - Additional defaults are set when you select the DHCP option. - - ![JailsAddNetworkingDHCP](/images/CORE/Jails/JailsAddNetworkingDHCP.png "Jail Creation: Default Internet Access") - -4. Review the **Jail Summary** and click **SUBMIT**. - - ![JailsAddConfirm](/images/CORE/Jails/JailsAddConfirm.png "Jail Creation: Confirm Settings") - -## Accessing a Jail -1. Go to **Jails** and click the **>** next to the newly created jail. - Click **START**. - - ![JailsStart](/images/CORE/Jails/JailsStart.png "Starting a Jail") - -2. When the jail **State** changes to **up**, click **SHELL** to see the jail command line. - - ![JailsShell](/images/CORE/Jails/JailShell.png "Jail Shell") - -{{< /tab >}} -{{< tab "Virtual Machines" >}} -## Installing a Virtual Machine -Virtual machines require uploading an operating system .iso to TrueNAS. -This example shows using an Ubuntu .iso: - -1. Go to **Virtual Machines** and click **ADD**. - - ![VirtualMachines](/images/CORE/VirtualMachines/VirtualMachines.png "Adding a new VM") - -2. Select a **Guest Operating System** and enter a name in **Name**. - For this example the guest operating system is set to **Linux**. - Click **NEXT**. - - ![VirtualMachinesAddOperatingSystemLinux](/images/CORE/VirtualMachines/VirtualMachinesAddOperatingSystemLinux.png "VM Creation: Operating System") - -3. Enter the physical resources to give the VM. - Larger numbers in **Virtual CPUs**, **Cores**, **Threads**, and **Memory** allow the VM to perform better, but reduce the performance of the TrueNAS system. - Click **NEXT**. - - ![VirtualMachinesAddCPU](/images/CORE/VirtualMachines/VirtualMachinesAddCPU.png "Allocating resources to the VM") - -4. Set **Create a new disk image** and select the VM storage from **Zvol Location**. - Enter a usable storage number in **Size** (example shows 50 GiB) and click **NEXT**. - - ![VirtualMachinesAddDisks](/images/CORE/VirtualMachines/VirtualMachinesAddDisks.png "Choosing a VM hard drive") - -5. **Network Interface** automatically detects the hardware and sets defaults that allow network access. - Make sure these settings are valid, then click **NEXT**. - - ![VirtualMachinesAddNetworkInterface](/images/CORE/VirtualMachines/VirtualMachinesAddNetworkInterface.png "VM Network Settings") - -6. Set **Upload an installer image file** to see additional options. - Select a location on the TrueNAS system in **ISO save location**. - Click **Choose File** and browse to the OS installation .iso. - Click **UPLOAD** and wait for the process to finish (this can take some time). - Click **NEXT**. - - ![VirtualMachinesAddInstallationMedia](/images/CORE/VirtualMachines/VirtualMachinesAddInstallationMedia.png "Uploading the ISO file") - -7. Confirm the VM configuration is correct and click **SUBMIT**. - - ![VirtualMachinesAddConfirm](/images/CORE/VirtualMachines/VirtualMachinesAddConfirm.png "Confirm the VM configuration") - -## Accessing a Virtual Machine -1. Go to **Virtual Machines** and click **>** next to the newly created VM. - Click **START**. - - ![VirtualMachinesStart](/images/CORE/VirtualMachines/VirtualMachinesStart.png "Starting a VM") - -2. When the VM **State** changes to **up**, click **VNC** to see the VM display. - - ![VirtualMachinesOptions](/images/CORE/VirtualMachines/VirtualMachinesOptions.png "Launch VNC") - - Because this example uses an Ubuntu .iso, the Ubuntu installation screen shows. - - ![UbuntuInstall](/images/CORE/VirtualMachines/UbuntuInstall.png "Ubuntu Virtual Machine: Install") - - From here, install the OS as normal. - -3. After the OS install completes, go back to **Virtual Machines**, toggle the **State**, and click **DEVICES**. - - ![VirtualMachinesDevices](/images/CORE/VirtualMachines/VirtualMachinesDevices.png "VM Devices") - - Find the **CDROM** entry and click > **Delete** to remove the installation .iso from the VM and allow it to boot into the full OS the next time the VM activates. -{{< /tab >}} -{{< /tabs >}} diff --git a/content/CORE/GettingStarted/COREGettingStartedPrint.md b/content/CORE/GettingStarted/COREGettingStartedPrint.md deleted file mode 100644 index 8b86fecb93..0000000000 --- a/content/CORE/GettingStarted/COREGettingStartedPrint.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "⎙ Download or Print" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/printview/" -description: "View the CORE Getting Started Guide as a single page suitable for download or print." -weight: 1 -no_print: "true" -related: false ---- - - \ No newline at end of file diff --git a/content/CORE/GettingStarted/COREHardwareGuide.md b/content/CORE/GettingStarted/COREHardwareGuide.md deleted file mode 100644 index d6143cd661..0000000000 --- a/content/CORE/GettingStarted/COREHardwareGuide.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "CORE Hardware Guide" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/corehardwareguide/" -description: "Describes the hardware specifications and system component recommendations for custom TrueNAS CORE deployment." -weight: 20 -aliases: - - /core/introduction/corehardwareguide/ -tags: -- gettingstarted ---- - -{{< include file="/static/includes/TNHardwareGuide.md" >}} diff --git a/content/CORE/GettingStarted/COREReleaseNotes.md b/content/CORE/GettingStarted/COREReleaseNotes.md deleted file mode 100644 index b0f2d29ad2..0000000000 --- a/content/CORE/GettingStarted/COREReleaseNotes.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Nightly Version Notes -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/corereleasenotes/" -description: "Highlights and development notes for the latest TrueNAS CORE nightly builds." -weight: 3 -aliases: - - /releasenotes/core/13.0beta1/ - - /releasenotes/core/13.0rc1/ - - /releasenotes/core/ - - /core/corereleasenotes/ -related: false ---- - -{{< hint type="tip" >}} -This page is being rebuilt with notes from the latest TrueNAS CORE **nightly** development versions. - -**Not what you were looking for?** Release notes for other CORE versions are also available: - -* [TrueNAS CORE **13.0**](https://www.truenas.com/docs/core/13.0/gettingstarted/corereleasenotes/) -* [TrueNAS CORE **13.3**](https://www.truenas.com/docs/core/13.3/gettingstarted/corereleasenotes/) -{{< /hint >}} - -## Obtaining a Release - -{{< include file="/static/includes/NightlyTestWarning.md" >}} - -To download a .tar file for installing or upgrading to a CORE nightly version, go to https://www.truenas.com/download-truenas-core/ and click **Download Future Previews**. -Select the latest .tar file and click **Download**. -Click **APPLY UPDATE**. - -More details are available from [Updating Core]({{< relref "/CORE/CORETutorials/UpdatingTrueNAS/_index.md" >}}). diff --git a/content/CORE/GettingStarted/ConsoleSetupMenu.md b/content/CORE/GettingStarted/ConsoleSetupMenu.md deleted file mode 100644 index e9aa923c7b..0000000000 --- a/content/CORE/GettingStarted/ConsoleSetupMenu.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "Console Setup Menu" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/consolesetupmenu/" -description: "Describes the Console Setup menu of TrueNAS CORE." -weight: 40 -tags: -- console -- gettingstarted ---- - -The Console Setup menu displays at the end of the boot process. -If the TrueNAS system has a keyboard and monitor, this menu can be used to administer the system. - -When connecting with SSH, the Console Setup menu is not shown by default. -It can be started by the `root` user or another user with root permissions by entering `/etc/netcli`. - -To disable the Console Setup menu, go to **System > Advanced** and select **Show Text Console without Password Prompt** to clear the checkbox. - -![ConsoleSetupMenu](/images/CORE/ConsoleSetupMenu.png "TrueNAS Console Setup Menu") - -On HA systems, some of these menu options are not available unless HA has been administratively disabled. - -The menu provides these options: - -1) **Configure Network Interfaces** provides a configuration wizard to set up the system’s network interfaces. If the system has been licensed for High Availability (HA), the wizard prompts for IP addresses for both “This Controller” and “TrueNAS Controller 2”. - -2) **Configure Link Aggregation** is for creating or deleting link aggregations. - -3) **Configure VLAN Interface** is used to create or delete VLAN interfaces. - -4) **Configure Default Route** is used to set the IPv4 or IPv6 default gateway. When prompted, enter the IP address of the default gateway. - -5) **Configure Static Routes** prompts for the destination network and gateway IP address. Re-enter this option for each static route needed. - -6) **Configure DNS** prompts for the name of the DNS domain and the IP address of the first DNS server. When adding multiple DNS servers, press Enter to enter the next one. Press Enter twice to leave this option. - -7) **Reset Root Password** is used to reset a lost or forgotten root password. Select this option and follow the prompts to set the password. - -8) **Reset Configuration to Defaults** *Caution!* This option deletes all of the configuration settings made in the administrative GUI and is used to reset TrueNAS® back to defaults. Before selecting this option, make a full backup of all data and make sure all encryption keys and passphrases are known! After this option is selected, the configuration is reset to defaults and the system reboots. Storage ➞ Pools ➞ Import Pool can be used to re-import pools. - -9) **Reboot** restarts the system. - -10) **Shut Down** shuts down the system. - -The numbering and quantity of options on this menu can change due to software updates, service agreements, or other factors. -Please carefully check the menu before selecting an option, and keep this in mind when writing local procedures. - -During boot, TrueNAS automatically attempts to connect to a DHCP server from all live interfaces. -If it successfully receives an IP address, the address is displayed so it can be used to access the graphical user interface. -In the example shown above, TrueNAS is accessible at `10.0.0.102`. - -Some TrueNAS systems are set up without a monitor, making it challenging to determine which IP address has been assigned. -On networks that support Multicast DNS (mDNS), the hostname and domain can be entered into the address bar of a browser. -By default, this value is `truenas.local`. - -If TrueNAS is not connected to a network with a DHCP server, use the console network configuration menu to manually configure the interface as shown here. -In this example, the TrueNAS system has one network interface, `em0`. - -``` -Enter an option from 1-12: 1 -1) em0 -Select an interface (q to quit): 1 -Remove the current settings of this interface? (This causes a momentary disconnec -tion of the network.) (y/n) n -Configure interface for DHCP? (y/n) n -Configure IPv4? (y/n) y -Interface name: (press enter, the name can be blank) -Several input formats are supported -Example 1 CIDR Notation: - 192.168.1.1/24 -Example 2 IP and Netmask separate: - IP: 192.168.1.1 - Netmask: 255.255.255.0, or /24 or 24 -IPv4 Address: 192.168.1.108/24 -Saving interface configuration: Ok -Configure IPv6? (y/n) n -Restarting network: ok - -... - -The web user interface is at -http://192.168.1.108 -``` diff --git a/content/CORE/GettingStarted/DataBackups.md b/content/CORE/GettingStarted/DataBackups.md deleted file mode 100644 index 11d85ca0f3..0000000000 --- a/content/CORE/GettingStarted/DataBackups.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: "Data Backups" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/databackups/" -description: "Describes how to configure data backups on TrueNAS CORE." -geekdocCollapseSection: true -weight: 80 -tags: -- gettingstarted -- databackup ---- - -With storage created and shared, it's time to ensure TrueNAS data is effectively backed up. -TrueNAS offers several options for backing up data. - -{{< tabs "Data Management Options" >}} -{{< tab "Cloud Sync" >}} -{{< hint type=note >}} -This option requires an account with the Cloud Storage provider and a storage location created with the provider, like an Amazon S3 bucket. -Major providers like Amazon S3, Google Cloud, Box and Microsoft Azure are supported, along with a variety of other vendors. -These can charge fees for data transfers and storage, so please review your cloud storage provider policies before transferring any data. -{{< /hint >}} - -You can configure TrueNAS to send, receive, or synchronize data with a cloud storage provider. -Configuring a cloud sync task allows you to transfer data a single time or set up a recurring schedule to periodically transfer data. - -### Add the Credential - -Go to **System > Cloud Credentials > ADD**. -Enter a name in **Name** and choose a provider from the **Provider** dropdown list. -The authentication options change depending on the selected provider. -Credentials either must be entered manually or a single provider login is required and the credentials add automatically. - -![CloudSyncLogin](/images/CORE/System/StoringDataCloudSyncAuth.png "Cloud Sync Authorization") - -After entering the provider credentials, click **VERIFY CREDENTIAL**. -When verification is confirmed, click **SUBMIT**. - -### Add the Data Transfer Task - -Go to **Tasks > Cloud Sync Tasks** and click **ADD**. - -![TasksCloudSyncAdd](/images/CORE/Tasks/TasksCloudSyncAdd.png "Creating a Cloud Sync Task") - -Select the previously saved provider in **Credential** to populate the **Remote** section. - -Add a value in **Description** for the task, select **PUSH** or **PULL** as the **Direction** and **COPY** as the **Transfer Mode**. -Under **Directory/Files**, choose the **tank** dataset previously created. - -Now, use the **Control** options to define how often this task runs. -Open the **Schedule** dropdown and choose a preset time when running the task is least intrusive to your network. -If the task only needs to run once, clear the **Enabled** checkbox. -You can trigger the task a single time from the **Tasks > Cloud Sync Tasks** list to do the initial migration or backup. - -To test your task, click **DRY RUN**. -When the test run is successful, click **SUBMIT** to save the task and add it to **Tasks > Cloud Sync Tasks**. - -To manually run the task, go to **Tasks > Cloud Sync Tasks**, click **>** to expand the new task, and click **RUN NOW**. - -![TasksCloudSyncOptions](/images/CORE/Tasks/TasksCloudSyncOptions.png "Cloud Sync Task Options") - -The **Status** shows success or failure. -Click the status entry to see a detailed log of the action. -{{< /tab >}} -{{< tab "Replication" >}} -Replication is the process of taking a moment in time snapshot of the data and copying that snapshot to another location. -Snapshots typically use less storage than full file backups and have more management options. -This instruction shows using the TrueNAS wizard to create a simple replication. - -Go to **Tasks > Replication Tasks** and click **ADD**. -Set the source location to the local system and pick which datasets to snapshot. -The wizard takes new snapshots of the sources when no existing source snapshots are found. - -![RepTaskSource](/images/CORE/Tasks/StoringDataRepTaskSource.png "Rep Task Source") - -Set the destination to the local system and define the path to the storage location for replicated snapshots. -When manually defining the destination, be sure to type the full path to the destination location. - -![RepTaskDestination](/images/CORE/Tasks/StoringDataRepTaskDestination.png "Rep Task Destination") - -You can define a specific schedule for this replication or choose to run it immediately after saving the new task. -Unscheduled tasks are saved in the replication task list and can be run manually or edited later to add a schedule. - -![RepTaskSchedule](/images/CORE/Tasks/StoringDataRepTaskSchedule.png "Rep Task Schedule") - -Clicking **START REPLICATION** saves the new task and immediately attempts to replicate snapshots to the destination. - -![RepTaskCompletion](/images/CORE/Tasks/StoringDataRepTaskCompletion.png "Rep Task Completion") - -To confirm that snapshots are replicated, go to **Storage > Snapshots** and verify the destination dataset has new snapshots with correct timestamps. - -![RepTaskVerification](/images/CORE/Tasks/StoringDataRepTaskVerified.png "Rep Task Verification") -{{< /tab >}} -{{< /tabs >}} - -TrueNAS is now accessible and configured to store, share, and back up your data! - -If you need to expand the system capabilities, see the remaining article about additional [Applications]({{< relref "Applications.md" >}}). -When you are ready to fine-tune the system configuration or learn more about the advanced features, see the remaining sections in the TrueNAS CORE and Enterprise section. -These sections are organized in order of appearance in the TrueNAS interface, with additional topics for [3rd party solutions]({{< relref "/Solutions/_index.md" >}}), [API reference guide]({{< relref "/CORE/API/_index.md" >}}), and [community recommendations]({{< ref "/CORE/CORETutorials/CommunityGuides/_index.md" >}}). diff --git a/content/CORE/GettingStarted/Deprecations.md b/content/CORE/GettingStarted/Deprecations.md deleted file mode 100644 index ad10de9b34..0000000000 --- a/content/CORE/GettingStarted/Deprecations.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "Feature Deprecations" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/deprecations/" -description: "Notes about CORE features that are deprecated and either receive no further updates or are scheduled for removal from TrueNAS." -weight: 4 -related: false ---- - -As part of security hardening and improving feature maintainability, there are occasions when TrueNAS features must be deprecated. -Features noted in this article are either no longer receiving any maintenance or, typically due to security vulnerabilities, might be scheduled for removal from TrueNAS in a future major version. - -Begin planning migrations from these features immediately and note the TrueNAS upgrade paths required when a deprecated feature is in use. - -## S3 Service - -{{< include file="/static/includes/S3Deprecation.md" >}} - -## SAS Multipath - -SAS Multipath is supported *as-is* and receives no further maintenance updates. -While multipath situations might be detected and be generally functional in TrueNAS CORE, there is a possibility this is not available in a future TrueNAS CORE major version. -Users should avoid creating and managing SAS multipath scenarios with TrueNAS. - -## Virtualization - -The Plugins, Jails, and Virtual Machines features are untested and provided without support to the TrueNAS Community. -Users with a critical need to use containers or virtualization solutions in production should migrate to the tested and supported virtualization features available in [TrueNAS SCALE](https://www.truenas.com/download-truenas-scale/). -[TrueNAS Enterprise customers](https://www.truenas.com/truenas-enterprise/) can contact iXsystems to schedule a TrueNAS SCALE deployment. -See [CORE to SCALE Migrations](https://www.truenas.com/docs/scale/gettingstarted/migrate/) for more information. - -## Web Shell - -The web UI **Shell** is removed in CORE 13.3. -Users can continue to access the shell using [SSH]({{< relref "ConfiguringSSH.md" >}}) or a physical system connection with serial cable or other direct method. diff --git a/content/CORE/GettingStarted/Install.md b/content/CORE/GettingStarted/Install.md deleted file mode 100644 index 7e4fef89cc..0000000000 --- a/content/CORE/GettingStarted/Install.md +++ /dev/null @@ -1,305 +0,0 @@ ---- -title: "Install" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/install/" -description: "Provides installation instructions for TrueNAS CORE." -weight: 30 -tags: -- gettingstarted -- install ---- - -Now that the .iso file is [downloaded](https://www.truenas.com/download-truenas-core/), you can start installing TrueNAS! - -{{< expand "Major Upgrades" "v" >}} -The install process can be repeated with newer installation files when the system already has TrueNAS installed. -This is used for [major version upgrades]({{< relref "/CORE/CORETutorials/UpdatingTrueNAS/_index.md#upgrade-via-iso" >}}) -{{< /expand >}} - -{{< expand "ISO Verification" "v" >}} -The iXsystems Security Team cryptographically signs TrueNAS ISO files so that users can verify the integrity of their downloaded file. -This section demonstrates how to verify an ISO file using the [Pretty Good Privacy (PGP)](https://tools.ietf.org/html/rfc4880) and [SHA256](https://tools.ietf.org/html/rfc6234) methods. - -### PGP ISO Verification - -You need an OpenPGP encryption application for this method of ISO verification. -There are many different free applications available, but the OpenPGP group provides a list of available software for different operating systems at https://www.openpgp.org/software/. -The examples in this section show verifying the TrueNAS .iso using [gnupg2](https://gnupg.org/software/index.html) in a command prompt, but [Gpg4win](https://www.gpg4win.org/) is also a good option for Windows users. - -To verify the .iso source, go to https://www.truenas.com/download-tn-core/ , expand the **Security** option, and click **PGP Signature** to download the Gnu Privacy Guard (.gpg) signature file. You can download the PGP Public Key from either [pgp.mit.edu](https://pgp.mit.edu/) (search for `security-officer@ixsystems.com`) or [keys.openpgp.org](https://keys.openpgp.org/search?q=security-officer%40ixsystems.com). - -Open the [PGP Public key link](https://keyserver.ubuntu.com/pks/lookup?search=0xC8D62DEF767C1DB0DFF4E6EC358EAA9112CF7946&fingerprint=on&op=index) and note the address in your browser and **Search results for** string. - -Use one of the OpenPGP encryption tools mentioned above to import the public key and verify the PGP signature. - -Go to the .iso and .iso.gpg download location and import the public key using the keyserver address and search results string: - -``` -q5sys@athena /tmp> gpg --keyserver keys.openpgp.org --recv-keys 0xc8d62def767c1db0dff4e6ec358eaa9112cf7946 -gpg: requesting key 12CF7946 from hkp server keys.openpgp.org -gpg: key 358EAA9112CF7946: "IX SecTeam " not changed -gpg: Total number processed: 1 -gpg: unchanged: 1 -q5sys@athena /tmp> -``` - -Use command `gpg --verify` to compare the .iso and .iso.gpg files: - -``` -q5sys@athena /tmp> gpg --verify TrueNAS-12.0-BETA2.1.iso.gpg TrueNAS-12.0-BETA2.iso -gpg: Signature made Thu Aug 27 10:06:02 2020 EDT using RSA key ID 12CF7946 -gpg: Good signature from "IX SecTeam " -gpg: WARNING: This key is not certified with a trusted signature! -gpg: There is no indication that the signature belongs to the owner. -Primary key fingerprint: C8D6 2DEF 767C 1DB0 DFF4 E6EC 358E AA91 12CF 7946 -q5sys@athena /tmp> -``` - -This response means the signature is correct but still untrusted. Go back to the browser page that has the **PGP Public key** open and manually confirm that the key was issued for `IX SecTeam ` (iX Security Team) on October 15, 2019 and is signed by an iXsystems account. - -### SHA256 Verification - -The command to verify the checksum varies by operating system: - -* BSD: `sha256 isofile` -* Linux: `sha256sum isofile` -* Mac: `shasum -a 256 isofile` - -Freeware or online checksum utilities are available for Windows users. - -The value produced by running the command must match the value shown in the sha256.txt file. -Different checksum values indicate a corrupted installer file that you should not use. -{{< /expand >}} - -Choose the install type to see specific instructions: - -## Install Types -{{< expand "Physical Hardware" >}} - -TrueNAS is very flexible and can run on most x86 computers. -However, there are many different hardware considerations when building a NAS! -If you're still researching what kind of hardware to use with TrueNAS, read over the very detailed [CORE Hardware Guide]({{< relref "/CORE/GettingStarted/COREHardwareGuide.md" >}}). - -## Prepare the Install File - -Physical hardware typically requires burning the TrueNAS installer to a physical device. In general a CD or removable USB device is used. This device is temporarily attached to the system to install TrueNAS to the system's permanent boot device. - -Headless, or remote, installation is possible when the system has IPMI available and can create a virtual media CD-ROM using a locally stored .iso. - -The method of writing the installer to a device varies between operating systems. -Click **Windows** or **Linux** to see instructions for your Operating System, or **CD** for generic CD burning guidance. - -### CD -To use the installer with a CD, download your favorite CD burning utility and burn the .iso file to the CD. -Insert the CD into the TrueNAS system and boot from the CD. - -### Windows -To write the TrueNAS installer to a USB stick on Windows, plug the USB stick into the system and use a program like [Rufus](https://rufus.ie/) to write the .iso file to the memory stick. -When Rufus prompts for which write method to use, make sure *dd mode* is selected. - -The USB stick is not recognized by Windows after the TrueNAS installer writes to it. -To reclaim the USB stick after installing TrueNAS, use Rufus to write a "Non bootable" image, then remove and reinsert the USB stick. - -### Linux -To write the TrueNAS installer to a USB stick on Linux, plug the USB stick into the system and open a terminal. - -Start by making sure the USB stick connection path is correct. - -### Headless Install -Systems with IPMI connectivity, like the TrueNAS Mini, can use the Virtual Media feature with an .iso to create a virtual boot device for installation. -Mounting the .iso in a virtual CD-ROM, allows installing or updating headless servers remotely through the console. - -Here is an example of setting up a virtual CD-ROM with a SUPERMICRO IPMI: - -1. From the **Virtual Media** menu, select **CD-ROM Image**. -2. Fill in the details: - 1. **Shared Host**: The IP address of the system storing the .iso. - 2. **Path to Image**: The path to the image file. For example, *install/iso/SCALEAngelfish.iso* -3. Click **Mount**. -4. Click **Refresh Status** and confirm a disk is being emulated. -5. Click **Save**. - -{{< /expand >}} - -## Install Process - -With the installer added to a device, you can now install TrueNAS onto the desired system. -Insert the install media, or load the iso using IPMI, 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. - -Choose to boot in UEFI mode or legacy CSM/BIOS mode. -When installing TrueNAS, make the matching choice for the installation. -For Intel chipsets manufactured in 2020 or later, UEFI is likely the only option. - -If your system supports SecureBoot, you need to either disable it or set it to **Other OS** to be able to boot the install media. - -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. - -After the system has booted into the installer, follow these steps. - -Select Install/Upgrade. - -![InstallUpgrade](/images/CORE/Install/InstallMainScreen.png "Install Main Screen") - -Select the desired install drive. - -![InstallDrive](/images/CORE/Install/InstallDriveScreen.png "Install Drive Screen") - -Select Yes - -![InstallWarning](/images/CORE/Install/InstallWarningScreen.png "Install Warning Screen") - -Select Fresh Install to do a clean install of the downloaded version of TrueNAS. -This erases the contents of the selected drive.! - -![InstallFresh](/images/CORE/Install/InstallWarningScreen.png "Upgrade or Fresh Install Screen") - -When the operating system device has enough additional space, you can choose to allocate some space for a swap partition to improve performance. - -![InstallPartition](/images/CORE/Install/InstallPartitionScreen.png "Install Partition Screen") - -Next, set a password for the TrueNAS administrative account, named `root` by 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/Install/InstallPasswordScreen.png "Install Password Screen") - -After following the steps to install, reboot the system and remove the install media. - -{{< expand "Troubleshooting" "v">}} -If the system does not boot into TrueNAS, there are several things you can check to resolve the situation: - -* Check the system BIOS and see if there is an option to change the USB emulation from CD/DVD/floppy to hard drive. If it still does not boot, check to see if the card/drive is UDMA compliant. -* If the system BIOS does not support EFI with BIOS emulation, see if it has an option to boot using legacy BIOS mode. -* If the system starts to boot but hangs with this repeated error message: **run_interrupt_driven_hooks: still waiting after 60 seconds for xpt_config**, go into the system BIOS and look for an onboard device configuration for a `1394 Controller`. If present, disable that device and try booting again. -* If the burned image fails to boot and the image was burned using a Windows system, wipe the USB stick before trying a second burn using a utility such as [Active@ KillDisk](https://www.killdisk.com/eraser.html). Otherwise, the second burn attempt fails as Windows does not understand the partition written from the image file. Be very careful to specify the correct USB stick when using a wipe utility! -{{< /expand >}} - -{{< expand "Virtual Machine" >}} -Because TrueNAS is built and provided as an .iso file, it works on all virtual machine solutions (VMware, VirtualBox, Citrix Hypervisor, etc). -This section demonstrates installing with [VMware Workstation Player](https://www.vmware.com/products/workstation-player/workstation-player-evaluation.html) on Windows. - -## Minimum Virtual Machine Settings - -Regardless of virtualization application, use these minimum settings: -* RAM: at least 8192MB (8GB) -* DISKS: one virtual disk with at least 8GB for the operating system -and boot environments and at least one additional virtual disk with -at least 4GB to be used as data storage. -* NETWORK: Use NAT, Bridged, or Host-only depending on your host network configuration. - -{{< hint type="tip" title="FreeBSD UEFI Bug with ESXi" >}} -**VMWare products and EFI boot mode:** -A third party bug currently affects EFI (UEFI) booting on VMWare products. -Install TrueNAS in BIOS mode until this is resolved. -See VMware article [Host Fails to Boot After You Install ESXi in UEFI Mode](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.esxi.install.doc/GUID-D1BD27AB-C432-454D-9B2B-DC04E7BA9979.html). -{{< /hint >}} - -### Networking checks for VMware -When installing TrueNAS in a VMware VM, double check the virtual switch and VMware port group. -A misconfigured virtual switch or VMware port group can cause network connection errors for plugins or jails inside the TrueNAS VM. -Enable **MAC spoofing** and **promiscuous mode** on the switch first, and then the port group the VM uses. - -{{< include file="/static/includes/VirtualMachinesJailNetworking.md" >}} - -## Generic VM Creation Process - -For most hypervisors, the procedure for creating a TrueNAS VM is the same: - -1. Create a new Virtual Machine as usual, taking note of the following settings. - * The virtual hardware has a bootable CD/DVD device pointed to the TrueNAS installer image (this is usually an .iso). - * The virtual network card is configured so your network can reach it. - **bridged** mode is optimal as this treats the network card as if it is plugged into a simple switch on the existing network. - * Some products require identifying the OS installed on the VM. The ideal option is **FreeBSD 12 64 bit**. - If this is not available, try options like **FreeBSD 12**, **FreeBSD 64 bit**, **64 bit OS**, or **Other**. - Do not choose a Windows or Linux related OS type. - * For VMWare hypervisors, install in BIOS mode. - * The VM has sufficient memory and disk space. TrueNAS needs at least 8 GB RAM and 20 GB disk space. - Not all hypervisors allocate enough memory by default. -2. Boot the VM and install TrueNAS as usual. -3. After installation completes, shut down the VM instead of rebooting, and disconnect the CD/DVD from the VM before rebooting the VM. -4. After rebooting into TrueNAS, install VM tools if applicable for your VM, and if they exist for FreeBSD 12, or ensure they are loaded on boot. - -## Example installation for VMWare Player 15.5 - -Open VMware Player and click **Create a New Virtual Machine** to enter the New Virtual Machine Wizard. - -### 1. Installer disk image file - -Select the **Installer disk image file (iso)** option, click **Browse**, and upload the TrueNAS Core .iso downloaded earlier. - -### 2. Name the Virtual Machine - -In this step, you can change the virtual machine name and location. - -### 3. Specify Disk Capacity - -Specify the maximum disk size for the initial disk. -The default **20GB** is enough for TrueNAS. -Next, select **Store virtual disk as a single file**. - -### 4. Review Virtual Machine - -Review the virtual machine configuration before proceeding. -By default, VMware Player doesn't set enough RAM for the virtual machine. -Click ***Customize Hardware > Memory**. -Drag the slider up to 8GB and click **Ok**. -If you wish to power on the machine after creation, select **Power on this virtual machine after creation**. - -## Add Virtual Disks for Storage - -After creating the virtual machine, select it from the virtual machine list and click **Edit virtual machine settings**. -Click **Add** and select **Hard Disk**. Select **SCSI** as the virtual disk type. -Select **Create a new virtual disk**. -Specify the maximum size of this additional virtual disk. -This disk stores data in TrueNAS. -If desired, allocate the disk space immediately by setting *Allocate all disk space now*. -Select ***Store virtual disk as single file**. -Finally, name and chose a location for the new virtual disk. - -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 "/CORE/CORETutorials/Storage/Pools/_index.md" >}}) for descriptions of the various pool (vdev) types and layouts - -## TrueNAS Installer - -Select the virtual machine from the list and click **Play virtual machine**. -The machine starts and boots into the TrueNAS installer. -Select **Install/Upgrade**. - -![InstallVMMain](/images/CORE/Install/InstallVMMainScreen.png "Install VM Main Screen") - -Select the desired disk for the boot environments. - -![InstallVMMedia](/images/CORE/Install/InstallVMMediaScreen.png "Install VM Media Screen") - -Select **Yes**. This erases all contents on the disk! - -![InstallVMWarning](/images/CORE/Install/InstallVMWarningScreen.png "Install VM Warning Screen") - -Next, set a password for the TrueNAS administrative account, named `root` by 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. - -![InstallVMPassword](/images/CORE/Install/InstallVMPasswordScreen.png "Install VM Password Screen") - -Select **Boot via BIOS**. - -![InstallVMBootMode](/images/CORE/Install/InstallVMBootMode.png "Install VM Boot Mode Screen") - -After the TrueNAS installation is complete, reboot the system. -The [Console Setup Menu]({{< relref "/CORE/GettingStarted/ConsoleSetupMenu.md" >}}) displays when the system boots successfully. - -{{< hint type="tip" title="VMWare post-install" >}} -After installing TrueNAS in a VMware VM, it is recommended to configure and use the [vmx(4)](https://www.freebsd.org/cgi/man.cgi?query=vmx) drivers on TrueNAS. -To load the VMX driver when TrueNAS boots, log in to the web interface and go to **System > Tunables**. -Click *Add* and create a new tunable. - -![SystemTunablesVmxload](/images/CORE/System/SystemTunablesVmxload.png "VMware Tunable in TrueNAS") -{{< /hint >}} -{{< /expand >}} - -Congratulations, TrueNAS is now installed! - -The next step is to [log in to the web interface]({{< relref "/CORE/GettingStarted/LoggingIn.md" >}}) using the administrative account credentials and begin configuring the system. diff --git a/content/CORE/GettingStarted/LoggingIn.md b/content/CORE/GettingStarted/LoggingIn.md deleted file mode 100644 index 6bb416a20f..0000000000 --- a/content/CORE/GettingStarted/LoggingIn.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: "Logging In" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/loggingin/" -description: "Describes how the logging in process works on TrueNAS CORE." -weight: 50 -tags: -- gettingstarted ---- - -Now that TrueNAS is installed, it's time to log in to the web interface and begin managing data! - -{{< expand "Can I configure TrueNAS using a CLI?" "v" >}} -After installing TrueNAS, configuring and using the system is all managed through the web interface. -It is important to only use the web interface to make configuration changes to the system. -By default, using the command-line interface (CLI) to modify the system **does not modify the settings database**. -Any changes made in the command line are lost and reverted to the original database settings whenever the system restarts. -TrueNAS automatically creates a number of ways to access the web interface, but you might need to adjust the default settings to better fit the system in your network environment. -{{< /expand >}} - -## Web Interface Access - -By default, TrueNAS provides a default address for logging in to the web interface. -To view the web interface IP address or reconfigure web interface access, you will need to connect a monitor and keyboard to your TrueNAS system or connect with IPMI for out-of-band system management. - -{{< tabs "Web Interface Access Options" >}} -{{< tab "CORE Defaults" >}} -When powering on a TrueNAS system, the system attempts to connect to a DHCP server from all live interfaces and provide access to the web interface. -On networks that support Multicast Domain Name Services (mDNS), a hostname and domain can be used to access the TrueNAS web interface. -By default, TrueNAS is configured to use the hostname and domain *truenas.local* -You can change this after logging in to the web interface by going to **Network > Global Configuration** and setting a new *Hostname* and *Domain*. - -If an IP address is needed, connect a monitor to the TrueNAS system and view the console setup menu that displays at the end of the boot process. - -![ConsoleSetupMenu](/images/CORE/ConsoleSetupMenu.png "TrueNAS Console Menu") - -When able to automatically configure a connection, the system shows the web interface IP address at the bottom of the console setup menu. -If needed, you can reset the root password in the TrueNAS console setup menu or by clicking **Settings > Change Password** in the web interface. -To require logging in to the system before showing the system console menu, go to **System > Advanced** and unset *Show Text Console without Password Prompt*. -{{< /tab >}} -{{< tab "Enterprise Defaults" >}} -[TrueNAS Enterprise hardware]({{< relref "/Hardware/_index.md" >}}) from iXsystems is preconfigured with your provided networking details. -The IP address of the TrueNAS web interface is provided on the system sales order or configuration sheet. -Please contact iX Support if the TrueNAS web interface IP address has not been provided with these documents or cannot be identified from the TrueNAS system console. - -{{< include file="/static/includes/iXsystemsSupportContact.md" >}} -{{< /tab >}} -{{< tab "Configuring Web Interface Access" >}} -If the TrueNAS system is not connected to a network with a DHCP server, you can use the console network configuration menu to manually *Configure Network Interfaces*. - -![ConsoleMenu](/images/CORE/ConsoleSetupMenu.png "TrueNAS Console Menu") - -This example shows configuring a single interface, *em0*: - -``` -Enter an option from 1-12: 1 -1) em0 -Select an interface (q to quit): 1 -Remove the current settings of this interface? (This causes a momentary disconnec -tion of the network.) (y/n) n -Configure interface for DHCP? (y/n) n -Configure IPv4? (y/n) y -Interface name: (press enter, the name can be blank) -Several input formats are supported -Example 1 CIDR Notation: - 192.168.1.1/24 -Example 2 IP and Netmask separate: - IP: 192.168.1.1 - Netmask: 255.255.255.0, or /24 or 24 -IPv4 Address: 192.168.1.108/24 -Saving interface configuration: Ok -Configure IPv6? (y/n) n -Restarting network: ok - -... - -The web user interface is at -http://192.168.1.108 -``` - -Depending on the network environment, review the *Configure Default Route* option to define your IPv4 or IPv6 default gateway. -*Configure Static Routes* allows adding destination network and gateway IP addresses, one for each route. -To change the DNS domain and add nameservers, select *Configure DNS*. - -These settings can be adjusted later in the various **Network** options available in the web interface. -{{< /tab >}} -{{< /tabs >}} - -## Logging In - -On a computer that can access the same network as the TrueNAS system, enter the hostname and domain or IP address in a web browser to connect to the web interface. - -{{< hint type=note >}} -The quality of your user experience can be impacted by the browser that you use. We generally recommend using Firefox, Edge, or Chrome. -{{< /hint >}} - -![LoginCORE](/images/CORE/LoginCORE.png "TrueNAS CORE Login Screen") - -Enter the administrative account credentials to log in. -By default, the administrative account username is `root` and the password is set when installing TrueNAS. - -{{< expand "Troubleshooting" "v" >}} -If the user interface is not accessible by IP address from a browser, check these things: - -* Are proxy settings enabled in the browser configuration? - If so, disable the settings and try connecting again. -* If the page does not load, make sure that a `ping` reaches the TrueNAS system IP address. - If the address is in a private IP address range, it is only accessible from within that private network. - -If the web interface is shown but seems unresponsive or incomplete: - -* Make sure the browser allows cookies, Javascript, and custom fonts from the TrueNAS system. -* Try a different browser. Firefox is recommended. - -If the UI becomes unresponsive after an upgrade or other system operation, clear the site data and refresh the browser (Shift+F5). -{{< /expand >}} - -After logging in, the TrueNAS web interface present options across the top and left side of the screen. - -### Top Menu - -The horizontal menu at the top of the web interface contains status indicators, system alerts, UI theme options, and system power options. - -{{< expand "Top Menu Details" >}} - -{{< include file="/static/includes/CORETopMenu.md" >}} - -{{< /expand >}} - -### Side Menu - -The column on the left side of the screen contains some information about the system and links to the various TrueNAS configuration screens. -The box at the top of the columns shows the current logged in user account and the system host name. - -Configuration screens are organized by feature. -For example, to find options related to storing data, click the **Storage** option and to make data stored in TrueNAS available to client systems, go to the **Sharing** section. - -## Dashboard - -The system **Dashboard** is the default screen when logging in to TrueNAS. -Basic information about the installed version, systems component usage and network traffic are all presented on this screen. -For users with compatible TrueNAS Hardware, clicking the system image goes to the **System > View Enclosure** page. - -![DashboardCORE](/images/CORE/Dashboard/DashboardCORE.png "TrueNAS CORE Dashboard") - -The **Dashboard** provides access to all TrueNAS management options. - -Now that you can access the TrueNAS web interface and see all the management options, it is time to begin [storing data]({{< relref "StoringData.md" >}})! diff --git a/content/CORE/GettingStarted/SharingStorage.md b/content/CORE/GettingStarted/SharingStorage.md deleted file mode 100644 index aede361769..0000000000 --- a/content/CORE/GettingStarted/SharingStorage.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: "Sharing Storage" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/sharingstorage/" -description: "Describes sharing configurations on TrueNAS CORE." -geekdocCollapseSection: true -weight: 70 -tags: -- gettingstarted -- storage ---- - -With TrueNAS **Storage** configured and backed up, it's time to begin sharing data. -There are several available sharing solutions, but we'll look at the most common in this article. -Choose a tab to get started with simple sharing examples: - -## Sharing Data - -{{< tabs "Methods" >}} -{{< tab "Windows (SMB)" >}} -### Requirements - -* Dataset with *Share Type* set to *SMB*. -* TrueNAS user accounts with *Samba Authentication* set. - -### Set Permissions - -Go to **Storage > Pools** and find the dataset to share. -Click and *Edit Permissions*. - -![StoragePoolsEditACL](/images/CORE/Storage/StoragePoolsEditACL.png "Editing SMB dataset permissions") - -Click *SELECT AN ACL PRESET*, open the drop down, and choose *OPEN*. -Click *SAVE*. - -### Create the Share - -Go to **Sharing > Windows Shares (SMB)** and click *ADD*. - -![SMBShareAdd](/images/CORE/Sharing/SharingSMBAdd.png "Basic SMB Share Options") - -Only the *Path* and *Name* are initially required. -The *Path* is the directory tree on TrueNAS that is shared using the SMB protocol. -The *Name* forms part of the "full share pathname" when SMB clients connect. - -![SharingSMBAddBasicExample](/images/CORE/Sharing/SharingSMBAddBasicExample.png "SMB Share Example") - -Click *SUBMIT* to save the configuration to **Sharing > Windows Shares (SMB)**. - -### Activate the Service - -Go to **Services** and toggle **SMB**. -Set *Start Automatically* when you want the share to become accessible immediately after TrueNAS boots. - -### Connecting to the Share - -On a Windows 10 system, open the **File Browser**. - -![WindowsFileBrowser](/images/CORE/WindowsFileBrowser.png "Windows 10 File Browser") - -In the navigation bar, enter `\\` and the TrueNAS system name. -When prompted, enter the TrueNAS user account credentials and begin browsing the dataset. - -![WindowsSMBShareConnected](/images/CORE/WindowsSMBShareConnected.png "Viewing the SMB Dataset") -{{< /tab >}} -{{< tab "Unix-like (NFS)" >}} -### Requirements - -* TrueNAS dataset to share. -* Client systems might require additional packages like `nfs-common`. - -### Creating the Share - -Go to **Sharing > Unix Shares (NFS)** and click *ADD*. - -![SharingNFSAdd](/images/CORE/Sharing/SharingNFSAdd.png "Creating a new NFS share") - -Use the file browser to select the dataset to be shared and click *SUBMIT*. -When prompted, click *ENABLE SERVICE* to immediately begin sharing the dataset. - -### Accessing the Dataset - -On a Unix-like system, open a command line. -Enter `showmount -e` *`IPADDRESS`*, replacing *IPADDRESS* with your TrueNAS system address: - -``` -tmoore@ChimaeraPrime:~$ showmount -e 10.238.15.194 -Export list for 10.238.15.194: -/mnt/pool1/testds (everyone) -``` - -Now make a local directory for the NFS mount: - -``` -tmoore@ChimaeraPrime:~$ sudo mkdir nfstemp/ -``` - -Finally, mount the shared directory: - -``` -tmoore@ChimaeraPrime:~$ sudo mount -t nfs 10.238.15.194:/mnt/pool1/testds nfstemp/ -``` - -From here, `cd` into the local directory and view or modify the files as needed. -{{< /tab >}} -{{< tab "Block Shares (iSCSI)">}} -Block sharing is a complicated scenario that requires detailed configuration steps and knowledge of your network environment. -A simple configuration is beyond the scope of this getting started guide, but detailed articles are available in [iSCSI Shares]({{< relref "iSCSIShare.md" >}}). -{{< /tab >}} -{{< /tabs >}} - -With simple sharing done, TrueNAS is now installed, accessible, and capable to receive or share data over your network. -Now it is time to protect the TrueNAS storage by setting up [data backups]({{< relref "DataBackups.md" >}}). diff --git a/content/CORE/GettingStarted/StoringData.md b/content/CORE/GettingStarted/StoringData.md deleted file mode 100644 index 43cc400703..0000000000 --- a/content/CORE/GettingStarted/StoringData.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "Storage Configuration" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/storingdata/" -description: "Describes how to configure storage on TrueNAS CORE." -weight: 60 -tags: -- gettingstarted -- storage ---- - -Now that you have logged in to the web interface, it's time to set up TrueNAS storage. -These instructions demonstrate a simple *mirrored* pool setup, where you use one disk for storage and the other for data protection. -However, there are many configuration possibilities for your storage environment! - -You can read more about these options in the in-depth [Pool Creation article]({{< relref "CORE/CORETutorials/Storage/Pools/_index.md" >}}). -You can also use the [ZFS Capacity Calculator]({{< relref "/References/ZFSCapacityCalculator.md" >}}) and [ZFS Capacity Graph]({{< relref "/References/ZFSCapacityGraph.md" >}}) to compare configuration options. - -## Requirements - -The system needs at least two identically sized disks to create a mirrored storage pool. -While a single-disk pool is technically allowed, we do not recommend it. -The disk you used for the TrueNAS installation does not count toward this limit. - -You can configure data backups in several ways and have different requirements. -Backing data up in the Cloud requires a 3rd party Cloud Storage provider account. -Backups with Replication require either additional storage on the TrueNAS system or (ideally) another TrueNAS system in a different location. - -## Simple Storage Setup - -Go to **Storage > Pools** and click **ADD**. -Set **Create a new pool** and click **CREATE POOL** - -![StoragePoolsAddCreateManager](/images/CORE/Storage/StoragePoolsAddCreateManager.png "TrueNAS Pool Manager") - -For the **Name**, enter *tank* or any other preferred name. -In the **Available Disks**, set two identical disks and click the to move them to the **Data VDevs** area. - -{{< hint type=note >}} -If the disks used have non-unique serial numbers, they do not populate the **Available Disks** section until you enable the **Show disk with non-unique serial numbers** checkbox. -{{< /hint >}} - -![StoragePoolsAddCreateTank](/images/CORE/Storage/StoragePoolsAddCreateTank.png "Creating the tank pool") - -TrueNAS automatically suggests **Mirror** as the ideal layout for maximized data storage and protection. - -Review the **Estimated total raw data capacity** and click **CREATE**. -TrueNAS wipes the disks and adds *tank* to the **Storage > Pools** list. - -![StoragePoolsListTank](/images/CORE/Storage/StoragePoolsListTank.png "Finding the tank pool") - -### Adding Datasets or Zvols - -New pools have a root dataset that allows further division into new datasets or zvols. -A *dataset* is a file system that stores data and has specific permissions. -A *zvol* is a virtual block device with a predefined storage size. -To create either one, go to **Storage > Pools**, click , and select **Add Dataset** or **Add Zvol**. - -![StoragePoolsAddDataset](/images/CORE/Storage/StoragePoolsAddDataset.png "Adding a new dataset or zvol") - -Users create datasets and zvols as part of configuring specific data-sharing situations: - -* A dataset with a **Share Type** set to **SMB** optimizes that dataset for the Windows sharing protocol. -* Block device sharing (iSCSI) requires a zvol. - -Organize the pool with additional datasets or zvols according to your access and data-sharing requirements before moving any data into the pool. - -When you finish building and organizing your TrueNAS pools, move on to configuring how the system [shares data]({{< relref "SharingStorage.md" >}}). diff --git a/content/CORE/GettingStarted/UserAgreements/COREEULA.md b/content/CORE/GettingStarted/UserAgreements/COREEULA.md deleted file mode 100644 index ed5eaf2263..0000000000 --- a/content/CORE/GettingStarted/UserAgreements/COREEULA.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: "TrueNAS CORE EULA" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/useragreements/coreeula/" -description: "End User License Agreement for TrueNAS CORE." -weight: 1 -aliases: - - /core/introduction/coreeula/ - - /core/notices/coreeula/ ---- - -## TrueNAS CORE End User License Agreement - -**Important - Please Read This EULA Carefully** - -PLEASE CAREFULLY READ THIS END USER LICENSE AGREEMENT (EULA) BEFORE CLICKING THE AGREE BUTTON. THIS AGREEMENT SERVES AS A LEGALLY BINDING DOCUMENT BETWEEN YOU AND IXSYSTEMS, INC. BY CLICKING THE AGREE BUTTON, DOWNLOADING, INSTALLING, OR OTHERWISE USING TRUENAS CORE SOFTWARE, YOU AGREE TO BE BOUND BY THE TERMS AND CONDITIONS OF THIS AGREEMENT). IF YOU DO NOT AGREE TO THE TERMS AND CONDITIONS IN THIS AGREEMENT, DO NOT USE OR INSTALL TRUENAS CORE SOFTWARE. - -This agreement is provided in accordance with the Commercial Arbitration Rules of the American Arbitration Association (the “AAA Rules”) under confidential binding arbitration held in Santa Clara County, California. To the fullest extent permitted by applicable law, no arbitration under this EULA will be joined to an arbitration involving any other party subject to this EULA, whether through class arbitration proceedings or otherwise. Any litigation relating to this EULA shall be subject to the jurisdiction of the Federal Courts of the Northern District of California and the state courts of the State of California, with venue lying in Santa Clara County, California. All matters arising out of or relating to this agreement shall be governed by and construed in accordance with the internal laws of the State of California without giving effect to any choice or conflict of law provision or rule. - -### 1.0 Definitions - - 1.1 “Company”, “iXsystems” and “iX” means iXsystems, Inc., on behalf of themselves, subsidiaries, and affiliates under common control. - - 1.2 “TrueNAS CORE Software” means the TrueNAS CORE storage management software. - - 1.3 “TrueNAS Device” means the TrueNAS storage appliances and peripheral equipment provided by iXsystems or a third party. - - 1.4 “Product” means, individually and collectively, the TrueNAS CORE Software and the TrueNAS Device provided by iXsystems. - - 1.5 “Open Source Software” means various open source software components licensed under the terms of applicable open source license agreements, each of which has its own copyright and its own applicable license terms. - - 1.6 “Licensee”, “You” and “Your” refers to the person, organization, or entity that has agreed to be bound by this EULA including any employees, affiliates, and third party contractors that provide services to You. - - 1.7 “Agreement” refers to this document, the TrueNAS End User License Agreement. - -### 2.0 License - -Subject to the terms set forth in this Agreement, iXsystems grants You a non-exclusive, non-transferable, perpetual, limited license without the option to sublicense, to use TrueNAS CORE Software on Your TrueNAS Device(s). This use includes but is not limited to using or viewing the instructions, specifications, and documentation provided with the Product. - -TrueNAS CORE software is made available as Open Source Software, subject to the license conditions contained within that Open Source Software. - -### 3.0 License Restrictions - -TrueNAS CORE Software is authorized for use on any TrueNAS Device. TrueNAS Devices can include hardware provided by iXsystems or third parties. TrueNAS Devices may also include virtual machines and cloud instances. TrueNAS CORE software may not be commercially distributed or sold without an addendum license agreement and express written consent from iXsystems. - -The TrueNAS CORE Software is protected by copyright laws and international treaties, as well as other intellectual property laws, statutes, and treaties. The TrueNAS CORE Software is licensed, not sold to You, the end user. You do not acquire any ownership interest in the TrueNAS CORE Software, or any other rights to the TrueNAS CORE Software, other than to use the TrueNAS CORE Software in accordance with the license granted under this Agreement, subject to all terms, conditions, and restrictions. iXsystems reserves and shall retain its entire right, title, and interest in and to the TrueNAS CORE Software, and all intellectual property rights arising out of or relating to the TrueNAS CORE Software, subject to the license expressly granted to You in this Agreement. - -The TrueNAS CORE Software may contain iXsystems’ proprietary trademarks and collateral. By agreeing to this license agreement for TrueNAS CORE, You agree to use reasonable efforts to safeguard iXsystems’ intellectual property and hereby agree to not use or distribute iXsystems’ proprietary intellectual property and collateral commercially without the express written consent of iXsystems. Official iXsystems Channel Partners are authorized to use and distribute iXsystems’ intellectual property through an addendum to this license agreement. -By accepting this Agreement, You are responsible and liable for all uses of the Product through access thereto provided by You, directly or indirectly. - -The TrueNAS CORE software includes Open Source components and some proprietary extensions which are available through additional licences You agree to not alter the source code to take advantage of the proprietary extensions without a license to those proprietary extensions, including the TrueNAS Enterprise features sets. - -### 4.0 General - - 4.1 Entire Agreement - This Agreement, together with any associated purchase order, service level agreement, and all other documents and policies referenced herein, constitutes the entire and only agreement between You and iXsystems for use of the TrueNAS CORE Software and all other prior negotiations, representations, agreements, and understandings are superseded hereby. No agreements altering or supplementing the terms hereof may be made except by means of a written document signed by Your duly authorized representatives and those of iXsystems. - - 4.2 Waiver and Modification - No failure of either party to exercise or enforce any of its rights under this EULA will act as a waiver of those rights. This EULA may only be modified, or any rights under it waived, by a written document executed by the party against which it is asserted. - - 4.3. Severability - If any provision of this EULA is found illegal or unenforceable, it will be enforced to the maximum extent permissible, and the legality and enforceability of the other provisions of this EULA will not be affected. - - 4.4 United States Government End Users - For any TrueNAS CORE Software licensed directly or indirectly on behalf of a unit or agency of the United States Government, this paragraph applies. Company’s proprietary software embodied in the Product: (a) was developed at private expense and is in all respects Company’s proprietary information; (b) was not developed with government funds; (c) is Company’s trade secret for all purposes of the Freedom of Information Act; (d) is a commercial item and thus, pursuant to Section 12.212 of the Federal Acquisition Regulations (FAR) and DFAR Supplement Section 227.7202, Government’s use, duplication or disclosure of such software is subject to the restrictions set forth by the Company and Licensee shall receive only those rights with respect to the Product as are granted to all other end users. - - 4.5 Title - iXsystems retains all rights, titles, and interest in TrueNAS CORE Software and all related copyrights, trade secrets, patents, trademarks, and any other intellectual and industrial property and proprietary rights, including registrations, applications, registration keys, renewals, and extensions of such rights. -Contact Information - If You have any questions about this Agreement, or if You want to contact iXsystems for any reason, please email legal@ixsystems.com. - - 4.8 Termination - iXsystems may cease any and all support, services, or maintenance under this Agreement without prior notice, or liability, and for any reason whatsoever, without limitation, if any of the terms and conditions of this Agreement are breached. Other provisions of this Agreement will survive termination including, without limitation, ownership provisions, warranty disclaimers, indemnity, and limitations of liability. - - 4.9 Open Source Software Components - iXsystems uses Open Source Software components in the development of the TrueNAS CORE Software. Open Source Software components that are used in the TrueNAS CORE Software are composed of separate components each having their own trademarks, copyrights, and license conditions. - - 4.10 Assignment - Licensee shall not assign or otherwise transfer any of its rights, or delegate or otherwise transfer any of its obligations or performance, under this Agreement, in each case whether voluntarily, involuntarily, by operation of law, or otherwise, without iXsystems’ prior written consent. No delegation or other transfer will relieve Licensee of any of its obligations or performance under this Agreement. Any purported assignment, delegation, or transfer in violation of this Section is void. iXsystems may freely assign or otherwise transfer all or any of its rights, or delegate or otherwise transfer all or any of its obligations or performance, under this Agreement without Licensee's consent. This Agreement is binding upon and inures to the benefit of the parties hereto and their respective permitted successors and assigns. - -### 5.0 Export Control Regulations - -"The Product may be subject to export control laws. You shall not, directly or indirectly, export, re-export, or release the Product to, or make the Product accessible from, any jurisdiction or country to which export, re-export, or release is prohibited by law, rule, or regulation. You shall comply with all applicable laws, regulations, and rules, and complete all required undertakings (including obtaining any necessary export license or other governmental approval)." - -### 6.0 Data Collection and Privacy - -TrueNAS CORE Software may collect non-sensitive system information relating to Your use of the Product, including information that has been provided directly or indirectly through automated means. Usage of TrueNAS CORE Software, device status and system configuration are allowed according to iXsystems’ privacy policy. - -TrueNAS CORE Software will not collect sensitive User information including email addresses, names of systems, pools, datasets, folders, files, credentials. - -By accepting this Agreement and continuing to use the Product, you agree that iXsystems may use any information provided through direct or indirect means in accordance with our privacy policy and as permitted by applicable law, for purposes relating to management, compliance, marketing, support, security, update delivery, and product improvement. - -### 7.0 Limitation of Liability and Disclaimer of Warranty - -THE PRODUCT IS PROVIDED "AS IS" AND WITH ALL FAULTS AND DEFECTS WITHOUT WARRANTY OF ANY KIND. TO THE MAXIMUM EXTENT PERMITTED UNDER APPLICABLE LAW, IXSYSTEMS, ON ITS OWN BEHALF AND ON BEHALF OF ITS AFFILIATES AND ITS AND THEIR RESPECTIVE LICENSORS AND SERVICE PROVIDERS, EXPRESSLY DISCLAIMS ALL WARRANTIES, WHETHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO THE PRODUCT, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, AND WARRANTIES THAT MAY ARISE OUT OF COURSE OF DEALING, COURSE OF PERFORMANCE, USAGE, OR TRADE PRACTICE. WITHOUT LIMITATION TO THE FOREGOING, IXSYSTEMS PROVIDES NO WARRANTY OR UNDERTAKING, AND MAKES NO REPRESENTATION OF ANY KIND THAT THE PRODUCT WILL MEET THE LICENSEE'S REQUIREMENTS, ACHIEVE ANY INTENDED RESULTS, BE COMPATIBLE, OR WORK WITH ANY OTHER SOFTWARE, APPLICATIONS, SYSTEMS, OR SERVICES, OPERATE WITHOUT INTERRUPTION, MEET ANY PERFORMANCE OR RELIABILITY STANDARDS OR BE ERROR FREE, OR THAT ANY ERRORS OR DEFECTS CAN OR WILL BE CORRECTED. - -TO THE FULLEST EXTENT PERMITTED UNDER APPLICABLE LAW: (A) IN NO EVENT WILL IXSYSTEMS OR ITS AFFILIATES, OR ANY OF ITS OR THEIR RESPECTIVE LICENSORS OR SERVICE PROVIDERS, BE LIABLE TO LICENSEE, LICENSEE’S AFFILIATES, OR ANY THIRD PARTY FOR ANY USE, INTERRUPTION, DELAY, OR INABILITY TO USE THE PRODUCT; LOST REVENUES OR PROFITS; DELAYS, INTERRUPTION, OR LOSS OF SERVICES, BUSINESS, OR GOODWILL; LOSS OR CORRUPTION OF DATA; LOSS RESULTING FROM SYSTEM OR SYSTEM SERVICE FAILURE, MALFUNCTION, OR SHUTDOWN; FAILURE TO ACCURATELY TRANSFER, READ, OR TRANSMIT INFORMATION; FAILURE TO UPDATE OR PROVIDE CORRECT INFORMATION; SYSTEM INCOMPATIBILITY OR PROVISION OF INCORRECT COMPATIBILITY INFORMATION; OR BREACHES IN SYSTEM SECURITY; OR FOR ANY CONSEQUENTIAL, INCIDENTAL, INDIRECT, EXEMPLARY, SPECIAL, OR PUNITIVE DAMAGES, WHETHER ARISING OUT OF OR IN CONNECTION WITH THIS AGREEMENT, BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE, REGARDLESS OF WHETHER SUCH DAMAGES WERE FORESEEABLE AND WHETHER OR NOT IXSYSTEMS WAS ADVISED OF THE POSSIBILITY OF SUCH DAMAGES; (B) IN NO EVENT WILL IXSYSTEMS’ AND ITS AFFILIATES', INCLUDING ANY OF ITS OR THEIR RESPECTIVE LICENSORS' AND SERVICE PROVIDERS', COLLECTIVE AGGREGATE LIABILITY UNDER OR IN CONNECTION WITH THIS AGREEMENT OR ITS SUBJECT MATTER, UNDER ANY LEGAL OR EQUITABLE THEORY, INCLUDING BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY, AND OTHERWISE, EXCEED THE TOTAL AMOUNT PAID TO IXSYSTEMS PURSUANT TO THIS AGREEMENT FOR THE PRODUCT THAT IS THE SUBJECT OF THE CLAIM; (C) THE LIMITATIONS SET FORTH IN THIS SECTION SHALL APPLY EVEN IF THE LICENSEE'S REMEDIES UNDER THIS AGREEMENT FAIL OF THEIR ESSENTIAL PURPOSE. - -You hereby acknowledge that you have read and understand this Agreement and voluntarily accept the duties and obligations set forth herein by clicking accept on this Agreement. diff --git a/content/CORE/GettingStarted/UserAgreements/DataCollectionStatement.md b/content/CORE/GettingStarted/UserAgreements/DataCollectionStatement.md deleted file mode 100644 index 70f71ed585..0000000000 --- a/content/CORE/GettingStarted/UserAgreements/DataCollectionStatement.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "TrueNAS Data Collection Statement" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/useragreements/datacollectionstatement/" -description: "TrueNAS CORE Data Collection Statement." -weight: 5 ---- - -TrueNAS collects non-sensitive system data and relays the data to a collector managed by iXsystems. -This system data collection is enabled by default and can be disabled in the web interface under **System > General > Usage collection**. - -{{< include file="/static/includes/TNDataCollection.md" >}} diff --git a/content/CORE/GettingStarted/UserAgreements/EnterpriseEULA.md b/content/CORE/GettingStarted/UserAgreements/EnterpriseEULA.md deleted file mode 100644 index 3a42f71382..0000000000 --- a/content/CORE/GettingStarted/UserAgreements/EnterpriseEULA.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: "TrueNAS Enterprise EULA" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/useragreements/enterpriseeula/" -description: "TrueNAS Enterprise End User License Agreement." -weight: 2 -aliases: - - /core/introduction/enterpriseeula/ - - /core/notices/enterpriseeula/ ---- - -## TrueNAS Enterprise End User License Agreement - -**Important - Please Read This EULA Carefully** - -PLEASE CAREFULLY READ THIS END USER LICENSE AGREEMENT (EULA) BEFORE CLICKING THE AGREE BUTTON. -THIS AGREEMENT SERVES AS A LEGALLY BINDING DOCUMENT BETWEEN YOU AND IXSYSTEMS, INC. -BY CLICKING THE AGREE BUTTON, DOWNLOADING, INSTALLING, OR OTHERWISE USING TRUENAS SOFTWARE, YOU AGREE TO BE BOUND BY THE TERMS AND CONDITIONS OF THIS AGREEMENT). -IF YOU DO NOT AGREE TO THE TERMS AND CONDITIONS IN THIS AGREEMENT, DO NOT USE OR INSTALL TRUENAS SOFTWARE. - -This agreement is provided in accordance with the Commercial Arbitration Rules of the American Arbitration Association (the “AAA Rules”) under confidential binding arbitration held in Santa Clara County, California. -To the fullest extent permitted by applicable law, no arbitration under this EULA will be joined to an arbitration involving any other party subject to this EULA, whether through class arbitration proceedings or otherwise. Any litigation relating to this EULA shall be subject to the jurisdiction of the Federal Courts of the Northern District of California and the state courts of the State of California, with venue lying in Santa Clara County, California. -All matters arising out of or relating to this agreement shall be governed by and construed in accordance with the internal laws of the State of California without giving effect to any choice or conflict of law provision or rule. - -### 1.0 Definitions - -**1.1 “Company”, “iXsystems”** and **“iX”** means iXsystems, Inc., on behalf of themselves, subsidiaries, and affiliates under common control. - -**1.2 “TrueNAS Software”** means the TrueNAS Enterprise storage management software. - -**1.3 “TrueNAS Device”** means the TrueNAS hardware storage appliances and peripheral equipment. - -**1.4 “Product”** means, individually and collectively, the TrueNAS Software and the TrueNAS Device. - -**1.5 “Open Source Software”** means various open source software components licensed under the terms of applicable open source license agreements, each of which has its own copyright and its own applicable license terms. - -**1.6 “Licensee”**, **“You”** and **“Your”** refers to the person, organization, or entity that has agreed to be bound by this EULA including any employees, affiliates, and third party contractors that provide services to You. - -**1.7 “Agreement”** refers to this document, the TrueNAS End User License Agreement. - -### 2.0 License - -Subject to the terms set forth in this Agreement, iXsystems grants You a non-exclusive, non-transferable, perpetual, limited license without the option to sublicense, to use TrueNAS Software on Your TrueNAS Device(s) in accordance with Your authorized purchase and use of a TrueNAS Device(s) for Your internal business purposes. -This use includes but is not limited to using or viewing the instructions, specifications, and documentation provided with the Product. - -### 3.0 License Restrictions - -TrueNAS Software is only authorized for use with a TrueNAS Device identified by a specific serial number and manufactured by iXsystems. -This license may be extended to a second TrueNAS Device if an additional TrueNAS Device was purchased for high availability data protection. -The license is provided as a digital license key that is installed on the TrueNAS Device. - -The TrueNAS Software is protected by copyright laws and international treaties, as well as other intellectual property laws, statutes, and treaties. -The TrueNAS Software is licensed, not sold to You, the end user. -You do not acquire any ownership interest in the TrueNAS Software, or any other rights to the TrueNAS Software, other than to use the TrueNAS Software in accordance with the license granted under this Agreement, subject to all terms, conditions, and restrictions. -iXsystems reserves and shall retain its entire right, title, and interest in and to the TrueNAS Software, and all intellectual property rights arising out of or relating to the TrueNAS Software, subject to the license expressly granted to You in this Agreement. - -The TrueNAS Software may contain iXsystems’ trademarks, trade secrets, and proprietary collateral. -iXsystems strictly prohibits the acts of decompiling, reverse engineering, or disassembly of the TrueNAS Software. -You agree to use commercially reasonable efforts to safeguard iXsystems’ intellectual property, trade secrets, or other proprietary information You may have access to, from infringement, misappropriation, theft, misuse, or unauthorized access. -You will promptly notify iXsystems if You become aware of any infringement of the TrueNAS Software and cooperate with iXsystems in any legal action taken by iXsystems to enforce its intellectual property rights. - -By accepting this Agreement, You agree You will not disclose, copy, transfer, or publish benchmark results relating to the Product without the express written consent of iXsystems. -You agree not to use, or permit others to use, the TrueNAS Software beyond the scope of the license granted under [Section 2](#20-license), unless otherwise permitted by iXsystems, or in violation of any law, regulation or rule, and you will not modify, adapt, or otherwise create derivative works or improvements of the TrueNAS Software. -You are responsible and liable for all uses of the Product through access thereto provided by You, directly or indirectly. - -### 4.0 General - -**4.1 Entire Agreement** - This Agreement, together with any associated purchase order, service level agreement, and all other documents and policies referenced herein, constitutes the entire and only agreement between You and iXsystems for use of the TrueNAS Software and all other prior negotiations, representations, agreements, and understandings are superseded hereby. -No agreements altering or supplementing the terms hereof may be made except by means of a written document signed by Your duly authorized representatives and those of iXsystems. - -**4.2 Waiver and Modification** - No failure of either party to exercise or enforce any of its rights under this EULA will act as a waiver of those rights. -This EULA may only be modified, or any rights under it waived, by a written document executed by the party against which it is asserted. - -**4.3 Severability** - If any provision of this EULA is found illegal or unenforceable, it will be enforced to the maximum extent permissible, and the legality and enforceability of the other provisions of this EULA will not be affected. - -**4.4 United States Government End Users** - For any TrueNAS Software licensed directly or indirectly on behalf of a unit or agency of the United States Government, this paragraph applies. -Company’s proprietary software embodied in the Product: (a) was developed at private expense and is in all respects Company’s proprietary information; (b) was not developed with government funds; (c) is Company’s trade secret for all purposes of the Freedom of Information Act; (d) is a commercial item and thus, pursuant to Section 12.212 of the Federal Acquisition Regulations (FAR) and DFAR Supplement Section 227.7202, Government’s use, duplication or disclosure of such software is subject to the restrictions set forth by the Company and Licensee shall receive only those rights with respect to the Product as are granted to all other end users. - -**4.5 Foreign Corrupt Practices Act** - You will comply with the requirements of the United States Foreign Corrupt Practices Act (the “FCPA”) and will refrain from making, directly or indirectly, any payments to third parties which constitute a breach of the FCPA. -You will notify Company immediately upon Your becoming aware that such a payment has been made. -You will indemnify and hold harmless Company from any breach of this provision. - -**4.6 Title** - iXsystems retains all rights, titles, and interest in TrueNAS Software and all related copyrights, trade secrets, patents, trademarks, and any other intellectual and industrial property and proprietary rights, including registrations, applications, registration keys, renewals, and extensions of such rights. - -**4.7 Contact Information** - If You have any questions about this Agreement, or if You want to contact iXsystems for any reason, please email legal@ixsystems.com. - -**4.8 Maintenance and Support** - You may be entitled to support services from iXsystems after purchasing a TrueNAS Device or a support contract. -iXsystems will provide these support services based on the length of time of the purchased support contract. -This maintenance and support is only valid for the length of time that You have purchased with Your TrueNAS Device. -iXsystems may from time to time and at their sole discretion vary the terms and conditions of the maintenance and support agreement based on different business environmental and personnel factors. -Any variations will be notified via email and the support portal. -For more information on our Maintenance and Support contract, refer to https://www.ixsystems.com/support/. - -**4.9 Force Majeure** - iXsystems will not be deemed to be in default of any of the provisions of this Agreement or be liable for any delay or failure in performance due to Force Majeure, which shall include without limitation acts of God, earthquake, weather conditions, labor disputes, changes in law, regulation or government policy, riots, war, fire, epidemics, acts or omissions of vendors or suppliers, equipment failures, transportation difficulties, malicious or criminal acts of third parties, or other occurrences which are beyond iXsystems’ reasonable control. - -**4.10 Termination** - iXsystems may terminate or suspend Your license to use the TrueNAS Software and cease any and all support, services, or maintenance under this Agreement without prior notice, or liability, and for any reason whatsoever, without limitation, if any of the terms and conditions of this Agreement are breached. -Upon termination, rights to use the TrueNAS Software will immediately cease. -Other provisions of this Agreement will survive termination including, without limitation, ownership provisions, warranty disclaimers, indemnity, and limitations of liability. - -**4.11 Open Source Software Components** - iXsystems uses Open Source Software components in the development of the TrueNAS Software. -Open Source Software components that are used in the TrueNAS Software are composed of separate components each having their own trademarks, copyrights, and license conditions. - -**4.12 Assignment** - Licensee shall not assign or otherwise transfer any of its rights, or delegate or otherwise transfer any of its obligations or performance, under this Agreement, in each case whether voluntarily, involuntarily, by operation of law, or otherwise, without iXsystems’ prior written consent. -No delegation or other transfer will relieve Licensee of any of its obligations or performance under this Agreement. -Any purported assignment, delegation, or transfer in violation of this Section is void. -iXsystems may freely assign or otherwise transfer all or any of its rights, or delegate or otherwise transfer all or any of its obligations or performance, under this Agreement without Licensee's consent. -This Agreement is binding upon and inures to the benefit of the parties hereto and their respective permitted successors and assigns. - -### 5.0 Export Control Regulations - -The Product may be subject to US export control laws, including the US Export Administration Act and its associated regulations. -You shall not, directly or indirectly, export, re-export, or release the Product to, or make the Product accessible from, any jurisdiction or country to which export, re-export, or release is prohibited by law, rule, or regulation. -You shall comply with all applicable federal laws, regulations, and rules, and complete all required undertakings (including obtaining any necessary export license or other governmental approval), prior to exporting, re-exporting, releasing, or otherwise making the Product available outside the US. - -### 6.0 Data Collection and Privacy - -TrueNAS Software may collect non-sensitive system information relating to Your use of the Product, including information that has been provided directly or indirectly through automated means. -Usage of TrueNAS Software, device status and system configuration are allowed according to iXsystems’ [privacy policy](https://www.ixsystems.com/privacy-policy/). - -TrueNAS Software will not collect sensitive User information including email addresses, names of systems, pools, datasets, folders, files, credentials. - -By accepting this Agreement and continuing to use the Product, you agree that iXsystems may use any information provided through direct or indirect means in accordance with our privacy policy and as permitted by applicable law, for purposes relating to management, compliance, marketing, support, security, update delivery, and product improvement. - -### 7.0 Limitation of Liability and Disclaimer of Warranty - -THE PRODUCT IS PROVIDED "AS IS" AND WITH ALL FAULTS AND DEFECTS WITHOUT WARRANTY OF ANY KIND. -TO THE MAXIMUM EXTENT PERMITTED UNDER APPLICABLE LAW, IXSYSTEMS, ON ITS OWN BEHALF AND ON BEHALF OF ITS AFFILIATES AND ITS AND THEIR RESPECTIVE LICENSORS AND SERVICE PROVIDERS, EXPRESSLY DISCLAIMS ALL WARRANTIES, WHETHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO THE PRODUCT, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, AND WARRANTIES THAT MAY ARISE OUT OF COURSE OF DEALING, COURSE OF PERFORMANCE, USAGE, OR TRADE PRACTICE. -WITHOUT LIMITATION TO THE FOREGOING, IXSYSTEMS PROVIDES NO WARRANTY OR UNDERTAKING, AND MAKES NO REPRESENTATION OF ANY KIND THAT THE PRODUCT WILL MEET THE LICENSEE'S REQUIREMENTS, ACHIEVE ANY INTENDED RESULTS, BE COMPATIBLE, OR WORK WITH ANY OTHER SOFTWARE, APPLICATIONS, SYSTEMS, OR SERVICES, OPERATE WITHOUT INTERRUPTION, MEET ANY PERFORMANCE OR RELIABILITY STANDARDS OR BE ERROR FREE, OR THAT ANY ERRORS OR DEFECTS CAN OR WILL BE CORRECTED. - -TO THE FULLEST EXTENT PERMITTED UNDER APPLICABLE LAW: (A) IN NO EVENT WILL IXSYSTEMS OR ITS AFFILIATES, OR ANY OF ITS OR THEIR RESPECTIVE LICENSORS OR SERVICE PROVIDERS, BE LIABLE TO LICENSEE, LICENSEE’S AFFILIATES, OR ANY THIRD PARTY FOR ANY USE, INTERRUPTION, DELAY, OR INABILITY TO USE THE PRODUCT; LOST REVENUES OR PROFITS; DELAYS, INTERRUPTION, OR LOSS OF SERVICES, BUSINESS, OR GOODWILL; LOSS OR CORRUPTION OF DATA; LOSS RESULTING FROM SYSTEM OR SYSTEM SERVICE FAILURE, MALFUNCTION, OR SHUTDOWN; FAILURE TO ACCURATELY TRANSFER, READ, OR TRANSMIT INFORMATION; FAILURE TO UPDATE OR PROVIDE CORRECT INFORMATION; SYSTEM INCOMPATIBILITY OR PROVISION OF INCORRECT COMPATIBILITY INFORMATION; OR BREACHES IN SYSTEM SECURITY; OR FOR ANY CONSEQUENTIAL, INCIDENTAL, INDIRECT, EXEMPLARY, SPECIAL, OR PUNITIVE DAMAGES, WHETHER ARISING OUT OF OR IN CONNECTION WITH THIS AGREEMENT, BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE, REGARDLESS OF WHETHER SUCH DAMAGES WERE FORESEEABLE AND WHETHER OR NOT IXSYSTEMS WAS ADVISED OF THE POSSIBILITY OF SUCH DAMAGES; (B) IN NO EVENT WILL IXSYSTEMS’ AND ITS AFFILIATES', INCLUDING ANY OF ITS OR THEIR RESPECTIVE LICENSORS' AND SERVICE PROVIDERS', COLLECTIVE AGGREGATE LIABILITY UNDER OR IN CONNECTION WITH THIS AGREEMENT OR ITS SUBJECT MATTER, UNDER ANY LEGAL OR EQUITABLE THEORY, INCLUDING BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY, AND OTHERWISE, EXCEED THE TOTAL AMOUNT PAID TO IXSYSTEMS PURSUANT TO THIS AGREEMENT FOR THE PRODUCT THAT IS THE SUBJECT OF THE CLAIM; (C) THE LIMITATIONS SET FORTH IN THIS SECTION SHALL APPLY EVEN IF THE LICENSEE'S REMEDIES UNDER THIS AGREEMENT FAIL OF THEIR ESSENTIAL PURPOSE. - -You hereby acknowledge that you have read and understand this Agreement and voluntarily accept the duties and obligations set forth herein by clicking accept on this Agreement. diff --git a/content/CORE/GettingStarted/UserAgreements/SofDevLifecycle.md b/content/CORE/GettingStarted/UserAgreements/SofDevLifecycle.md deleted file mode 100644 index 3aeccdf927..0000000000 --- a/content/CORE/GettingStarted/UserAgreements/SofDevLifecycle.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Software Development Life Cycle" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/useragreements/sofdevlifecycle/" -description: "Description of the general process of development, release, and patching of TrueNAS CORE versions." -weight: 4 -aliases: - - /core/introduction/sofdevlifecycle/ ---- - -{{< include file="/static/includes/TNLifecycle.md" >}} - -{{< include file="/static/includes/LifecycleTable.md" >}} diff --git a/content/CORE/GettingStarted/UserAgreements/_index.md b/content/CORE/GettingStarted/UserAgreements/_index.md deleted file mode 100644 index 2732af0647..0000000000 --- a/content/CORE/GettingStarted/UserAgreements/_index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "User Agreements" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/useragreements/" -description: "Different User agreement statements related to using TrueNAS." -geekdocCollapseSection: true -weight: 10 -cascade: - - _target: - related: false ---- - -This section contains the various legal agreements and notices pertaining to TrueNAS CORE software. - -
- -## Contents - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/GettingStarted/_index.md b/content/CORE/GettingStarted/_index.md deleted file mode 100644 index f869bb75dc..0000000000 --- a/content/CORE/GettingStarted/_index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "Getting Started" -redirect: "https://www.truenas.com/docs/core/13.0/gettingstarted/" -description: "This configuration guide provides step-by-step tutorials for installing and setting up TrueNAS CORE." -geekdocCollapseSection: true -weight: 10 -cascade: - - _target: - book: "COREGettingStarted" -related: false ---- - -This guide introduces TrueNAS and walks through installing and accessing TrueNAS, storing and backing up data, sharing data over a network, and expanding TrueNAS with different applications solutions. - -
- -## Table of Contents - -{{< children depth="2" description="true" >}} -
diff --git a/content/CORE/UIReference/Accounts/Groups.md b/content/CORE/UIReference/Accounts/Groups.md deleted file mode 100644 index 30887f73ad..0000000000 --- a/content/CORE/UIReference/Accounts/Groups.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "Groups" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/accounts/groups/" -description: "Describes the fields on the Groups screen in TrueNAS CORE." -weight: 10 -tags: -- groups -- accounts ---- - -The **Groups** screen lets you create and manage UNIX-style groups. - -## Groups List - -![UIRefGroupsList](/images/CORE/Accounts/UIRefGroupsList.png "Accounts Groups List") - -{{< truetable >}} -| Name | Description | -|------|------| -| **Filter Groups** | Filters groups by keyword. | -| **COLUMNS** | Lets users display/hide list columns. | -| **ADD** | Opens the **Group Configuration** form | -| | Displays/hides built-in groups | -| **Group** | Group name. | -| **GID** | Group ID number. | -| **Builtin** | Whether or not the group is built-in. | -| **Permit Sudo** | Whether or not the group has **Permit Sudo** enabled. | -| **Samba Authentication** | Whether or not the group has Samba Authentication enabled. | -{{< /truetable >}} - -## Groups Configuration - -{{< include file="/static/includes/CORERequiredFields.md" >}} - -![UIRefGroupsAdd](/images/CORE/Accounts/UIRefGroupsAdd.png "Accounts Groups Add") - -{{< truetable >}} -| Name | Description | -|------|------| -| **GID** | A unique number used to identify a Unix group. | -| **Name** | Descriptive name for the group. | -| **Permit Sudo** | Allows group members to act as the root account with sudo. Group members are prompted for their password when using sudo. | -| **Samba Authentication** | Allows group to be used for Samba permissions and authentication. | -| **Allow Duplicate GIDs** | Allows more than one group to have the same group ID. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/Accounts/Users.md b/content/CORE/UIReference/Accounts/Users.md deleted file mode 100644 index b46dcdaaae..0000000000 --- a/content/CORE/UIReference/Accounts/Users.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "Users" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/accounts/users/" -description: "Describes the fields on the Users screens in TrueNAS CORE." -weight: 20 -tags: -- users -- accounts ---- - -The **Users** screen lets you create and manage user accounts. - -## Users List - -![UIRefUsersList](/images/CORE/Accounts/UIRefUsersList.png "Accounts Users List") - -{{< truetable >}} -| Name | Description | -|------|------| -| Filter Users | Filters users by keyword. | -| COLUMNS | Lets users display/hide list columns. Username, UID, Builtin, and Full Name are default. | -| ADD | Opens the **User ID and Groups** form | -| | Displays/hides built-in users | -| Username | Descriptive name for the user. | -| UID | User ID number. | -| Builtin | Whether or not the user is built-in. | -| Full Name | Shows the saved **Full Name** of the account. | -{{< /truetable >}} - -## User Configuration - -{{< include file="/static/includes/CORERequiredFields.md" >}} - -![UIRefUsersAdd](/images/CORE/Accounts/UIRefUsersAdd.png "Accounts Users Add or Edit") - -### Identification - -{{< truetable >}} -| Name | Description | -|------|------| -| Full Name | Descriptive name for the user. | -| Username | User login name. | -| Email | User email address. | -| Password | User login password. | -| Confirm Password | Re-enter user password. | -{{< /truetable >}} - -### User ID and Groups - -{{< truetable >}} -| Name | Description | -|------|------| -| User ID | A unique number used to identify a user. | -| New Primary Group | Creates a new group with the same name as the user. | -| Primary Group | Primary group to add the user to. | -| Auxiliary Groups | Additional groups to add the user to. | -{{< /truetable >}} - -### Directories and Permissions - -{{< truetable >}} -| Name | Description | -|------|------| -| Home Directory | Path to the user home directory. | -| Home Directory Permissions | Default user home directory Unix permissions. | -{{< /truetable >}} - -### Authentication - -{{< truetable >}} -| Name | Description | -|------|------| -| SSH Public Key | Public SSH key for key-based authentication. | -| Disable Password | Enables/Disables password field. | -| Shell | The shell to use for local and SSH logins. | -| Lock User | Prevents user from logging in or using password-based services. | -| Permit Sudo | Enable or disable issuing commands as the root account with `sudo`. | -| Microsoft Account | Allows Windows authentication methods. | -| Samba Authentication | Lets users authenticate to Samba shares. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/Accounts/_index.md b/content/CORE/UIReference/Accounts/_index.md deleted file mode 100644 index 3ff8221251..0000000000 --- a/content/CORE/UIReference/Accounts/_index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Accounts" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/accounts/" -description: "CORE UI User and Group screens documentation." -geekdocCollapseSection: true -weight: 50 -related: false ---- - -This section has articles documenting the TrueNAS local User and Group screens. - -
- -## Accounts Contents - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/UIReference/Dashboard/_index.md b/content/CORE/UIReference/Dashboard/_index.md deleted file mode 100644 index e9ff294cef..0000000000 --- a/content/CORE/UIReference/Dashboard/_index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Dashboard -redirect: "https://www.truenas.com/docs/core/13.0/uireference/dashboard/" -description: "CORE Dashboard reference." -weight: 5 -geekdocCollapseSection: true -related: false ---- - -The web interface dashboard provides system details and shortcuts to various configuration screens. - -![DashboardCORE](/images/CORE/Dashboard/DashboardCORE.png "TrueNAS CORE Dashboard") - -## Dashboard Cards - -{{< truetable >}} -| Card | Description | -|------|-------------| -| **System Information** | Shows simple system-level information about TrueNAS, including hardware name (with compatible systems), TrueNAS version, system hostname, and system uptime. Includes a button to update the installed version of TrueNAS. | -| **CPU** | Shows current CPU utilization and heat (with compatible hardware). Includes a shortcut icon to the in-depth CPU reporting screen. | -| **Memory** | Shows total memory available to the system and the current breakdown of memory usage. Includes a shortcut icon to the in-depth memory utilization screen. | -| **Pool** | Shows details about a configured storage pool. One card is created for each storage pool on the system. Includes shortcut icons to the pool configuration and statistics screens. | -| **Interface** | Shows details about system network interfaces, including current status and configuration details. Includes shortcut icons to the interface configuration and statistics screens. | -| **TrueNAS Help** | Contains links to verious documentation and assistance portals. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/DirectoryServices/ADScreen.md b/content/CORE/UIReference/DirectoryServices/ADScreen.md deleted file mode 100644 index c95aecb990..0000000000 --- a/content/CORE/UIReference/DirectoryServices/ADScreen.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "Active Directory Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/directoryservices/adscreen/" -description: "Use the AD screen to configure Active Directory (AD) on TrueNAS CORE." -weight: 10 -tags: -- activedirectory ---- - -The Active Directory (AD) service shares resources in a Windows network environment. Go to **Directory Services > Active Directory** to set up AD on TrueNAS. The first Active Directory screen is a list of basic options. - -![ActiveDirectoryScreen](/images/CORE/DirectoryServices/ActiveDirectoryScreen.png "Active Directory Screen") - -## Basic Options - -![ActiveDirectoryScreenBasicOptions](/images/CORE/DirectoryServices/ActiveDirectoryScreenBasicOptions.png "Active Directory Basic Options") - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Domain Name** | Enter the Active Directory domain (*example.com*) or child domain (*sales.example.com*). Required field. | -| **Domain Account Name** | Enter the Active Directory administrator account name. Required field. | -| **Domain Account Password** | Enter the password for the Active Directory administrator account. Required when configuring a domain for the first time. After initial configuration, the password is not needed to edit, start or stop the service. | -| **Enable (requires password or Kerberos principle)** | Enable the Active Directory services. Must enter the **Domain Account Password** when selecting this option for the first time. | -{{< /truetable >}} - -Click **ADVANCED OPTIONS** to access extra options shown below. - -Click **REBUILD DIRECTORY SERVICE CACHE** to resync the cache if it becomes out of sync. Or if fewer users than expected are available or visible in the permissions editors. - -## Advanced Options - -![ActiveDirectoryScreenAdvancedOptions](/images/CORE/DirectoryServices/ActiveDirectoryScreenAdvancedOptions.png "Active Directory Advanced Options") - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Verbose logging** | Select to log attempts to join the domain to /var/log/messages. | -| **Allow Trusted Domains** | Selected if you do not want the username to include a domain name. Clear the checkbox to force the domain names to be prepended to usernames. One possible reason to not select this value is to prevent username collisions when this is selected and there are identical usernames across multiple domains. | -| **Use Default Domain** | Leave checkbox clear to prepend the domain name to the user name. When not selected prevents name collisions when **Allow Trusted Domains** is set and multiple domains use the same user name. | -| **Allow DNS Updates** | Select to enable Samba to do DNS updates when joining a domain. | -| **Disable FreeNAS Cache** | Select to disable caching AD users and groups. This can help when unable to bind to a domain with a large number of users or groups. | -| **Restrict PAM** | Select to restrict SSH access in certain circumstances. When selected only members of BUILTIN\\Administrators have SSH access. | -| **Site Name** | Enter the relative distinguished name of the site object in the Active Directory. | -| **Kerberos Realm** | Select an existing realm added in **Directory Services > Kerberos Realms**. | -| **Kerberos Principal** | Select the location of the principal in the keytab. Keytab created in **Directory Services > Kerberos Keytabs**. | -| **Computer Account OU** | The organizational unit where new computer accounts get created. OU strings read from top to bottom without RDNs. Use slashes (/) as delimiters, like *Computers/Servers/NAS*. Use the backslash (\\) to escape characters but not as a separator. Backslash interpretation takes place at many levels. Backslashes might need doubling or even quadrupling to take effect. When left blank, new computer accounts get created in the Active Directory default OU. | -| **AD Timeout** | Number of seconds before timeout. To view the AD connection status, open the interface **Task Manager**. | -| **DNS Timeout** | Number of seconds before a timeout. Increase this value if AD DNS queries time out. | -| **Winbind NSS Info** | Select the schema to use when querying AD for user/group info from the dropdown list. **rfc2307** uses the schema support included in Windows 2003 R2. **sfu** is for Service For Unix 3.0 or 3.5. **sfu20** is for Service For Unix 2.0. | -| **Netbios Name** | The Netbios name of this NAS is **truenas**. This name must differ from the Workgroup name and be no greater than 15 characters. | -| **NetBIOS alias** | Alternative names that SMB clients can use when connecting to this NAS. Can be no greater than 15 characters. | -| **LEAVE DOMAIN** | Disconnects the TrueNAS system from the Active Directory. | -{{< /truetable >}} - -Click **SAVE** to save settings. - -Click **BASIC OPTIONS** to return to the **Active Directory** display of basic options only. - -Click **EDIT IDMAP** to navigate to the **Directory Services > Idmap** screen. - -Click **REBUILD DIRECTORY SERVICE CACHE** to resync the cache if it becomes out of sync. Or if fewer users than expected are available in the permissions editors. diff --git a/content/CORE/UIReference/DirectoryServices/IdmapScreen.md b/content/CORE/UIReference/DirectoryServices/IdmapScreen.md deleted file mode 100644 index 2b578f7468..0000000000 --- a/content/CORE/UIReference/DirectoryServices/IdmapScreen.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "Idmap Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/directoryservices/idmapscreen/" -description: "Use the Idmap screen to configure Identity Mapping (Idmap) on TrueNAS CORE." -weight: 10 -tags: -- idmap -- activedirectory ---- - -On a system running Unix or a Unix-like OS, Idmap acts as a translator. Windows Security Identifier (SID)s convert to a user ID (UID) and group ID (GID). Use the Identity Mapping (Idmap) screen to configure Idmap service on the TrueNAS. - - Click **Edit IDMAP** on the **Active Directory > Advanced Options** screen. The **Edit Idmap** screen displays. It lists all domains configured on the TrueNAS. - -![DirectoryServicesldmapScreenn](/images/CORE/DirectoryServices/DirectoryServicesldmapScreen.png "Directory Services Idmap Screen") - -You can customize the information displayed in the **Idmap** table. Click the blue **COLUMNS** button to display a dropdown list of options. A check mark next to the option name means the column is currently visible. Select from **Unselect All**, **Backend**, **DNS Domain Name**, **Range Low**, **Range High**, **Certificate** or **Reset to Defaults**. - -Click **ADD** to open the **Idmap Add** screen. Enable Active Directory before attempting to add new domains. - -Click the icon to display the options for each domain, **Edit** or **Delete**. - -## Idmap Settings - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Idmap Backend** | Select the plugin interface for Windbind to use from the dropdown list. Plugin interfaces for Windbind use varying backends. These backends store SID/uid/gid mapping tables. The correct setting depends on the NAS deployment environment. | -| **Name** | Enter the pre-Windows 2000 domain name or select from the dropdown list. | -| **DNS Domain Name** | Enter the DNS name of the domain. | -| **Range Low** | Determines the range of UID/GID numbers which this Idmap backend translates. External credentials like a Windows SID must map to a UID or GID number inside this range. Ignores external credentials outside this range. | -| **Range High** | Determines the range of UID/GID numbers which this Idmap backend translates. External credentials like a Windows SID must map to a UID or GID number inside this range. Ignores external credentials outside this range. | -| **SSSD Compat** | Select to generate Idmap low range based on same algorithm that SSSD uses by default. | -{{< /truetable >}} - -Click **SAVE** to save settings and return to the **Idmap** screen. - -Click **CANCEL** to exit without saving and return to the **Idmap** screen. diff --git a/content/CORE/UIReference/DirectoryServices/KerberosScreens.md b/content/CORE/UIReference/DirectoryServices/KerberosScreens.md deleted file mode 100644 index c31ae06213..0000000000 --- a/content/CORE/UIReference/DirectoryServices/KerberosScreens.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "Kerberos Screens" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/directoryservices/kerberosscreens/" -description: "Use the Kerberos screen to configure to configure Kerberos realms and keytabs on TrueNAS CORE." -weight: 40 -tags: -- kerberos ---- - -Kerberos is an authentication protocol. It allows nodes on a network to perform identity checks in a secure manner. -Kerberos uses realms and keytabs to authenticate clients and servers. -Go to **Directory Services > Kerberos** to configure Kerberos. These screens configure Kerberos realms and keytabs on your TrueNAS. - -![KerberosRealmsScreen](/images/CORE/DirectoryServices/KerberosRealmsScreen.png "Kerberos Realms Screen") - -Both **Kerberos Realms** and **Kerberos Keytabs** display a table of what is currently on the system. - -Click the blue **Columns** button to display a list of options. These options customize the table display. This button is available for both the realms and keytabs screens. - -Click **ADD** to display the settings screens for either realms or keytabs. - -Select **Kerberos Settings** to open the settings screen but no table. - -## Kerberos Realms - -Your network must contain a Key Distribution Center (KDC) to add a realm. -A Kerberos realm is an authorized domain that a Kerberos server can use to authenticate a client. -By default, TrueNAS creates a Kerberos realm for the local system. - -Click **ADD** to create a realm on the TrueNAS. Click **SUBMIT** to save changes. - -![KerberosRealmAdvancedOptions](/images/CORE/DirectoryServices/KerberosRealmAdvancedOptions.png "Kerberos Realm Add Screen") - -**Basic Options** - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Realm** | Enter a name for the realm. | -{{< /truetable >}} - -**Advanced Options** - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **KDC** | Enter the name of the Key Distribution Center. If there is more than one value separate the values by pressing Enter. | -| **Admin Server** | Define the server that performs all changes to the database. If there is more than one value separate the values by pressing Enter. | -| **Password Server** | Define the server that performs all password changes. If there is more than one value separate the values by pressing Enter. | -{{< /truetable >}} - -## Kerberos Keytabs - -A [keytab (key table)](https://web.mit.edu/kerberos/krb5-devel/doc/basic/keytab_def.html) is a file that stores encryption keys for various authentication scenarios. -Kerberos keytabs allow systems and clients to join an Active Directory or LDAP. Keytabs make it possible to join without entering a password. - -After generating the keytab, use the **Add Kerberos Keytab** screen to add it to your TrueNAS. - -![KerberosKeytabAddScreen](/images/CORE/DirectoryServices/KerberosKeytabAddScreen.png "Kerberos Keytab Add Screen") - -**Kerberos Keytab** - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Name** | Enter a name for the keytab. | -| **Choose File** | Opens a file explorer window where you can locate and select the keytab file. | -{{< /truetable >}} - -Click **SUBMIT** to save settings or **CANCEL** to exit without saving. - -## Kerberos Settings - -Use the **Directory Services > Kerberos Settings** screen to enter any extra settings. - -![KerberosSettingsScreen](/images/CORE/DirectoryServices/KerberosSettingsScreen.png "Kerberos Settings") - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Appdefaults Auxiliary Parameters** | Define any extra settings for use by some Kerberos applications. [[appdefaults] section of krb.conf(5)](https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html#appdefaults) lists the available settings and syntax. | -| **Libdefaults Auxiliary Parameters** | Define any settings used by the Kerberos library. [[libdefaults] section of krb.conf(5)](https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html#libdefaults) lists the available settings and their syntax. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/DirectoryServices/LDAPScreen.md b/content/CORE/UIReference/DirectoryServices/LDAPScreen.md deleted file mode 100644 index a41a7bcded..0000000000 --- a/content/CORE/UIReference/DirectoryServices/LDAPScreen.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: "LDAP Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/directoryservices/ldapscreen/" -description: "Use the LDAP screen to configure Lightweight Directory Access Protocol (LDAP) server settings on TrueNAS CORE." -weight: 20 -tags: -- ldap -- idmap ---- - -Lightweight Directory Access Protocol (LDAP) is an industry standard. Directory information services deployed over an Internet Protocol (IP) network can use LDAP. Configure LDAP server settings on your TrueNAS using the **Directory Services > LDAP** screen. - -![DirectoryServicesLDAPScreen](/images/CORE/DirectoryServices/DirectoryServicesLDAPScreen.png "Directory Services LDAP Screen") - -Click **SAVE** to save settings. - -Click **ADVANCED OPTIONS** to display extra **LDAP** configuration options. - -Click **REBUILD DIRECTORY SERVICE CACHE** to resync the cache if it becomes out of sync. Or if fewer users than expected are available in the permissions editors. - -## Basic Options - -![LDAPBasicOptions](/images/CORE/DirectoryServices/LDAPBasicOptions.png "LDAP Basic Options") - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Hostname** | Enter the LDAP server host names or IP addresses. Separate entries with an empty space. To create an LDAP failover priority list, enter more than one host name or IP address. If a host does not respond, the system tries the next host on the list. This continues until the new connection succeeds. | -| **Base DN** | Top level of the LDAP directory tree to use when searching for resources. For example, *dc=test,dc=org*. | -| **Bind DN** | Enter an administrative account name on the LDAP server. For example, *cn=Manager,dc=test,dc=org*. | -| **Bind Password** | Enter the password for the administrative account in **Bind DN**. | -| **Enable** | Select to activate the configuration. Leave checkbox clear to disable the configuration without deleting it. | -{{< /truetable >}} - -## Advanced Options - -![LDAPAdvancedOptions](/images/CORE/DirectoryServices/LDAPAdvancedOptions.png "LDAP Advanced Options") - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Allow Anonymous Binding** | Select to disable authentication and allow read and write access to any client. | -| **Kerberos Realm** | Select an option configured on your system from the dropdown list. | -| **Kerberos Principle** |Select an option configured on your system from the dropdown list. | -| **Encryption Mode** | Select an encryption mode for the LDAP connection from the dropdown list. Select **OFF** to not encrypt the LDAP connection. Select **ON** to encrypt the LDAP connection with SSL on port **636**. Select **START_TLS** to encrypt the LDAP connection with STARTTLS. This option uses the default LDAP port **389**. | -| **Certificate** | A certificate is not required when using a username and password. A certificate is not required when using Kerberos authentication. Select a certificate added to your system from the dropdown list. The default option is **freenas_default**. Or add a new LDAP certificate-based authentication for the LDAP provider to sign. See [Certificate Signing Requests]({{< relref "/CORE/CORETutorials/SystemConfiguration/CreatingCAsandCertificates/CreatingCertificates.md" >}}) for more information. | -| **Validate Certificates** | Select to validate the authenticity of the certificate. | -| **Disable LDAP User/Group Cache** | Select to disable caching LDAP users and groups in large LDAP environments. When disabled, LDAP users and groups do not display on dropdown lists. They are still accepted when typed into fields. | -| **LDAP timeout** | Default value is **10** seconds. Increase if Kerberos ticket queries are not responding within the default time. | -| **DNS timout** | Default value is **10** seconds. Increase if DNS queries take too long to respond. | -| **Samba Schema (DEPRECATED - see help text)** | Select if SMB shares need LDAP authentication and the LDAP server is already configured with Samba attributes. If selected, specify the type of schema from the **Schema** dropdown list. | -| **Auxiliary Parameters** | Enter for [nslcd.conf](https://arthurdejong.org/nss-pam-ldapd/nslcd.conf.5). | -| **Schema** | Select the LDAP NSS schema from the dropdown list. Options are **RFC2307** or **RFC2307BIS**. | -{{< /truetable >}} - -{{< hint type=important >}} -Support for LDAP **Samba Schema** is deprecated in TrueNAS 13.0 or later. -Users with LDAP and SMB shares configured should begin to migrate legacy Samba domains to Active Directory. -{{< /hint >}} - -Click **SAVE** to save settings and return to the **LDAP** screen. - -Click **BASIC OPTIONS** to return to the **LDAP** display of basic options only. - -Click **EDIT IDMAP** to navigate to the **Directory Services > Idmap** screen. diff --git a/content/CORE/UIReference/DirectoryServices/NISScreen.md b/content/CORE/UIReference/DirectoryServices/NISScreen.md deleted file mode 100644 index 40bda33c58..0000000000 --- a/content/CORE/UIReference/DirectoryServices/NISScreen.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "NIS Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/directoryservices/nisscreen/" -description: "Use the NIS screen to configure Network Information System (NIS) on TrueNAS CORE." -weight: 30 -tags: -- nis ---- - -NIS is a client–server directory service protocol. Usage scenarios include the distribution of user and host names between networked computers. -Use the **Directory Services > NIS** screen to configure [Network Information Service](https://www.oreilly.com/library/view/practical-unix-and/0596003234/ch14s01.html) on your TrueNAS. - -{{< hint type=important >}} -NIS is limited in scalability and security. -For modern networks, [LDAP]({{< relref "/CORE/UIReference/DirectoryServices/LDAPScreen.md" >}}) has replaced NIS. -{{< /hint >}} - -![DirectoryServicesNIS](/images/CORE/DirectoryServices/DirectoryServicesNIS.png) - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **NIS Domain** | Enter a name and list any NIS domain host names or IP addresses. Press Enter to separate server entries. | -| **NIS Servers** |Enter a name and list any NIS server host names or IP addresses. Press Enter to separate server entries. | -| **Secure Mode** | Select to have [ypbind(8)](https://www.freebsd.org/cgi/man.cgi?query=ypbind) refuse to bind to any NIS server not running as *root* on a TCP port over **1024**. | -| **Manycast** | Select for `ypbind` to bind to the fastest responding server. | -| **Enable** | Select to enable the configuration. Leave checkbox clear to disable the configuration without deleting it. | -{{< /truetable >}} - -Click **SAVE** to save configuration settings. - -Click **REBUILD DIRECTORY SERVICE CACHE** to resync the cache if it becomes out of sync. Or if fewer users than expected are available in the permissions editors. diff --git a/content/CORE/UIReference/DirectoryServices/_index.md b/content/CORE/UIReference/DirectoryServices/_index.md deleted file mode 100644 index 371f946ecc..0000000000 --- a/content/CORE/UIReference/DirectoryServices/_index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Directory Services" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/directoryservices/" -description: "Reference documentation of the Directory Services screens." -geekdocCollapseSection: true -weight: 100 -related: false ---- - -
- -## Directory Services Contents - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/UIReference/JailsPluginsVMs/JailsScreens.md b/content/CORE/UIReference/JailsPluginsVMs/JailsScreens.md deleted file mode 100644 index 17aed60c0a..0000000000 --- a/content/CORE/UIReference/JailsPluginsVMs/JailsScreens.md +++ /dev/null @@ -1,157 +0,0 @@ ---- -title: "Jails Screens" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/jailspluginsvms/jails/jailsscreens/" -description: "Describes the fields in the Jails screen in TrueNAS CORE." -weight: 10 -tags: -- jails ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -The Jails screen displays a list of jails installed on your system. Use to add, edit or delete jails. - -![JailsScreen](/images/CORE/Jails/JailsScreen.png "Jails Screen") - -Use the blue **Columns** dropdown list to display options to change the information displayed in the list of tables. Options are **Select All**, **JID**, **Boot**, **State**, **Release**, **IPv4**, **IPv6**, **Type**, **Template**, **Basejail** or **Reset to Defaults**. - -Use the settings icon to set the pool to use for jail storage. - -Use **ADD** to display the first configuration **Wizard** screen and to access the **ADVANCED JAIL CREATION** button to display advanced jail configuration screens. - -## Individual Jail Screen - -Click the chevron_right icon to display the individual jail screen, the primary settings and additional action options for that jail. - -Click the expand_more icon to collapse the individual jail screen. - -![Jails Options](/images/CORE/Jails/JailsOptions.png "Jails Options") - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **EDIT** | Used to modify the settings described in **Advanced Jail Creation** below. You cannot edit a jail while it is running. You can only view read only settings until you stop the jail operation. | -| **MOUNT POINTS** | Select an existing mount point to edit. Either click **EDIT** or **ACTIONS > Add Mount Point** to create a mount point for the jail. A mount point gives a jail access to storage located elsewhere on the system. You must stop a jail before adding, editing, or deleting a mount point. | -| **RESTART** | Stops and immediately starts a jail that is running or **up**. | -| **START** | Starts a jail that has a current **STATE** of **down**. | -| **STOP** | Stops a jail in the current **STATE** of **up**. | -| **UPDATE** | Runs [freebsd-update](https://www.freebsd.org/cgi/man.cgi?query=freebsd-update) to update the jail to the latest patch level of the installed FreeBSD release. | -| **SHELL** | Displays the **Shell** screen with access to a root command prompt where you can interact with a jail directly from the command line. Type `exit` to leave the command prompt or click **Jails** on the breadcrumb at the top of the screen to return to the **Jails** screen. | -| **DELETE** | Deletes the selected jail. Caution: deleting the jail also deletes all of the jail contents and all associated snapshots. Back up the jail data, configuration, and programs first. There is no way to recover the contents of a jail after deleting it! | -{{< /truetable >}} - -{{< hint type=note >}} -Action options change based on the jail state. For example, a stopped jail does not have a **STOP** or **SHELL** option. -{{< /hint >}} - -## Jail Creation Options -TrueNAS has two options to create a jail, the **Wizard** or the **Advanced Jail Creation** option at the bottom of the **Wizard** screen. -The Jail **Wizard** makes it easy to create a jail. -**ADVANCED JAIL CREATION** opens the advanced configuration screen with all possible jail configuration settings. -We recommend that only advanced users with specific requirements for a jail use this form. - -{{< expand "Jail Wizard" "v" >}} -Use the jail-creation **Wizard** to add a new jail by following and completing required fields in a pre-determined order. -The wizard is the simplest process to create and configure a new jail. -Click **ADD** to display the first of three **Wizard** configuration screens. - -### Name Jail and Choose FreeBSD Release Screen -This screen includes the jail name, type, and release settings. - -![JailsWizardNameJailChooseFreeBSDRelease](/images/CORE/Jails/JailsWizardNameJailChooseFreeBSDRelease.png "Jails Wizard NameJail Choose FreeBSD Release") - -{{< expand "Name Jail and Choose FreeBSD Release Settings" "v" >}} -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Name** | Required. Enter a name using letters, numbers, or the period (.), dash (-), or underscore (_) special characters. You can rename a jail after creating and saving it. | -| **Jail Type** | Select an option from the dropdown list. Options are **Default (Clone Jail)** or **Basejail**. Use **Default (Clone Jail)** to clone jails that are clones of the value specified in **Release**. These are linked to that release, even if they are upgraded. Use **Basejails** to mount the specified release directories as nullfs mounts over the jail directories. Basejails are not linked to the original release when upgraded. Versions of FreeBSD are downloaded the first time they are used in a jail. Additional jails created with the same version of FreeBSD are created faster because the download is already complete. | -| **Release** | Select the FreeBSD release to use as the jail operating system option from the dropdown list. Options are **12.4-RELEASE** or **13.2-RELEASE**. Jails can run FreeBSD versions up to the same version as the host system. Newer releases are not shown. | -| **Advanced Jail Creation** | Opens the **Advanced Jail Creation** screens. This form is only recommended for advanced users with very specific requirements for a jail. | -{{< /truetable >}} -{{< /expand >}} -### Configure Networking Screen -This screen includes DHCP, NAT or VNET, IPV4 IP or IPv6 interface, address, and netmask, and default router, and the IPv6 prefix. - -![JailsWizardConfigureNetworking](/images/CORE/Jails/JailsWizardConfigureNetworking.png "Jails Wizard Configure Networking") - -{{< expand "Configure Networking Settings" "v" >}} -{{< truetable >}} -| Name | Description | -|------|-------------| -| **DHCP Autoconfigure IPv4** | Select to auto-configure jail networking with the Dynamic Host Configuration Protocol (DHCP). Select **VNET** and **Berkeley Packet Filter** with this option. | -| **NAT** | Network Address Translation (NAT) to transform local network IP addresses into a single IP address. Select when the jail shares a single connection to the Internet with other systems on the network. | -| **VNET** | Select to use [VNET(9)](https://www.freebsd.org/cgi/man.cgi?query=vnet) to emulate network devices for the jail. A fully virtualized per-jail network stack is installed. | -| **vnet_default_interface** | Select the default VNET interface from options on the dropdown list. Options are **none**, **auto**, or specific interfaces on your system. Only takes effect when **VNET** is selected. Choose a specific interface or set to **auto** to use the interface that has the default route. Choose **none** to not set a default VNET interface. | -| **IPv4 Interface** | Select the IPv4 interface for the jail from the dropdown list. | -| **IPv4 Address** | Enter the IPv4 address for [VNET(9)](https://www.freebsd.org/cgi/man.cgi?query=vnet) and shared IP jails. | -| **IPv4 Netmask** | Select the IPv4 netmask for the jail from the dropdown list. | -| **IPv4 Default Router** | Enter a valid IPv4 address to use as the default route. Enter **none** to configure the jail with no IPv4 default route. A jail without a default route is not be able to access any networks. | -| **AutoConfigure IPv6** | Select to use Stateless Address Auto Configuration (SLAAC) to auto-configure IPv6 in the jail. | -| **IPv6 Interface** | Select the IPv6 interface for the jail from the dropdown list. | -| **IPv6 Address** | Enter the IPv6 address for [VNET(9)](https://www.freebsd.org/cgi/man.cgi?query=vnet) and shared IP jails. | -| **IPv6 Prefix** | Select the IPv6 prefix for the jail from the dropdown list. | -| **IPv6 Default Router** | Enter a valid IPv6 address to use as the default route. Enter **none** to configure the jail without an IPv6 default route. A jail without a default route is not able to access any networks. | -{{< /truetable >}} -{{< /expand >}} -### Confirm Options Screen -This screen shows a summary of the jail settings entered or selected on the **Wizard** screens. - -![JailsWizardConfirmOptions](/images/CORE/Jails/JailsWizardConfirmOptions.png "Jails Wizard Confirm Options") - -### Wizard Navigation - -**Next** advances to the next screen. - -**Back** returns to the previous screen. - -**SUBMIT** saves all settings and creates the Jail. - -**Cancel** closes the current screen and exits the configuration process without saving. -{{< /expand >}} -{{< expand "Advanced Jail Creation" "v" >}} -The **Advanced Jail Creation** screen has four expandable configuration areas: -* [Basic Properties](#basic-properties) -* [Jail Properties](#jail-properties) -* [Network Properties](#network-properties) -* [Custom Properties](#custom-properties) - -Click the expand_more icon to collapse any area of configuration settings. - -Use **Next** to advance to the next configuration settings section, or click the expand_less icon to expand a configuration settings area. - -#### Basic Properties -The **Basic Properties** area includes the jail name, type, FreeBSD release, and network settings. - -![AdvancedJailCreationBasicProperties](/images/CORE/Jails/AdvancedJailCreationBasicProperties.png "Advanced Jail Creation Jail Basic Properties") - -{{< expand "Jail Basic Properties Settings" "v" >}} -{{< include file="/static/includes/JailsBasicPropertiesFields.md" markdown="true" >}} -{{< /expand >}} -#### Jail Properties -The **Jail Properties** area includes the jail ruleset to follow, commands to run in the system or jail environment, jail user, allow or deny SYSV IPC message, shared memory primitives, or semaphore primitives, VNET interfaces, and other jail settings. - -![AdvancedJailCreationJailProperties](/images/CORE/Jails/AdvancedJailCreationJailProperties.png "Advanced Jail Creation Jail Properties") - -{{< expand "Jail Properties Settings" "v" >}} -{{< include file="/static/includes/JailsPropertiesFields.md" markdown="true" >}} -{{< /expand >}} -#### Network Properties -The **Network Properties** area includes the assigned interface(s), host name, domain name, resolver, rounding table to use, and IP address type (v4 or v6), mac prefix, and NAT interface and port forwarding settings. - -![AdvancedJailCreationNetworkProperties](/images/CORE/Jails/AdvancedJailCreationNetworkProperties.png "Advanced Jail Creation Network Properties") - -{{< expand "Network Properties Settings" "v" >}} -{{< include file="/static/includes/JailNetworkPropertiesFields.md" markdown="true" >}} -{{< /expand >}} -#### Custom Properties -The **Custom Properties** area includes the priority for the jail at boot time, jail host ID, setting this jail as a template, system host time to synchronize time between the jail and host, enabling ZFS jailing inside the jail, defining the dataset to be jailed and to be fully handed over to a jail, entering a mount point for the **jail_zfs_dataset**, tun settings, and other local host, IP host name, and IPV6 autoconfigure settings. - -![AdvancedJailCreationCustomProperties](/images/CORE/Jails/AdvancedJailCreationCustomProperties.png "Advanced Jail Creation Custom Properties") - -{{< expand "Custom Properties Settings" "v" >}} -{{< include file="archive/JailsCustomPropertiesFields.md" markdown="true" >}} -{{< /expand >}} -{{< /expand >}} diff --git a/content/CORE/UIReference/JailsPluginsVMs/PluginsScreens.md b/content/CORE/UIReference/JailsPluginsVMs/PluginsScreens.md deleted file mode 100644 index e334f0cc5d..0000000000 --- a/content/CORE/UIReference/JailsPluginsVMs/PluginsScreens.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "Plugins Screens" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/jailspluginsvms/plugins/pluginsscreens/" -description: "Describes how to install and maintain 3rd party applications on TrueNAS CORE." -weight: 20 -tags: -- apps -- plugins ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -Use the **Plugins** screen to install and maintain 3rd party applications on your TrueNAS storage systems. - -![PluginsScreen](/images/CORE/Plugins/PluginsScreen.png "Plugins Screen") - -Use the blue **Columns** dropdown list to display options to change the information displayed in the lis to of tables. Options are **Select All**, **Status**, **Admin Portals**, **IPv4 Address**, **IPv6 Address**, **Version**, **Plugin**, **Release**, **Boot**, **Collection** or **Reset to Defaults**. - -Use the settings icon to set the pool to use for **Plugin and Jail Manager** storage. - -Use **Browse a Collection** to select 3rd party applications from either the **iXsystems** or **Community** libraries. - -Use **REFRESH INDEX** to update the index of applications. - -Use **INSTALL** to display the **Plugins Add** configuration screen and to access the **ADVANCED PLUGIN INSTALLATION** button to display advanced Plugin and jail configuration screens. - -## Individual Plugin Screen - -Click the chevron_right icon to display the individual plugin screen with the IP address and name for the plugin, the release and version and Github location for the collection. It includes additional action options for that plugin. - -Click the expand_more icon to collaspe the individual plugin screen. - -![PluginDetailScreen](/images/CORE/Plugins/PluginDetailScreen.png "Plugin Detail Screen") - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Manage** | Displays the **System Overview** screen for that application. For example, the **netdatajail** system overview with CPU and load graphics and options to view other information about this application. | -| **MOUNT POINTS** | Displays the **Jails Mount Points of *nameofpluginjail*** screen. Click **ACTIONS** and select either **Add** to create a mount point for the jail used by the plugin, or **Go Back to Jails** to open the **Jails** screen. A mount point gives a jail access to storage located elsewhere on the system. You must stop a jail before adding, editing, or deleting a mount point. See Additional Storage for more details. | -| **RESTART** | Starts a stopped plugin. | -| **STOP** | Stops a plugin and the associated jail. | -| **UPDATE** | Displays the **Update plugin** dialog where you can select the option to **Update jail as well**. Select **Confirm** to activate the **UPDATE** button. | -| **Uninstall** | Displays a verification dialog for the plugin and related jail. Type the name displayed in the dialog and select **Confirm** to activate the **DELETE** button. | -{{< /truetable >}} - -## Plugin Add Screen -Use the **Add** screen to install the plugin highlighted on the **Plugins** screen for a simple basic install of a third party application. -Use the **ADVANCED PLUGIN INSTALLATION** button to open the advanced configuration screens with all possible configuration settings for the plugin and related jail. -This form is recommended only for advanced users with very specific requirements for a jail. - -![PluginsAddScreen](/images/CORE/Plugins/PluginsAddScreen.png "Plugins Add Screen") - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Plugin Name** | Displays the name of the plugin highliged on the **Plugin** screen. | -| **Jail Name** | Required field. Enter a name that can include letters, numbers, periods (.), dashes (-), and underscores (_). | -| **DHCP** | Select to allow DHCP to configure networking for the jail. | -| **NAT** | Network Address Translation (NAT) to transform local network IP addresses into a single IP address. Select when the jail shares a single connection to the Internet with other systems on the network. | -| **IPv4 Interface** | Select the IPv4 interface for the jail from the dropdown list. | -| **IPv4 Address** | Enter the IPv4 address for [VNET(9)](https://www.freebsd.org/cgi/man.cgi?query=vnet) and shared IP jails. | -| **IPv4 Netmask** | Select the IPv4 netmask for the jail from the dropdown list. | -| **IPv6 Interface** | Select the IPv6 interface for the jail from the dropdown list. | -| **IPv6 Address** | Enter the IPv6 address for [VNET(9)](https://www.freebsd.org/cgi/man.cgi?query=vnet) and shared IP jails. | -| **IPv6 Prefix** | Select the IPv6 prefix for the jail from the dropdown list. | -| **Advanced Plugin Installation** | Opens the advanced configuration screens. This form is recommended only for advanced users with very specific requirements for a jail. | -{{< /truetable >}} - -## Advanced Plugin Installation - -The **Advanced Plugin Installation** screens include four expandable configuration areas: -* Basic Properties -* Jail Properties -* Network Properties -* Custom Properties - -Click the expand_more icon to collaspe any area of configuration settings. - -Use **Next** to advance to the next configuration settings section, or click the expand_less icon to expand the configuration settings area. - -{{< expand "Jail Basic Properties Screen" "v" >}} - -![PluginsAdvancedAddBasicProperties](/images/CORE/Plugins/PluginsAdvancedAddBasicProperties.png "Plugins Advanced Add Basic Properties") - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Plugins Name** | Displays the name of the plugin highlighed on the **Plugins** screen. This field is not editable. | -| **Name** | Required field. Enter a name that can include letters, numbers, periods (.), dashes (-), and underscores (_). | -| **DHCP Autoconfigure IPv4** | Select to auto-configure jail networking with the Dynamic Host Configuration Protocol (DHCP). Also select **VNET** and **Berkeley Packet Filter** with this selected option. | -| **NAT** | Network Address Translation (NAT) to transform local network IP addresses into a single IP address. Select when the jail shares a single connection to the Internet with other systems on the network. | -| **VNET** | Select to use [VNET(9)](https://www.freebsd.org/cgi/man.cgi?query=vnet) to emulate network devices for the jail. A fully virtualized per-jail network stack is installed. | -| **Berkeley Packet Filter** | Select to use the [Berkeley Packet Filter (BPF(4))](https://www.freebsd.org/cgi/man.cgi?query=bpf) to data-link layers in a protocol independent fashion. | -| **vnet_default_interface** | Select the default VNET interface from options on the dropdown list. Options are **none**, **auto**, or specific interfaces on your system. Only takes effect when **VNET** is selected. Choose a specific interface or set to **auto** to use the interface that has the default route. Choose **none** to not set a default VNET interface. | -| **IPv4 Interface** | Select the IPv4 interface for the jail from the dropdown list. | -| **IPv4 Address** | Enter the IPv4 address for [VNET(9)](https://www.freebsd.org/cgi/man.cgi?query=vnet) and shared IP jails. | -| **IPv4 Netmask** | Select the IPv4 netmask for the jail from the dropdown list. | -| **IPv4 Default Router** | Enter a valid IPv4 address to use as the default route. Enter **none** to configure the jail with no IPv4 default route. A jail without a default route is not be able to access any networks. | -| **AutoConfigure IPv6** | Select to use Stateless Address Auto Configuration (SLAAC) to autoconfigure IPv6 in the jail. | -| **IPv6 Interface** | Select the IPv6 interface for the jail from the dropdown list. | -| **IPv6 Address** | Enter the IPv6 address for [VNET(9)](https://www.freebsd.org/cgi/man.cgi?query=vnet) and shared IP jails. | -| **IPv6 Netmask** | Select the IPv6 prefix for the jail from the dropdown list. | -| **IPv6 Default Router** | Enter a valid IPv6 address to use as the default route. Enter **none** to configure the jail without an IPv6 default route. A jail without a default route is not be able to access any networks. | -| **Auto Start** | Select to auto-start the jail at system boot time. Jails are started and stopped based on iocage priority. Set in the **Custom Properties priority** field. | -{{< /truetable >}} -{{< /expand >}} -{{< expand "Jail Properties Screen" "v" >}} - -![PluginsAdvancedAddJailProperties](/images/CORE/Plugins/PluginsAdvancedAddJailProperties.png "Plugins Advanced Add Jail Properties") - -{{< include file="/static/includes/JailsPropertiesFields.md" markdown="true" >}} -{{< /expand >}} -{{< expand "Network Properties Screen" "v" >}} - -![PluginsAdvancedAddNetworkProperties](/images/CORE/Plugins/PluginsAdvancedAddNetworkProperties.png "Plugins Advanced Add Network Properties") - -{{< include file="/static/includes/JailNetworkPropertiesFields.md" markdown="true" >}} -{{< /expand >}} -{{< expand "Custom Properties Screen" "v" >}} - -![PluginsAdvancedAddCustomProperties](/images/CORE/Plugins/PluginsAdvancedAddCustomProperties.png "Plugins Advanced Add Custom Properties") - -{{< include file="archive/JailsCustomPropertiesFields.md" markdown="true" >}} -{{< /expand >}} diff --git a/content/CORE/UIReference/JailsPluginsVMs/VirtualMachines.md b/content/CORE/UIReference/JailsPluginsVMs/VirtualMachines.md deleted file mode 100644 index 0e41fc1f2c..0000000000 --- a/content/CORE/UIReference/JailsPluginsVMs/VirtualMachines.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: "Virtual Machines" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/jailspluginsvms/virtualmachines/virtualmachines/" -description: "Describes the fields in the Virtual Machines screen in TrueNAS CORE." -weight: 10 -tags: -- vm -- plugins ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -The Virtual Machines screen displays a list of virtual machines (VM) configured on your system. - -![VirtualMachinesScreen](/images/CORE/VirtualMachines/VirtualMachinesScreen.png "Virtual Machines") - -Use the blue **COLUMNS** button to display a list of options to customize the list view. Options are **Select All**, **Autostart**, **Virtual CPUs**, **Cores**, **Threads**, **Memory Size**, **Boot Loader Type**, **System Clock**, **VNC Port**, **Com Port**, **Description**, **Shutdown Timeout** or **Reset to Defaults**. - -Use **ADD** to display the Virtual Machines configuration Wizard. - -The **State** toggle indicates the current state of the VM. Hover over the toggle with your mouse to see the state as **STOPPED** or **RUNNING**. The toggle turns blue when it is running. - -Select the **Autostart** checkbox to set the VM to start automatically after a system reboot, or clear the checkbox to require manually starting the VM after a system reboot. - -## Virtual Machine Wizard - -The **Wizard** consists of six individual configuration screens. - -**Confirmation Options** displays the summary of settings. You can use **BACK** to return to previous screens to make changes or use **SUBMIT** to save settings and create the virtual machine. - -To make changes after saving the VM, select the VM on the list, expand it, and select **EDIT**. - -### VM Wizard Navigation -You cannot advance to the next screen if the current screen has required fields. -After entering all required information you can advance to the next screen. - -Use **Next** to advance to the next wizard configuration form. - -Use **Back** to return to a previous wizard configuration form. - -Use **Cancel** to exit the configuration wizard. - -The blue edit icons preceding each **Wizard** screen name, at the top of the screen, allow you to jump to the screen you selected but only if you have populated all required fields on the current screen and any screen that follows in the sequence of screens. -If you select a screen that follows a **Wizard** screen that has required fields and you have not provided the information those required fields wants, the screen you selected does not display. -You must enter all required fields before you can freely move around in the Wizard screens. - -{{< expand "Operating System Settings" "v" >}} - -![VMAddOperatingSystemScreen](/images/CORE/VirtualMachines/VMAddOperatingSystemScreen.png "VM Add: OS") - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Guest Operating System** | Required field. Select the VM operating system type from the dropdown list three operating systems listed **Windows**, **Linux** or **FreeBSD**. | -| **Name** | Enter an alphanumeric name for the virtual machine. | -| **Description** | (optional) Enter a description for the OS. | -| **System Clock** | Required field. Specifies the VM system time. Select from the dropdown list options **Local** or **UTC**. Default is **Local**. | -| **Boot Method** | Select from the dropdown list options **UEFI**, **UEFI-CSM** or **Grub**. Select **UEFI** for newer operating systems or **UEFI-CSM (Compatibility Support Mode)** for older operating systems that only support BIOS booting. Grub is not recommended but can be used when the other options do not work. | -| **Shutdown Timeout** | The time in seconds the system waits for the VM to cleanly shut down. During system shutdown, the system initiates power-off for the VM after the shutdown timeout expires. | -| **Start on Boot** | Select to start this VM when the system boots. | -| **Enable VNC** | Select to enable a VNC (Virtual Network Computing) remote connection. Requires UEFI booting. | -| **Delay VM Boot Until VNC Connects** | Select to wait to start VM until VNC client connects. | -| **Bind** | Required field. Select from the dropdown list options **0.0.0.0**, **::**, **::1** or the system IP addresses provided on the list. VNC network interface IP address. The primary interface IP address is the default. A different interface IP address can be chosen. | -{{< /truetable >}} -{{< /expand >}} - -{{< expand "CPU and Memory Settings" "v" >}} - -![VMAddCPUandMemoryScreen](/images/CORE/VirtualMachines/VMAddCPUandMemoryScreen.png "VM Add: CPU and Memory") - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Virtual CPUs** | Number of virtual CPUs to allocate to the virtual machine. The maximum is 16, or fewer if the host CPU limits the maximum. The VM operating system might also have operational or licensing restrictions on the number of CPUs. | -| **Cores** | Specify the number of cores per virtual CPU socket. The product of vCPUs, cores, and threads must not exceed 16. | -| **Threads** | Specify the number of threads per core. The product of vCPUs, cores, and threads must not exceed 16. | -| **Memory Size** | Allocate RAM for the VM. Minimum value is 256 MiB. This field accepts human-readable input (Ex. 50 GiB, 500M, 2 TB). If units are not specified, the value defaults to bytes. | -{{< /truetable >}} -{{< /expand >}} - -{{< expand "Disk Settings" "v" >}} - -![VMAddDisksScreen](/images/CORE/VirtualMachines/VMAddDisksScreen.png "VM Add: Disks") - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Create new disk image** | Select to create a new zvol on an existing dataset. This is used as a virtual hard drive for the VM. Select Use existing disk image to use an existing zvol or file for the VM. | -| **Select Disk Type** | Select desired disk type from the dropdown list options **AHIC** or **VirtIO**. | -| **Zvol Location** | Rerquired field. Select a dataset for the new zvol. | -| **Size** | Allocate space for the new zvol. (Examples: 500 KiB, 500M, 2 TB) MiB. Units smaller than MiB are not allowed. | -{{< /truetable >}} -{{< /expand >}} - -{{< expand "Network Interface Settings" "v" >}} - -![VMAddNetworkInterfaceScreen](/images/CORE/VirtualMachines/VMAddNetworkInterfaceScreen.png "VM Add: Network Interface") - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Adapter Type** | Required field. Select an adapter from the dropdown list. **Intel e82545 (e1000)** emulates the same Intel Ethernet card. This provides compatibility with most operating systems. **VirtIO** provides better performance when the operating system installed in the VM supports VirtIO paravirtualized network drivers. | -| **Mac Address** | Enter the desired address into the field to override the randomized MAC address. | -| **Attach NIC** | Required field. Select the physical interface to associate with the VM from the dropdown list options. | -{{< /truetable >}} -{{< /expand >}} - -{{< expand "Installation Media Settings" "v" >}} - -![VMAddInstallationMediaScreen](/images/CORE/VirtualMachines/VMAddInstallationMediaScreen.png "VM Add: Installation Media") - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Choose Installation Media Image** | Browse to the operating system installer image file. | -| **Upload an Installer Image File** | Set to display image upload options. | -{{< /truetable >}} -{{< /expand >}} - -## Individual Virtual Machine Screen -The individual virtual machine screens display the VM settings and provide optional operation buttons for that VM. -Click the icon to expand that virtual machine and access current settings and operation actions. - -![VMScreenExpanded](/images/CORE/VirtualMachines/VMScreenExpanded.png "Virtual Machine Screen") - -The following operations are available on each VM screen: - -{{< truetable >}} -| Operation | Icon | Description | -|-----------|------|-------------| -| **RESTART** | replay | Retarts the VM. | -| **POWER OFF** | power_settings_new | Powers off and halts the VM, similar to turning off a computer power switch. | -| **STOP** | | Stops a running VM. Because a virtual machine does not always respond well to **STOP** use the option to force the stop when prompted. | -| **START** | | Starts a VM. The toggle turns blue when the VM switches to running. | -| **EDIT** | mode_edit | Displays the **Virtual Machines > Edit** screen. You cannot edit a VM while it is running. You must first stop the VM and then you can edit the properties and settings. | -| **DELETE** | | Deletes a VM. You cannot delete a virtual machine that is running. You must first stop the VM and then you can delete it. | -| **DEVICES** | | Displays the list of devices for this virtual machine. | -| **CLONE** | | Makes an exact copy or *clone* of the VM that you can select and edit. A **Name** dialog displays where you can enter a name for the cloned VM. Naming the clone VM is optional. The cloned VM displays on the virtual machines list with the extension **_clone0**. If you clone the same VM again the extension for the second clone is **clone1**. | -| **VNC** | | Opens a **noVNC** window that allows you to connect to a VNC client. | -| **SERIAL** | | Opens the shell. | -{{< /truetable >}} - -{{< hint type=note >}} -The **STOP** button and the system **State** toggle both try to send an ACPI power-down command to the VM operating system. Sometimes the commands time out, so it is better to use the **POWER OFF** button instead. -{{< /hint >}} diff --git a/content/CORE/UIReference/JailsPluginsVMs/_index.md b/content/CORE/UIReference/JailsPluginsVMs/_index.md deleted file mode 100644 index 9eb1fadcf4..0000000000 --- a/content/CORE/UIReference/JailsPluginsVMs/_index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Jails, Plugins and Virtual Machines" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/jailspluginsvms/" -description: "Reference documentation for the Jails, Plugins, and Virtual Machines screens." -geekdocCollapseSection: true -weight: 130 -related: false ---- - -{{< hint type=important title="Unsupported Feature" >}} -{{< include file="/static/includes/COREFeatureSupport.md" >}} -{{< /hint >}} - -This section describes the various screens and options available for deploying resource-minimal FreeBSD jails or fully virtualized operating systems. - -
- -## Jails, Plugins, and Virtual Machine Contents - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/UIReference/Network/GlobalConfigScreen.md b/content/CORE/UIReference/Network/GlobalConfigScreen.md deleted file mode 100644 index 62df946591..0000000000 --- a/content/CORE/UIReference/Network/GlobalConfigScreen.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -title: "Global Configuration Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/network/globalconfigscreen/" -description: "Describes how to use the Global Configuration screen in TrueNAS CORE." -weight: 20 -aliases: /core/network/globalconfig/ -tags: -- network ---- - -The **Network > Global Configuration** screen has all the general TrueNAS networking settings that *are not* specific to any [interface]({{< relref "/CORE/UIReference/Network/InterfacesScreen.md" >}}). - -{{< hint type=warning >}} -**Disruptive Change** - -Making changes to the network interface the web interface uses can result in losing connection to TrueNAS! -Fixing any misconfigured network settings might require command line knowledge or physical access to the TrueNAS system. -{{< /hint >}} - -## Global Configuration Settings - -![NetworkGlobalConfigurationScreen](/images/CORE/Network/NetworkGlobalConfigurationScreen.png "Network Global Configuration Screen") - -Options are organized into several categories. - -{{< expand "Can these options be configured elsewhere?" "v" >}} -Many of these interface, DNS, and gateway options are also configured in the [Console Setup Menu]({{< relref "CORE/GettingStarted/ConsoleSetupMenu.md" >}}). -Be sure to check both locations when troubleshooting network connectivity issues. -{{< /expand >}} - -### Hostname and Domain - -Many of these fields have default values you can change to meet requirements of the local network. -The **Hostname** and **Domain** field values display on the **Dashboard > System Information** card. -Some options only display when the appropriate hardware is present. - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Hostname** | Enter the system host name. If an Enterprise system with two controllers, this is the first TrueNAS controller host name. Upper and lower case alphanumeric, (.) and (-) characters are allowed. | -| **Hostname (TrueNAS Controller 2)** | Enter the host name of second TrueNAS controller (for HA only). Upper and lower case alphanumeric, (.) and (-) characters are allowed. | -| **Hostname (Virtual)** | Enter the virtual host name. When using a virtual host, this is also used as the Kerberos principal name. Enter the fully qualified host name plus the domain name. Upper and lower case alphanumeric, (.) and (-) characters are allowed. | -| **Domain** | Enter the system domain name. | -| **Additional Domains** | Enter additional domains to search. Separate entries by pressing Enter. Adding search domains can cause slow DNS lookups | -{{< /truetable >}} - -### Service Announcement - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **NetBIOS-NS** | Select to advertise the SMB service NetBIOS name. Legacy NetBIOS name server. Can be required for legacy SMB1 clients to discover the server. When advertised, the server appears in Network Neighborhood. | -| **mDNS** | Select to use the system host name (in **Hostname**) to advertise enabled and running services. Multicast DNS. For example, this controls if the server appears under **Network** on MacOS clients.| -| **WS-Discovery** | Select to use the SMB Service **NetBIOS Name** to advertise the server to WS-Discovery clients. This causes the computer to appear in the **Network Neighborhood** of modern Windows OSes. | -{{< /truetable >}} - -### DNS Servers - -{{< truetable >}} -| Setting |Description | -|---------|-------------| -| **Nameserver 1** | Enter the primary DNS server IP address. | -| **Nameserver 2** | Enter the secondary DNS server IP address. | -| **Nameserver 3** | Enter the tertiary DNS server IP address. | -{{< /truetable >}} - -### Default Gateway - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **IPv4 Default Gateway** | Enter the IP address to use instead of the default gateway provided by DHCP for IPv4 service. Typically not set. | -| **IPv6 Default Gateway** | Enter the IP address to use instead of the default gateway provided by DHCP for IPv6 service. Typically not set. | -{{< /truetable >}} - -### Other Settings - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **HTTP Proxy** | Enter the proxy information for the network in the format http://*my.proxy.server:3128* or http://*user:password@my*.*proxy.server:3128*. | -| **Enable Netwait Feature** | Select to prevents network services from starting until the interface can ping the addresses listed in the **Netwait IP list**. | -| **Netwait IP List** | Select only appears when **Enable Netwait Feature** is set. Enter a list of IP addresses to ping. Separate entries by pressing Enter. Each address is tried until one is successful or the list is exhausted. Leave empty to use the default gateway. | -| **Host Name Database** | Enter the database host name. Used to add one entry per line which is appended to /etc/hosts. Separate entries by pressing Enter. Use the format *IP_address space hostname* where multiple host names can be used if separated by a space. Hosts defined here are still accessible by name even when DNS is not available. See hosts for additional information. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/Network/IPMIScreen.md b/content/CORE/UIReference/Network/IPMIScreen.md deleted file mode 100644 index a2af038953..0000000000 --- a/content/CORE/UIReference/Network/IPMIScreen.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "IPMI Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/network/ipmiscreen/" -description: "Describes the fields on the IPMI screen in TrueNAS CORE." -weight: 50 -tags: -- ipmi -- network -- interfaces ---- - -Use the **Network > IPMI** screen to configure the TrueNAS for an IPMI connection. The IPMI configuration screen provides a shortcut to the most basic IPMI configuration. - -![NetworkIPMIScreen](/images/CORE/Network/NetworkIPMIScreen.png "Network IPMI Screen") - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **TrueNAS Controller** | Select a TrueNAS controller from the dropdown list. All IPMI changes are applied to that TrueNAS controller. | -| **Channel** | Select the communications channel to use from the dropdown list. Available channel numbers vary by hardware. | -| **Password** | Enter a password for connecting to the IPMI interface from a web browser. The password must include at least one upper case letter, one lower case letter, one digit, and one special character (punctuation, e.g. ! # $ %, etc.). It must also be 8-16 characters long. | -| **DHCP** | Select to use DHCP to set the IPv4 Address, IPv4 Netmask, and Ipv4 Default Gateway. If checkbox is clear you must manually enter these settings. | -| **IPv4 Address** | Enter the static IP address of the IPMI web interface. This is the address TrueNAS connects to when you click the **MANAGE** button. | -| **IPv4 Netmask** | Enter the subnet mask associated with the IP address. | -| **IPv4 Default Gateway** | Enter the default gateway of the IPv4 connection. This is associated with the IP address. | -| **VLAN ID** | Enter the VLAN identifier if the IPMI out-of-band management interface is not on the same VLAN as management networking. | -| **IDENTIFY LIGHT** | Displays a dialog to activate an IPMI identify light on the compatible connected hardware. | -| **MANAGE** | Connects the TrueNAS to the IPMI web interface login screen. | -{{< /truetable >}} - -Use **SAVE** to save the IPMI settings. - -See [IPMI]({{< relref "/CORE/CORETutorials/Network/IPMI.md" >}}) for more information. diff --git a/content/CORE/UIReference/Network/InterfacesScreen.md b/content/CORE/UIReference/Network/InterfacesScreen.md deleted file mode 100644 index 22d7125e18..0000000000 --- a/content/CORE/UIReference/Network/InterfacesScreen.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -title: "Interfaces Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/network/interfacesscreen/" -description: "Describes the fields in the Network Interface screen on TrueNAS CORE." -weight: 10 -tags: -- network -- interfaces ---- - -Use the **Network > Interface** Screen to add various network interfaces to your TrueNAS. - -![NetworkInterfacesScreen](/images/CORE/Network/NetworkInterfacesScreen.png "Network Interfaces Screen") - -Use the **COLUMNS** button to display options to modify the information displayed in the **Interfaces** table. Options are **Type**, **Link State**, **DHCP**, **IPv6 Auto Configure**, **IP Addresses**, **Description**, **Active Media Type**, **Active Media Subtype**, **VLAN Tag**, **VLAN Parent Interface**, **Bridge Members**, **LAGG Ports**, **LAGG Protocol**, **MAC Address**, **MTU** or **Reset to Defaults**. - -Use **ADD** to display the [**Interface Add**](#interface-add-screen) screen. - -To see the details for any interface click the chevron_right symbol to the right of the interface. - -## Interface Detail Screen -Each interface has a detailed view with the current interface settings and additional actions available for the interface. - -![NetworkInterfaceDetailsScreen](/images/CORE/Network/NetworkInterfaceDetailsScreen.png "Network Interface Details Screen") - -Use **EDIT** to display the [**Network Interface Edit**](#interface-edit-screen) screen. Several settings are not editable and do not appear on the **Edit** screen. - -Use **RESET CONFIGURATION** to reset the selected interface. Resetting the configuration interrupts network connectivity. The **Reset Configuration** dialog displays. You must select **Confirm** to activate the **RESET CONFIGURATION** button. - -## Interface Add Screen - -The **Interface Add** screen displays additional configuration settings based on the type of interface selected. - -![NetworkInterfaceAddScreen](/images/CORE/Network/NetworkInterfaceAddScreen.png "Network Interface Add Screen") - -**Interface Settings** - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **Type** | Select the type of interface from the dropdown list. Select **Bridge** to create a logical link between mutliple networks. Select **Link Aggregation** to combine multiple network connections into a single interface. Select **VLAN** for a virtual LAN to partition and isolate a segment of the connection. | -| **Name** | Enter a name for the interface. Use the format **bridge***X* **lagg***X* or **vlan***X* where *X* is a number representing a non-parent interface. | -| **Description** |Enter a description for the interface. For example, what it is used for. | -| **DHCP** | Select to enable DHCP. Leave checkbox clear to crate a static IPv4 or IPv6 configuration. Only one interface can be configured for DCHP. | -| **Autoconfigure IPv6** | Select to automatically configure the IPv6 address with [rtsol(8)](https://www.freebsd.org/cgi/man.cgi?query=rtsol). Only one interface can be configured this way. | -{{< /truetable >}} - -**Other Settings** - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **Disable Hardware Offloading** | Select to turn off hardware offloading for network traffice processing. Warning! Disabling hardware offloading can reduce network performance, and is only recommended when the interface is managing jails, plugins or virtual machines. | -| **MTU** | A maximum transmission unit (MTU) is the largest protocol data unti that can be communicated. The largest workable MTU size varies with network interfaces and equipment. 1500 and 9000 are standard Ethernet MTU sizes. Leave blank restores this field to the default value of **1500**. | -| **Options** | Enter additional parameters from [ifconfig(8)](https://www.freebsd.org/cgi/man.cgi?query=ifconfig). | -{{< /truetable >}} - -**Other Settings** - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **IP Addresses** | Select an IP address from the dropdown list to define an alias for the interface on this TrueNAS controller. The alias can be an IPv4 or IPv6 address. | -| **ADD** | Adds a row to configure another IP address. A **DELETE** button displays to allow you to delete the extra IP address. | -{{< /truetable >}} - -**Bridge Settings** - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **Bridge Members** | Select network interfaces to include in the bridge from the dropdown list. | -{{< /truetable >}} - -**Link Aggreation Settings** - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **Lagg Protocol** | Select the lagg protocol from the dropdown list. This determines the outgoing and incoming traffic ports. **LACP** is the recommended protocol if the network switch is capable of active LACP. **Failover** is the default protocol choice and should be used if the network switch does not support active LACP. See [lagg(4)](https://www.freebsd.org/cgi/man.cgi?query=lagg) for more details. | -| **Lagg Interfaces** | Select the interfaces on your TrueNAS to use in the aggregation from the dropdown list. Warning! Lagg creation fails if any of the selected interfaces have been manually configured. | -{{< /truetable >}} - -**VLAN Settings** - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **Parent Interface** | Select the VLAN parent interface on your TrueNAS from the dropdown list. Usually Ethernet card connected to a switch port configured for the VLAN. New link aggregations are not available until the system is restared. | -| **Vlan Tag** | Enter the numeric tag configured in the switched network. This is a required field. | -| **Priority Code Point** | Select the [Class of Service](https://tools.ietf.org/html/rfc4761#section-4.2.7) from the dropdown list. The available 802.1p class of service ranges from **Best effort (default) to **Network control (highest)**. | -{{< /truetable >}} - -## Interface Edit Screen - -The **Interface Edit** screen displays only the editable configuration settings for the inface selected. - -![NetworkInterfacesEditScreen](/images/CORE/Network/NetworkInterfacesEditScreen.png "Network Interfaces Edit Screen") - -**Interface Settings** - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **Name** | Displays the name for the selected interface. This field cannot be edited. | -| **Description** |Enter a description for the interface. For example, what it is used for. | -| **DHCP** | Select to enable DHCP. Leave checkbox clear to crate a static IPv4 or IPv6 configuration. Only one interface can be configured for DCHP. | -| **Autoconfigure IPv6** | Select to automatically configure the IPv6 address with [rtsol(8)](https://www.freebsd.org/cgi/man.cgi?query=rtsol). Only one interface can be configured this way. | -{{< /truetable >}} - -**Other Settings** - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **Disable Hardware Offloading** | Select to turn off hardware offloading for network traffic processing. Warning! Disabling hardware offloading can reduce network performance, and is only recommended when the interface is managing jails, plugins, or virtual machines. | -| **MTU** | A maximum transmission unit (MTU) is the largest protocol data unti that can be communicated. The largest workable MTU size varies with network interfaces and equipment. 1500 and 9000 are standard Ethernet MTU sizes. Leave blank restores this field to the default value of **1500**. | -| **Options** | Enter additional parameters from [ifconfig(8)](https://www.freebsd.org/cgi/man.cgi?query=ifconfig). | -{{< /truetable >}} - -**Other Settings** - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **IP Addresses** | Select an IP address from the dropdown list to define an alias for the interface on this TrueNAS controller. The alias can be an IPv4 or IPv6 address. | -| **ADD** | Adds a row to configure another IP address. A **DELETE** button displays to allow you to delete the extra IP address. | -{{< /truetable >}} - -Use **APPLY** to save changes to settings and return to the **Interfaces** screen. diff --git a/content/CORE/UIReference/Network/NetworkSummaryScreen.md b/content/CORE/UIReference/Network/NetworkSummaryScreen.md deleted file mode 100644 index cc4c5873b4..0000000000 --- a/content/CORE/UIReference/Network/NetworkSummaryScreen.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "Network Summary Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/network/networksummaryscreen/" -description: "Describes the fields in the Network Summary screen in TrueNAS CORE." -weight: 10 -aliases: - - /core/network/networksummary/ - - /core/uireference/network/networksummary/ -tags: -- network -- interfaces ---- - -It is recommended to set up your system connections before setting up data sharing. -This allows integrating TrueNAS into your specific security and network environment before attempting to store or share critical data. - -## Network Summary - -The Network Summary gives a concise overview of the current network setup. -Information about the currently active **Interfaces**, **Default Routes**, and **Nameservers** is provided. -These areas are not editable. - -![**NetworkSummaryScreen**](/images/CORE/Network/NetworkSummaryScreen.png "Network Summary Screen") - -* [**Interfaces**]({{< relref "/CORE/UIReference/Network/InterfacesScreen.md" >}}) shows any configured physical [bridge]({{< relref "/CORE/CORETutorials/Network/Interfaces/BridgeCreate.md" >}}), [LAGG]({{< relref "/CORE/CORETutorials/Network/Interfaces/LAGGCreate.md" >}}), and [vlan]({{< relref "/CORE/CORETutorials/Network/Interfaces/VLANCreate.md" >}}) interfaces. -All detected physical interfaces are listed, even when unconfigured. -The IPv4 or IPv6 address displays when a [static IP]({{< relref "/CORE/CORETutorials/Network/Interfaces/SettingStaticIP.md" >}}) is saved for an interface. - -* **Default Routes** lists all saved TrueNAS Default Routes. - Go to **Network > Global Configuration** to configure Default Routes. - -* **Nameservers** lists any configured DNS name servers that TrueNAS uses. To change this list, go to **Network > Global Configuration**. - The TrueNAS **Hostname and Domain**, **Default Gateway**, and other options are available in **Network > Global Configuration**. - -## Additional Network Configuration Screens - -Define any Static Routes in **Network > [Static Routes]({{< relref "/CORE/UIReference/Network/StaticRoutesScreen.md" >}})**. - -Out-of-band management is managed from **Network > [IPMI]({{< relref "/CORE/CORETutorials/Network/IPMI.md" >}})**. This option is visible only when TrueNAS detects the appropriate physical hardware. diff --git a/content/CORE/UIReference/Network/StaticRoutesScreen.md b/content/CORE/UIReference/Network/StaticRoutesScreen.md deleted file mode 100644 index 7e9ad69dd2..0000000000 --- a/content/CORE/UIReference/Network/StaticRoutesScreen.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Static Routes Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/network/staticroutesscreen/" -description: "Describes the Static Routes screen in TrueNAS CORE." -weight: 40 -tags: -- staticroutes -- network -- interfaces ---- - -Use the **Network Static Routes** screen to define static routes on your TrueNAS. By default, no static routes are defined on a default TrueNAS system. - -![NetworkStaticRoutesScreen](/images/CORE/Network/NetworkStaticRoutesScreen.png "Network Static Routes Screen") - -Use the blue **Columns** button to display options to change the information displayed in the **Static Routes** table. Options are **Unselect All**, **Gateway**, **Description** or **Reset to Defaults**. - -Use **Add** to dispay the **Static Routes Add** screen. - -## Static Route Add Screen - -![StaticRouteAddScreen](/images/CORE/Network/StaticRouteAddScreen.png "Static Route Add Screen") - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Destination** | Enter the desination IP using the format *A.B.C.D/E* where *E* is the CIDR mask. | -| **Gateway** | Enter the IP address of the gateway. | -| **Description** | Enter any notes or identifiers describing the static route. | -{{< /truetable >}} - -The **SUBMIT** button activates after entering values in the required fields. Use **CANCEL** to exit without saving and retun to the **Static Routes** screen. diff --git a/content/CORE/UIReference/Network/_index.md b/content/CORE/UIReference/Network/_index.md deleted file mode 100644 index 4c6b62e3fa..0000000000 --- a/content/CORE/UIReference/Network/_index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Network" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/network/" -description: "Reference documentation of the various Network menu screens." -geekdocCollapseSection: true -weight: 80 -related: false ---- - -The TrueNAS CORE **Network** screens control how the system integrates into the overall network environment. - -
- -## Network Contents - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/UIReference/ReportingGraphs.md b/content/CORE/UIReference/ReportingGraphs.md deleted file mode 100644 index 168c2feba7..0000000000 --- a/content/CORE/UIReference/ReportingGraphs.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -title: "Reporting" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/reportinggraphs/" -description: "Contains information about the graphs displayed on the Reporting screen in TrueNAS CORE." -weight: 135 -Aliases: /core/system/reporting/ -tags: -- reporting ---- - -The **Reporting** screen displays graphs of system information for CPU, disk, memory, network, NFS, partition, target, UPS, ZFS and system functions. - -{{< expand "What does TrueNAS use for reporting?" "v" >}} -TrueNAS uses [Graphite](https://graphiteapp.org/ "Graphite Homepage") for metric gathering and visualizations. - -TrueNAS uses [collectd](https://collectd.org/) to provide reporting statistics. -{{< /expand >}} - -Reporting data is saved to permit viewing and monitoring usage trends over time. -This data is preserved across system upgrades and restarts. - -Data files are saved in /var/db/collectd/rrd/. - -{{< hint type=important >}} -Because reporting data is frequently written it should not be stored on the boot pool or operating system device. -{{< /hint >}} - -![ReportingScreenDisplayOptions](/images/CORE/Reporting/ReportingScreenDisplayOptions.png "Reporting Screen Display Options") - -## Reporting Screen Display Options - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **CPU** | Displays the **CPU Temperature**, **CPU Usage**, and **System Load** graphs. | -| **Disk** | Displays graphs for each disk in the system. | -| **Memory** | Displays both the **Physical memory utilization** and **Swap utilization** graphs. | -| **Network** | Displays an **Interface Traffic** graph for each interface in the system. | -| **NFS** | Displays the **NFS Stats (Operations)** and **NFS Stats (Byptes)** graphs. | -| **Partition** | Displays graphs showing disk space allocations. | -| **System** | Displays both the **Processes** and **Uptime** graphs. | -| **Target** | Displays graphs only for systems with iSCSI ports configured and shows the bandwidth statistics for iSCSI ports. | -| **UPS** | Displays the graphs only if the system is configured for and uses a UPS. | -| **ZFS**| Displays the **ARC Size**, **ARC Hit Ratio**, **ARC Requests demand_data**, **ARC Requests demand_metadata**, **ARC Requests prefetch_data**, and **ARC Requests prefetch_metadata** graphs with the Arc and L2 gigabytes and hits (%), and the hits, misses and total number of requests. | -{{< /truetable >}} - -## Interacting with Graphs - -Click on and drag a certain range of the graph to expand the information displayed in that selected area in the Graph. -Click on the icon to zoom in on the graph. -Click on the icon to zoom out on the graph. -Click the to move the graph forward. -Click the to move the graph backward. - -## Graphs -{{< expand "CPU Graphs" "v" >}} -[CPU](https://collectd.org/wiki/index.php/Plugin:CPU) graphs shows the amount of time spent by the CPU in various states such as executing user code, executing system code, and being idle. -Graphs of short-, mid-, and long-term load are shown, along with CPU temperature graphs. - -![ReportingCPUTab](/images/CORE/Reporting/ReportingCPUTab.png "CPU Reporting") - -{{< /expand >}} -{{< expand "Disk Graphs" "v" >}} -[Disk](https://collectd.org/wiki/index.php/Plugin:Disk)graphs shows read and write statistics on I/O, percent busy, latency, operations per second, pending I/O requests, and disk temperature. -Use the **Devices** dropdown list to select one or all system disks for which you want to display a graph. Use the **Metrics** dropdown list to select one or all disk measurements to display. - -![ReportingDisksTab](/images/CORE/Reporting/ReportingDisksTab.png "Disks Reporting") - -### Disk Metrics Options - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Select All** | Displays all available graphs for any or all disks selected on the **Devices** dropdown list. | -| **Disk Temperature** | Diplays the minimum, maximum and mean temperature reading for the disk selected. | -| **Disk Busy** | Displays the percent the selected disk is busy. | -| **Disk Latency** | Displays the disk latency in time (msec) for read, write and delete operations. | -| **Disk Operations detailed** | Displays the read, write and delete operations for the selected disk. | -| **Pending I/O** | Displays then length of pending I/O requests for the selected disk. | -| **Disk I/O** | Displays the disk read and write I/O stats in bytes/s. | -{{< /truetable >}} - -{{< hint type=important >}} -Temperature monitoring for the disk is disabled if **HDD Standby** is enabled. Check the **Storage > Disks** **Edit Disk*** configuration form for any or all disks in the system if you do not see the temperature monitoring graph. -{{< /hint >}} -{{< /expand >}} -{{< expand "Memory Graphs" "v" >}} -[Memory](https://collectd.org/wiki/index.php/Plugin:Memory) graphs display memory usage and [swap](https://collectd.org/wiki/index.php/Plugin:Swap) graphs display the amount of free and used swap space. - -![ReportingMemoryTab](/images/CORE/Reporting/ReportingMemoryTab.png "Memory Reporting") - -{{< /expand >}} -{{< expand "Network Graphs" "v" >}} -[Network](https://collectd.org/wiki/index.php/Plugin:Interface) graphs report received and transmitted traffic in megabytes per second for each configured interface. - -![ReportingNetworkTab](/images/CORE/Reporting/ReportingNetworkTab.png "Network Reporting") - -{{< /expand >}} -{{< expand "NFS Graphs" "v" >}} -[NFS](https://collectd.org/wiki/index.php/Plugin:NFS) graphs show information about the number of procedure calls for each procedure and whether the system is a server or client. - -![ReportingNFSTab](/images/CORE/Reporting/ReportingNFSTab.png "NFS Reporting") - -{{< /expand >}} -{{< expand "Partition Graphs" "v" >}} - -[Partition](https://collectd.org/wiki/index.php/Plugin:DF) graphs displays free, used, and reserved space for each pool and dataset. However, the disk space used by an individual zvol is not displayed as it is a block device. - -![ReportingPartitionTab](/images/CORE/Reporting/ReportingPartitionTab.png "Partition Reporting") - -{{< /expand >}} -{{< expand "System Graphs" "v" >}} -[System](https://collectd.org/wiki/index.php/Plugin:Processes) graphs displays the number of processes. It is grouped by state. - -![ReportingSystemTab](/images/CORE/Reporting/ReportingSystemTab.png "System Reporting") - -{{< /expand >}} -{{< expand "Target Graphs" "v" >}} - -![ReportingTargetTab](/images/CORE/Reporting/ReportingTargetTab.png "iSCSI Target Reporting") - -{{< /expand >}} -{{< expand "UPS Graphs" "v" >}} -[UPS](https://collectd.org/wiki/index.php/Plugin:NUT) graphs show statistics about an uninterruptible power supply (UPS) using [Network UPS tools](https://networkupstools.org/). Statistics include voltages, currents, power, frequencies, load, and temperatures. - -![ReportingUPSTab](/images/CORE/Reporting/ReportingUPSTab.png "UPS Reporting") - -{{< /expand >}} -{{< expand "ZFS Graphs" "v" >}} -[ZFS](https://collectd.org/wiki/index.php/Plugin:ZFS_ARC) graphs shows compressed physical ARC size, hit ratio, demand data, demand metadata, and prefetch data. - -![ReportingZFSTab](/images/CORE/Reporting/ReportingZFSTab.png "ZFS Reporting") - -{{< /expand >}} diff --git a/content/CORE/UIReference/Services/AFPScreen.md b/content/CORE/UIReference/Services/AFPScreen.md deleted file mode 100644 index 1f8f8de8a4..0000000000 --- a/content/CORE/UIReference/Services/AFPScreen.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "AFP Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/afpscreen/" -description: "Describes the AFP screen in TrueNAS CORE." -weight: 10 -tags: -- afp ---- - -The Apple Filing Protocol (AFP) is a network protocol that allows file sharing over a network. -It is like SMB and NFS, but it is for Apple systems. - -{{< hint type=important >}} -Apple began using the SMB sharing protocol as the default option for file sharing in 2013. At that time Apple ceased development of the AFP sharing protocol. The recommendation is to use SMB sharing instead of AFP. AFP sharing is still used if files are being shared with legacy Apple products. Please see https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/APFS_Guide/FAQ/FAQ.html -{{< /hint >}} - -Use the **Services AFP** screen to configure Apple Filing Protocol (AFP) service on your TrueNAS. - -![Services AFP Edit](/images/CORE/Services/ServicesAFPEdit.png "Services AFP Edit") - -Click **SAVE** to save settings. - -Click **CANCEL** to exit without saving and return to the **Services** screen. - -**General Option** - -{{< truetable >}} -| Name | Description | -|----------|-------------| -| **Database Path** | The database information stored in the path. If the pool has read-only status, the path must still be writable. | -{{< /truetable >}} - -**Access** - -{{< truetable >}} -| Name | Description | -|----------|-------------| -| **Guest Account** | Select an account to use for guest access. This account must have permissions to the shared pool or dataset. Any client connecting to the guest service has the privileges of the guest account user. This user must exist in the password file, but does not need a valid login. Root user cannot be the guest account. | -| **Guest Access** | Select to disable the password prompt that displays before clients access AFP shares. | -| **Max Connections** | Maximum number of simultaneous connections permitted via AFP. The default limit is **50**. | -| **Chmod Request** | Indicates how to handle access control lists. Select **Ignore** to disregard requests. Selecting **Ignore** also gives the parent directory ACL inheritance full control over new items. Select **Preserve** to preserve ZFS ACEs for named users and groups or the POSIX ACL group mask. Select **Simple** to configure chmod() as requested without any extra steps. | -| **Map ACLs** | Maps permissions for authenticated users. Select **Rights** (default, Unix-style permissions), **None**, or **Mode (ACLs)**. | -{{< /truetable >}} - -**Other Options** - -{{< truetable >}} -| Name | Description | -|----------|-------------| -| **Log Level** | Record AFP service messages up to the specified log level in the system log. The system logs severe and warning level messages by default. | -| **Bind Interfaces** | Specify the IP addresses to listen for AFP connections. Leave blank to bind to all available IPs. If no IP addresses specified, advertise the first IP address of the system. If no IP addresses specified, listen for any incoming request. | -| **Global Auxiliary** | Additional [afp.conf(5)](https://netatalk.sourceforge.net/3.0/htmldocs/afp.conf.5.html) parameters. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/Services/DynamicDNSScreen.md b/content/CORE/UIReference/Services/DynamicDNSScreen.md deleted file mode 100644 index 43b5376445..0000000000 --- a/content/CORE/UIReference/Services/DynamicDNSScreen.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Dynamic DNS Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/dynamicdnsscreen/" -description: "Describes the DDNS screen in TrueNAS CORE." -weight: 20 -aliases: core/services/dynamicdns/ -tags: -- ddns ---- - -ISPs often change the IP address of the system. With [Dynamic Domain Name Service (DDNS)](https://tools.ietf.org/html/rfc2136) the current IP address continues to point to a domain name. This provides uninterrupted access to TrueNAS. - -![ServicesDynamicDNSOptions](/images/CORE/Services/ServicesDynamicDNSOptions.png "Dynamic DNS Service Options") - -{{< include file="/static/includes/ServicesDynamicDNSFields.md" markdown="true" >}} - -The **SAVE** button activates after you enter your domain name in **Domain Name**. Click to save all settings. - -After configuring your DDNS service, turn the service on using the **Services** screen. diff --git a/content/CORE/UIReference/Services/FTPScreen.md b/content/CORE/UIReference/Services/FTPScreen.md deleted file mode 100644 index 615eeca4ea..0000000000 --- a/content/CORE/UIReference/Services/FTPScreen.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: "FTP Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/ftpscreen/" -description: "Describes the FTP screen in TrueNAS CORE." -weight: 30 -tags: -- ftp ---- - -File Transfer Protocol (FTP) is a communication protocol. It transfers data across a computer network. Configure FTP service settings on TrueNAS using the **FTP** services screen. - -![FTPBasicOption](/images/CORE/Services/FTPBasicOption.png "Services FTP Basic Options") - -After making changes to settings click **SAVE** to confirm and save your changes. - -Click **ADVANCED OPTIONS** to display advanced settings options. Click **BASIC OPTIONS** to return to the basic settings options. - -Click **CANCEL** to exit without saving. - -## General Options Settings - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Port** | Enter the port the FTP service listens on. | -| **Clients** | Enter the maximum number of simultaneous clients. | -| **Connections** | Enter the maximum number of connections per IP address. **0** is unlimited. | -| **Login Attempts** | Enter the greatest number of attempts client permitted before disconnect. Increase if users are prone to misspellings or typos. | -| **Timeout** | Enter the maximum client idle time in seconds before disconnect. Default value is **600** seconds. | -| **Certificate** | Select from the dropdown list the SSL certificate to use for TLS FTP connections. Currently listed as **freenas_default**. To create a certificate, go to **System > Certificates**. | -{{< /truetable >}} - -## Advanced Option Settings - -Click **Advanced Options** if you need to customize your FTP service. **Advanced Options** are more detailed than the **Basic Options** settings. - -### Access and TLS Settings - -![FTPAdvancedOptionsAccessTLS](/images/CORE/Services/FTPAdvancedOptionsAccessTLS.png "Services FTP Advanced Options Access and TLS") - -**Access Settings** - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Always Chroot** | Select to only allow users access their home directory if they are in the **wheel** group. This option increases security risk. | -| **Allow Root Login** | Select to allow root logins. Selecting this option increases security risk. Not recommended. | -| **Allow Anonymous Login** | Select to allow anonymous FTP logins with access to the directory specified in *Path*. | -| **Allow Local User Login** | By default, only members of the *ftp* group can to log in. Select this checkbox to allow any local user to log in. | -| **Require IDENT Authentication** | Select to require IDENT authentication. Selecting this option results in timeouts when ident (or in shell `identd`) is not running on the client. | -| **File Permissions** | Select to define default permissions for newly created files. | -| **Directory Permissions** | Select to define default permissions for newly created directories. | -{{< /truetable >}} - -**TLS Settings** - -{{< hint type=important >}} -Unless necessary, do not allow anonymous or root access. -For better security, enable TLS when possible. -This is effectively [FTPS](https://tools.ietf.org/html/rfc4217). -When FTP is exposed to a WAN, enable TLS. -{{< /hint >}} - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Enable TLS** | Select to allow encrypted connections. Requires a certificate. To create or import a certificate go to **System > Certificates**. | -| **TLS Policy** | Select the policy from the dropdown list of options. Options are **On**, **Off**, **Data**, **!Data**, **Auth**, **Ctrl**, **Ctrl + Data**, **Ctrl +!Data**, **Auth + Data** or **Auth +!Data**. Defines whether the control channel, data channel, both channels, or neither channel of an FTP session must occur over SSL/TLS. The policies are described [here](http://www.proftpd.org/docs/howto/TLS.html). | -| **TLS Allow Client Renegotiations** | Select to allow client renegotiation. This option is not recommended. Selecting this option breaks several security measures. See [mod_tls](http://www.proftpd.org/docs/contrib/mod_tls.html) for details. | -| **TLS Allow Dot Login** | If selected, TrueNAS checks the user home directory for a .tlslogin file. This file must contain one or more PEM-encoded certificates. System prompts user for password authentication if file not found. | -| **TLS Allow Per User** | If selected, allows sending a user password unencrypted. | -| **TLS Common Name Required** | Select to require the common name in the certificate match the FQDN of the host. | -| **TLS Enable Diagnostics** | Select to make logs more verbose. Useful in troubleshooting a connection. | -| **TLS Export Certificate Data** | Select to export the certificate environment variables. | -| **TLS No Certificate Request** | Select if the client cannot connect due to a problem with the certificate request. Example: the client server is unable to handle the server certificate request. | -| **TLS No Empty Fragments** | Not recommended. This option bypasses a security mechanism. | -| **TLS No Session Reuse Required** | This option reduces connection security. Only select if the client does not understand reused SSL sessions. | -| **TLS Export Standard Vars** | Select to put in place several environment variables. | -| **TLS DNS Name Required** | Select to require the client DNS name resolve to its IP address, and the cert contain the same DNS name. | -| **TLS IP Address Required** | Select to require the client certificate IP address match the client IP address. | -{{< /truetable >}} - -### Bandwidth and Other Settings - -![FTPAdvancedOptionsBandwidthOther](/images/CORE/Services/FTPAdvancedOptionsBandwidthOther.png "Services FTP Advanced Options Bandwidth and Other") - -**Bandwitdth Settings** - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Local User Upload Bandwidth: (Examples: 500 KiB, 500M, 2 TB)** | Enter a value. If measurement is not specified it defaults to KiB. This field accepts human-readable input in KiBs or greater (M, GiB, TB, etc.). The unlimited default is **0 KiB**. | -| **Local User Download Bandwidth** | Enter a value. If measurement is not specified it defaults to KiB. This field accepts human-readable input in KiBs or greater (M, GiB, TB, etc.). The unlimited default is **0 KiB**. | -| **Anonymous User Upload Bandwidth** | Enter a value. If measurement is not specified it defaults to KiB. This field accepts human-readable input in KiBs or greater (M, GiB, TB, etc.). The unlimited default is **0 KiB**. | -| **Anonymous User Download Bandwidth** | Enter a value. If measurement is not specified it defaults to KiB. This field accepts human-readable input in KiBs or greater (M, GiB, TB, etc.). The unlimited default is **0 KiB**. | -{{< /truetable >}} - -**Other Options Settings** - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Minimum Passive Port** | Used by clients in PASV mode. A default of **0** means any port above 1023. | -| **Maximum Passive Port** | Used by clients in PASV mode. A default of **0** means any port above 1023. | -| **Enable FXP** | Select to enable the File eXchange Protocol (FXP). Not recommended as this leaves the server vulnerable to FTP bounce attacks. | -| **Allow Transfer Resumption** | Select to allow FTP clients to resume interrupted transfers. | -| **Perform Reverse DNS Lookups** | Select to allow performing reverse DNS lookups on client IPs. Causes long delays if reverse DNS isn't configured. | -| **Masquerade Address** | Public IP address or host name. Select if FTP clients cannot connect through a NAT device. | -| **Display Login** | Specify the message displayed to local login users after authentication. This is not displayed to anonymous login users. | -| **Auxiliary Parameters** | Select to add additional [proftpd(8](https://linux.die.net/man/8/proftpd) parameters. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/Services/LLDPScreen.md b/content/CORE/UIReference/Services/LLDPScreen.md deleted file mode 100644 index 4d095452a1..0000000000 --- a/content/CORE/UIReference/Services/LLDPScreen.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "LLDP Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/lldpscreen/" -description: "Describes the LLDP screen in TrueNAS CORE." -weight: 50 -tags: -- network ---- - -Network devices often use Link Layer Discovery Protocol (LLDP) to communicate information. This information includes their identities, abilities and peers on a LAN. The LAN is typically wired Ethernet. The TrueNAS **LLDP** services screen configures LLDP on the system. - -![ServicesLLDPOptions](/images/CORE/Services/ServicesLLDPOptions.png "LLDP Service Options") - -**General Options** - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Interface Description** | Select to enable receive mode. Interface description stores any peer information received. | -| **County Code** | Select the two-letter [ISO 3166-1 alpha-2](https://www.iso.org/obp/ui/) code used to enable LLDP location support. The dropdown list is a comprehensive list of two-character country codes. | -| **Location** | Enter the physical location of the host. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/Services/NFSScreen.md b/content/CORE/UIReference/Services/NFSScreen.md deleted file mode 100644 index a6fc017eb6..0000000000 --- a/content/CORE/UIReference/Services/NFSScreen.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "NFS Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/nfsscreen/" -description: "Describes the NFS screen in TrueNAS CORE." -weight: 60 -tags: -- nfs ---- - -Network File System (NFS) is an open IETF standard remote file access protocol. Use the **Services NFS** screen to enable NFS services on your TrueNAS. - -![NFSServicesScreen](/images/CORE/Services/NFSServicesScreen.png "Services NFS Add") - -Click **SAVE** to save settings and return to the **Services** screen. - -Click **CANCEL** to exit without saving and return to the **Services** screen. - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Number of servers** | Enter a number to specify how many servers to create. Increase if NFS client responses are slow. Keep this less than or equal to the number of CPUs reported by `sysctl -n kern.smp.cpus` to limit CPU context switching. | -| **Bind IP Addresses** | Select IP addresses from dropdown list to listen to for NFS requests. Leave empty for NFS to listen to all available addresses. | -| **Enable NFSv4** | Select checkbox to switch from NFSv3 to NFSv4. | -| **NFSv3 ownership model for NFSv4** | Select checkbox to provide specific NFSv4 ACL support. This does not require the client and the server to sync users and groups. | -| **Require Kerberos for NFSv4** | Select checkbox to force NFS shares to fail if the Kerberos ticket is unavailable. | -| **Serve UDP NFS clients** | Select checkbox if NFS clients need to use the User Datagram Protocol (UDP). | -| **Allow non-root mount** | Select checkbox only if required by the NFS client. Select to allow serving non-root mount requests. | -| **Support >16 groups** | Select checkbox when a user is a member of more than 16 groups. Requires correct configuration of group membership on the NFS server. | -| **Log mountd(8) requests** | Select checkbox to log [mountd](https://www.freebsd.org/cgi/man.cgi?query=mountd) syslog requests. | -| **Log rpc.statd(8) and rpc.lockd(8)** | Select checkbox to log [rpc.statd](https://www.freebsd.org/cgi/man.cgi?query=rpc.statd) and [rpc.lockd](https://www.freebsd.org/cgi/man.cgi?query=rpc.lockd) syslog requests. | -| **mountd(8) bind port** | Enter a number to bind [mountd](https://www.freebsd.org/cgi/man.cgi?query=mountd) only to that port. | -| **rpc.statd(8) bind port** | Enter a number to bind [rpc.statd](https://www.freebsd.org/cgi/man.cgi?query=rpc.statd) only to that port. | -| **rpc.lockd(8) bind port** | Enter a number to bind [rpc.lockd](https://www.freebsd.org/cgi/man.cgi?query=rpc.lockd) only to that port. | -{{< /truetable >}} - -The recommendation is to use the default settings for the NFS service. Make changes if there is a need for a specific setting. diff --git a/content/CORE/UIReference/Services/OpenVPNScreen.md b/content/CORE/UIReference/Services/OpenVPNScreen.md deleted file mode 100644 index 377f32b0d8..0000000000 --- a/content/CORE/UIReference/Services/OpenVPNScreen.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "OpenVPN Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/openvpnscreen/" -description: "Describes the OpenVPN screen in TrueNAS CORE." -weight: 70 -tags: -- vpn ---- - - - -OpenVPN is an open source connection protocol. OpenVPN creates a secure connection between 2 points in a network. VPN services use OpenVPN to safeguard data integrity and provide anonymity. There two OpenVPN services on TrueNAS, the **OpenVPN Client** and **OpenVPN Server**. - -## OpenVPN Client - -Use **OpenVPN Client** to configure the client settings. - -![ServicesOpenVPNClientOptions](/images/CORE/Services/ServicesOpenVPNClientOptions.png "OpenVPN Client Options") - -**General Options** - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Client Certificate** | Select a valid client certificate from the dropdown list. The option is **freenas_default**. A certificate must exist on this system that is current and not revoked. Find more about generating certificates and CAs for OpenVPN [here](https://community.openvpn.net/openvpn/wiki/HOWTO#SettingupyourownCertificateAuthorityCAandgeneratingcertificatesandkeysforanOpenVPNserverandmultipleclients). | -| **Root CA** | Select the root Certificate Authority used to sign the Client and Server certificates. Find more about generating certificates and CAs for OpenVPN [here](https://community.openvpn.net/openvpn/wiki/HOWTO#SettingupyourownCertificateAuthorityCAandgeneratingcertificatesandkeysforanOpenVPNserverandmultipleclients). | -| **Remote** | Enter a valid IP address or domain name to which OpenVPN connects. | -| **Port** | Enter a port number to use for the connection. | -| **Authentication Algorithm** | Select an algorithm to authenticate packets. The dropdown list provides a list of algorithms to choose from. This is used to confirm packets sent over the network connection. Your network environment might need a specific algorithm. If not, select **SHA1 HMAC** which is a good standard algorithm to use. | -| **Cipher** | Select a cipher algorithm to encrypt data channel packets sent through the connection. While not required, using a cipher increases connection security. Verify if your networking environment requires a particular cipher. If not, **AES-256-GCM** is a good default choice. The dropdown list provides a list of encryption ciphers to choose from. | -| **Compression** | Select a compression algorithm from the dropdown list. Dropdown list options are **LZ0** or **LZ4**. Leave the field empty to send data uncompressed. **LZ0** is the standard compression algorithm. It is backwards compatible with previous (pre-2.4) versions of OpenVPN. **LZ4** is a newer option that is typically faster with less system resources required. | -| **Protocol** | Select the protocol to use when connecting with the remote system. Select from the dropdown list options **UDP**, **UDP4**, **UDP6**, **TCP**, **TCP4** or **TCP6**. Select **UDP** or **TCP**. UDP sends packets in a continuous stream. It is generally faster and less strict about dropped packets than TCP. TCP sends packets sequentially. To force the connection to be IPv4 or IPv6 choose the UDP or TCP version with the 4 or 6 respectively. | -| **Device Type** | Select a virtual network interface from the dropdown list. Options are **TUN** or **TAP**. The client and server **Device Type** must be the same. For information see [here](https://community.openvpn.net/openvpn/wiki/BridgingAndRouting). | -| **Nobind** | Select to enable and to prevent binding to local address and port. Required if running OpenVPN client and server at the same time. | -| **TLS Crypt Auth Enabled** | Select to enable or clear checkbox to disable TLS Web Client Authentication. | -| **Additional Parameters** | Enter any extra parameters for the client. This manually configures any of the core OpenVPN config file options. Refer to the OpenVPN [Reference Manual](https://openvpn.net/community-resources/reference-manual-for-openvpn-2-4/) for descriptions of each option. | -| **TLS Crypt Auth** | Encrypts all TLS handshake messages to add another layer of security. OpenVPN server and clients share a required static key. Enter the static key for authentication/encryption of all control channel packets. Must enable tls_crypt_auth_enabled. | -{{< /truetable >}} - -## OpenVPN Server - -Use **OpenVPN Server** to configure the server settings. - -![ServicesOpenVPNServerOptions](/images/CORE/Services/ServicesOpenVPNServerOptions.png "OpenVPN Server Options") - -Configure and save your OpenVPN server settings. Click **DOWNLOAD CLIENT CONFIG** to generate the certificate file you need from the client system. - -Click **Client Certificate** to generate the configuration file you need from the client system already imported on the system. - -**General Options** - -{{< truetable >}} -| Name | Description | -|----------|-------------| -| **Server Certificate** | Select a valid server certificate from the dropdown list. The option is **freenas_default**. A certificate must exist on this system that is current and not revoked. Find more about generating certificates and CAs for OpenVPN [here](https://community.openvpn.net/openvpn/wiki/HOWTO#SettingupyourownCertificateAuthorityCAandgeneratingcertificatesandkeysforanOpenVPNserverandmultipleclients). | -| **Root CA** | Select the root Certificate Authority used to sign the Client and Server certificates. Find more about generating certificates and CAs for OpenVPN [here](https://community.openvpn.net/openvpn/wiki/HOWTO#SettingupyourownCertificateAuthorityCAandgeneratingcertificatesandkeysforanOpenVPNserverandmultipleclients). | -| **Server** | Enter the IP address and netmask of the server. | -| **Port** | Enter a port number to use for the connection. | -| **Authentication Algorithm** | Select an algorithm to authenticate packets. The dropdown list provides a list of algorithms to choose from. Your network environment might require a specific algorithm. If not, select **SHA1 HMAC** which is a good standard algorithm to use. | -| **Cipher** | Select a cipher algorithm to encrypt data channel packets sent through the connection. While not required, using a cipher increases connection security. Verify if your networking environment requires a particular cipher. If not, **AES-256-GCM** is a good default choice. The dropdown list provides a list of encryption ciphers to choose from. | -| **Compression** | Select a compression algorithm from the dropdown list. Dropdown list options are **LZ0** or **LZ4**. Leave the field empty to send data uncompressed. **LZ0** is the standard compression algorithm. It is backwards compatible with previous (pre-2.4) versions of OpenVPN. **LZ4** is a newer option that is typically faster with less system resources required. | -| **Protocol** | Select the protocol to use when connecting with the remote system. Select from the dropdown list options **UDP**, **UDP4**, **UDP6**, **TCP**, **TCP4** or **TCP6**. Select **UDP** or **TCP**. UDP sends packets in a continuous stream. It is generally faster and less strict about dropped packets than TCP. TCP sends packets sequentially. To force the connection to be IPv4 or IPv6 choose the UDP or TCP version with the 4 or 6 respectively. | -| **Device Type** | Select a virtual network interface from the dropdown list. Options are **TUN** or **TAP**. The client and server **Device Type** must be the same. For more information see [here](https://community.openvpn.net/openvpn/wiki/BridgingAndRouting). | -| **Topology** | Select to configure virtual addressing topology when running in TUN mode. Dropdown list options are **NET30**, **P2P** or **SUBNET**. TAP mode always uses a SUBNET topology. | -| **TLS Crypt Auth Enabled** | Select to enable or clear checkbox to disable TLS Web Client Authentication. | -| **Additional Parameters** | Enter any extra parameters. | -| **TLS Crypt Auth** | Encrypting TLS handshake messages adds another layer of security. OpenVPN server and clients share a required static key. Enabling tls_crypt_auth_enabled generates a static key if tls_crypt_auth is not provided. The generated static key is for use with OpenVPN client. Enter that key here. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/Services/S3Screen.md b/content/CORE/UIReference/Services/S3Screen.md deleted file mode 100644 index 24e3e5a940..0000000000 --- a/content/CORE/UIReference/Services/S3Screen.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "S3 Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/s3screen/" -description: "Describes the S3 screen in TrueNAS CORE." -weight: 100 -tags: -- s3 ---- - -{{< include file="/static/includes/S3Deprecation.md" >}} - -S3 manages data using object storage architecture. - -{{< hint type=important >}} -Having large numbers of files (>100K for instance) in a single bucket with no sub-directories is not recommended. It can harm performance and cause stability issues. -{{< /hint >}} - -Use the **S3** screen to configure S3 on your TrueNAS. - -![ServicesS3Options](/images/CORE/Services/ServicesS3Options.png "S3 Service Options") - -The **SAVE** button activates after entering the required settings. - -**CANCEL** closes the **S3** screen without saving changes and displays the **Services** screen. - -{{< include file="/static/includes/ServicesS3Fields.md" >}} - -{{< hint type=important >}} -MinIO deprecated Access key and Secret key. MINIO_ROOT USER arguments and their values replace Access key. MINIO_ROOT_PASSWORD arguments and their values replace Secret key. For the ROOT_USER value, use a name up to 20 characters. For the ROOT_PASSWORD, use a string of 8 to 40 randomized characters. MinIO recommends using a long password string of unique random characters. -{{< /hint >}} diff --git a/content/CORE/UIReference/Services/SMARTScreen.md b/content/CORE/UIReference/Services/SMARTScreen.md deleted file mode 100644 index a02f666d58..0000000000 --- a/content/CORE/UIReference/Services/SMARTScreen.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "S.M.A.R.T. Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/smartscreen/" -description: "Describes the S.M.A.R.T. screen in TrueNAS CORE." -weight: 100 -tags: -- smart ---- - -Self-Monitoring, Analysis and Reporting Technology (S.M.A.R.T.) is an industry standard. S.M.A.R.T. performs disk monitoring and testing. It checks drive reliability and predicts hardware failures. - -{{< hint type=important >}} -S.M.A.R.T. tests run on disks. -Running tests can reduce drive performance. We recommend scheduling tests when the system is in a low-usage state. -Avoid scheduling disk-intensive tests at the same time! -For example, do not schedule S.M.A.R.T. tests on the same day as a disk [scrub]({{< relref "CORE/CORETutorials/Tasks/CreatingScrubTasks.md" >}}) or [resilver]({{< relref "CORE/CORETutorials/Tasks/UsingResilverPriority.md" >}}). -{{< /hint >}} - -![ServicesSMARTOptions](/images/CORE/Services/ServicesSMARTOptions.png "S.M.A.R.T. Options") - -{{< include file="/static/includes/ServicesSMARTFields.md" >}} diff --git a/content/CORE/UIReference/Services/SMBScreen.md b/content/CORE/UIReference/Services/SMBScreen.md deleted file mode 100644 index 1fe5fac2ea..0000000000 --- a/content/CORE/UIReference/Services/SMBScreen.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "SMB Service Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/smbscreen/" -description: "Describes the SMB screen in TrueNAS CORE." -weight: 110 -tags: -- smb ---- - -Use the **Services SMB** screen to configure SMB service settings. -Unless a specific setting is needed or configuring for a specific network environment, it is recommended to use the default settings for the SMB service. - -![SMBServiceOptions](/images/CORE/Services/ServicesSMBOptions.png "SMB Service Options") - -## Basic Options - -{{< truetable >}} -| Name | Description | -|----------|-------------| -| **NetBIOS Name** | Populates with the original host name of the system **truenas**. Limited to 15 characters and cannot be the same name in **Workgroup**. | -| **NetBIOS Alias** | Enter any aliases, separated by spaces. Each alias can be up to 15 characters long. | -| **Workgroup** | Value must match Windows workgroup name. If unconfigured, TrueNAS uses Active Directory or LDAP to detect and select the correct workgroup. Active Directory or LDAP must be active for TrueNAS to do this. | -| **Description** | Optional. Enter a server description. | -| **Enable SMB1 support** | Select to allow legacy SMB clients to connect to the server. Note that SMB1 is being deprecated. The recommendation is to upgrade the client OS. The OS upgrade should support modern versions of the SMB protocol. | -| **NTLMv1 Auth** | Select to allow [smbd(8)](https://www.freebsd.org/cgi/man.cgi?query=smbd) attempts to authenticate users with NTLMv1 encryption. NTLMv1 is not secure and is a vulnerability. NTLMv1 authentication is off by default. This setting allows backward compatibility with older versions of Windows. It is not recommended. Do not use on untrusted networks. | -{{< /truetable >}} - -## Advanced Options - -![SMBServiceAdvanced](/images/CORE/Services/ServicesSMBOptionsAdvanced.png "Advanced Options for the SMB Service") - -{{< truetable >}} -| Name | Description | -|----------|-------------| -| **Unix Charset** | Select an option from the dropdown list. Default is **UTF-8** which supports all characters in all languages. | -| **Log Level** | Select an option from the dropdown list. Options are **None**, **Minimum**, **Normal**, **Full** or **Debug**. Records SMB service messages up to the specified log level. Logs error and warning level messages by default. | -| **Use Syslog Only** | Select to log authentication failures in /var/log/messages instead of the default /var/log/samba4/log.smbd. | -| **Local Master** | Select to determine if the system participates in a browser election. Leave checkbox clear when the network contains an AD or LDAP server. Leave checkbox clear when Vista or Windows 7 machines are present. | -| **Enable Apple SMB2/3 Protocol Extensions** | Select to allow macOS to use these [protocol extensions](https://support.apple.com/en-us/HT210803). Improves the performance and behavioral characteristics of SMB shares. Required for Apple Time Machine support. | -| **Administrators Group** | Select an option from the dropdown list. Members of this group are local admins. Local admins have privileges to take ownership of any file in the SMB share. They can reset permissions. Local admins can administer the SMB server through the Computer Management MMC snap-in. | -| **Guest Account** | Select an account to use for guest access from the dropdown list. Default is **nobody**. The selected account must have permissions to the shared pool or dataset. To adjust permissions, edit the dataset Access Control List (ACL). Add a new entry for the selected guest account, and configure the permissions in that entry. Deleting the selected user in **Guest Account** resets the field to **nobody**. | -| **File Mask** | Overrides default file creation mask of **0666**. File creation mask **0666** creates files with read and write access for everybody. | -| **Directory Mask** | Overrides default directory creation mask of **0777**. Directory creation mask **0777** grants directory read, write and execute access for everybody. | -| **Bind IP Addresses** | Select from the dropdown list. These are the static IP addresses which SMB listens on for connections. If not selected, defaults to listen on all active interfaces. | -| **Auxiliary Parameters** | Enter additional smb.conf options. See the [Samba Guide](https://www.oreilly.com/openbook/samba/book/appb_02.html) for more information on these settings. To log more details when a client attempts to authenticate to the share, add *log level = 1, auth_audit:5*. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/Services/SNMPScreen.md b/content/CORE/UIReference/Services/SNMPScreen.md deleted file mode 100644 index 20cec41730..0000000000 --- a/content/CORE/UIReference/Services/SNMPScreen.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "SNMP Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/snmpscreen/" -description: "Describes the SNMP screen in TrueNAS CORE." -weight: 120 -aliases: /core/services/snmp/ -tags: -- snmp ---- - -Simple Network Management Protocol (SNMP) is an Internet Standard protocol. SNMP gathers and sorts data about managed devices on IP networks, such as LANs and WANs. Use the **SNMP** screen to configure SNMP service on your TrueNAS. - -![ServicesSNMPScreen](/images/CORE/Services/ServicesSNMPScreen.png "SNMP Service Options") - -After selecting **SNMP v3 Support** more configuration fields display. - -![ServicesSNMPScreenSNMPv3.png](/images/CORE/Services/ServicesSNMPScreenSNMPv3.png "SNMP Screen SNMPv3") - -After filling in all required fields with appropriate values, the **SAVE** button activates. Click **SAVE** to save settings. - -Click **CANCEL** to exit without saving and display the **Services** screen. - -**Field Descriptions** - -{{< include file="/static/includes/ServicesSNMPFields.md" markdown="true" >}} diff --git a/content/CORE/UIReference/Services/ServicesSSH.md b/content/CORE/UIReference/Services/ServicesSSH.md deleted file mode 100644 index 3b5b9d9e50..0000000000 --- a/content/CORE/UIReference/Services/ServicesSSH.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "SSH Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/servicesssh/" -description: "Describes the SSH screen in TrueNAS CORE." -weight: 130 -aliases: - - /core/uireference/services/sshscreen/ - - /core/services/servicesssh/ -tags: -- ftp -- tftp -- sftp -- ssh ---- - -Secure Socket Shell (SSH) is a network communication protocol. It provides encryption to secure data. Use the SSH services screen to configure SSH File Transfer Protocol (SFTP). SFTP is available by enabling SSH remote access to the TrueNAS system. - -{{< hint type=important >}} -Allowing external connections to TrueNAS is a security vulnerability! -Enable SSH only when there is a need for external connections. -See [Security Recommendations]({{< relref "Security.md" >}}) for more security considerations when using SSH. -{{< /hint>}} - -![SSHBasicOptionsScreen](/images/CORE/Services/SSHBasicOptionsScreen.png "SSH Basic Options") - -{{< include file="/static/includes/ServicesSSHFields.md" markdown="true" >}} - -**ADVANCED OPTIONS** displays additional configuration fields to set up SSH for specific uses cases. - -![SSHAdvancedOptionsScreen](/images/CORE/Services/SSHAdvancedOptionsScreen.png "SSH Advanced Options") - -{{< include file="/static/includes/ServicesSSHAdvancedFields.md" markdown="true" >}} diff --git a/content/CORE/UIReference/Services/TFTPScreen.md b/content/CORE/UIReference/Services/TFTPScreen.md deleted file mode 100644 index ef3d25f8b3..0000000000 --- a/content/CORE/UIReference/Services/TFTPScreen.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "TFTP Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/tftpscreen/" -description: "Describes the TFTP screen in TrueNAS CORE." -weight: 140 -tags: -- ftp -- tftp -- sftp ---- - -Trivial File Transfer Protocol (TFTP) is a basic protocol designed for simple file transfer. It provides no user authentication or the ability to browse a directory hierarchy. Use the **TFTP** service screen to configure TFTP service on the TrueNAS. - -![TFTPScreen](/images/CORE/Services/TFTPScreen.png "TFTO Service Options") - -## TFTP Service Screen Settings - -{{< include file="/static/includes/ServicesTFTPFields.md" markdown="true" >}} diff --git a/content/CORE/UIReference/Services/UPSScreen.md b/content/CORE/UIReference/Services/UPSScreen.md deleted file mode 100644 index 3aba184b19..0000000000 --- a/content/CORE/UIReference/Services/UPSScreen.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "UPS Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/upsscreen/" -description: "Describes the UPS screen in TrueNAS CORE." -weight: 150 -aliases: -- /core/services/ups/ -tags: -- ups ---- - -An uninterruptible power supply is a hardware device that provides a backup source of power in the event of a power outage. Use the **UPS** services screen to configure a UPS for your TrueNAS. - -{{< include file="/static/includes/HAUninterruptiblePowerSupplyNotice.md" >}} - -**SAVE** activates after all required fields are populated. - -**CANCEL** exits without saving and returns you to the **Services** screen. - -{{< trueimage src="/images/CORE/Services/ServicesUPSScreenTop.png" alt="UPS Options" id="UPS Options (Top)" >}} - -**General Options** - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Identifier** | Type a description for the UPS device. You can use alphanumeric, period (.), comma (,), hyphen (-), and underscore (_) characters. This is a required field. | -| **UPS Mode** | Select mode from the dropdown list. **Master** is an option if the UPS plugs directly into the system serial port. Select **Slave** to have this system shut down before the master system. The UPS remains the last item to shut down. See the [Network UPS Tools Overview](https://networkupstools.org/docs/user-manual.chunked/ar01s02.html#_monitoring_client). | -| **Driver** | Select the device driver from the dropdown list. See the [Network UPS Tools compatibility list](https://networkupstools.org/stable-hcl.html) for a list of supported UPS devices. This is a required field. | -| **Port or Hostname** | Select the serial or USB port connected to the UPS from the dropdown list. Options include a list of ports on your system and **auto**. Select **auto** to automatically detect and manage the USB port settings. Enter the IP address or host name of the SNMP UPS device when selecting an SNMP driver. If the **UPS Mode** field is set as **Master**, this is a required field. If set to **Slave** this field is not required. | -{{< /truetable >}} - -**Monitor** - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Monitor User** | Enter a user to associate with this service. Keeping the default is recommended. | -| **Monitor Password** | Change the default password to improve system security. The new password cannot include a space or #. | -| **Extra Users** | Enter accounts that have administrative access. See [upsd.users(5)](https://www.freebsd.org/cgi/man.cgi?query=upsd.users) for examples. | -| **Remote Monitor** | Select to have the default configuration listen on all interfaces using the known values of user: **upsmon** and password: **fixmepass**. | -{{< /truetable >}} - -{{< trueimage src="/images/CORE/Services/ServicesUPSScreenBottom.png" alt="UPS Options" id="UPS Options (Bottom)" >}} - -**Shutdown** - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Shutdown Mode** | Select the battery option to use when the UPS initiates shutdown. Dropdown list options are **UPS reaches low battery** or **UPS goes on battery**. | -| **Shutdown Timer** | Enter a value in seconds for the UPS to wait before initiating shutdown. Shutdown does not occur if power is restored while the timer is counting down. This value only applies when **Shutdown Mode** is set to **UPS goes on battery**. | -| **Shutdown Command** | Enter a command to shut down the system when either battery power is low or the shutdown timer ends. | -| **Power off UPS** | Select for the UPS to power off after shutting down the system. | -{{< /truetable >}} - -**Email** - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Send Email Status Updates** | Select to enable sending messages to the address defined in the **Email** field. | -| **Email** | Enter any email addresses to receive status updates. Separate entries by pressing Enter. | -| **Email Subject** | Enter the subject for status emails. | -{{< /truetable >}} - -**Other Options** - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **No Communication Warning Time** | Enter the number of seconds to wait before alerting that the service cannot reach any UPS. Warnings continue until situation resolved. | -| **Host Sync** | Length of time in seconds for upsmon to wait while in master mode for the slaves to disconnect. This applies during a shutdown situation. | -| **Description** | Enter a description for this service. | -| **Auxiliary Parameters (ups.conf)** | Enter any extra options from [ups.conf](https://networkupstools.org/docs/man/ups.conf.html). | -| **Auxiliary Parameters (upsd.conf)** | Enter any extra options from [upsd.conf](https://networkupstools.org/docs/man/upsd.conf.html). | -{{< /truetable >}} diff --git a/content/CORE/UIReference/Services/WebDAVScreen.md b/content/CORE/UIReference/Services/WebDAVScreen.md deleted file mode 100644 index 8a36d955cd..0000000000 --- a/content/CORE/UIReference/Services/WebDAVScreen.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "WebDAV Services Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/webdavscreen/" -description: "Describes the WebDAV screen in TrueNAS CORE." -weight: 160 -tags: -- webdav ---- - -The WebDAV protocol contains extensions to HTTP. These extensions expand the capabilities of a webserver. It can act as a collaborative authoring and management tool for web content. Use the **Services WebDAV** screen to enable WebDAV services on your TrueNAS. - -Click **ADD** to open the WebDAV settings screen. - -![ServicesWebDAVSettings](/images/CORE/Services/ServicesWebDAVSettings.png "Services WebDAV Settings Screen") - -**General Options** - -{{< truetable >}} -| Name | Description | -|----------|-------------| -| **Protocol** | Select the protocol from the dropdown list. **HTTP** keeps the connection unencrypted. **HTTPS** encrypts the connection. **HTTP+HTTPS** allows both types of connections. | -| **HTTP Port** | Specify a port for unencrypted connections. The default port **8080** is recommended. Do not reuse a port. | -| **HTTP Authentication** | Select the HTTP authentication type from the dropdown list. **Basic Authentication** is unencrypted. **Digest Authentication** is encrypted. Select **No Authentication** when you don't want to use authentication. | -| **Webdav Password** | Change the default of **davtest** as davtest is a known value. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/Services/_index.md b/content/CORE/UIReference/Services/_index.md deleted file mode 100644 index 9d00963716..0000000000 --- a/content/CORE/UIReference/Services/_index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Services" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/services/" -description: "Provides information on the Services screen and lists other services UI reference articles." -geekdocCollapseSection: true -weight: 120 -related: false ---- - - -{{< include file="/static/includes/COREServices.md" >}} - -[Sharing]({{< relref "/CORE/UIReference/Sharing/_index.md" >}}) provides documentation for services related to data sharing. [Tasks]({{< relref "/CORE/UIReference/Tasks/_index.md" >}}) provides documentation for services related to automated tasks. - -
- -## Services Contents - -{{< children depth="2" sort="Name" description="true" >}} - -
diff --git a/content/CORE/UIReference/Sharing/AFPShareScreen.md b/content/CORE/UIReference/Sharing/AFPShareScreen.md deleted file mode 100644 index 25b0d219b4..0000000000 --- a/content/CORE/UIReference/Sharing/AFPShareScreen.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "AFP Share Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/sharing/afpsharescreen/" -description: "Provides information about the AFP Share screen in TrueNAS CORE." -weight: 10 -aliases: -- /core/uireference/sharing/afp/afpsharescreen/ -- /core/uireference/sharing/afp/ -tags: -- afp ---- - -Apple Filing Protocol (AFP) facilitates workgroup and Internet file sharing. It does this in a mixed-platform environment. Go to **Sharing > AFP** to set up an AFP share. Click **ADD** to edit AFP share settings. - -{{< hint type=important >}} -AFP share creation is deprecated in CORE 13.0. A **Recommendation** dialog displays when accessing this screen and suggests sharing data with a different protocol. -{{< /hint >}} - -{{< hint type=note >}} -* Click **CREATE AN SMB SHARE** to display the **SMB BASIC OPTIONS** configuration screen. - -* Click **CONTINUE WITH AFP SETUP** to continue to the **AFP > ADD** **BASIC OPTIONS** configuration screen. -{{< /hint >}} - -![Sharing AFP Add](/images/CORE/Sharing/SharingAFPAdd.png "Sharing AFP Add") - -Click **ADVANCED OPTIONS** to display extra configuration settings. These configuration settings allow modifying the share **Permissions** and adding a **Description**. You can also specify any **Auxiliary Parameters**. - -![Sharing AFP Add Advanced](/images/CORE/Sharing/SharingAFPAddAdvanced.png "Sharing AFP Add Advanced") - -{{< include file="/static/includes/SharingAFPAddFields.md" markdown="true" >}} - -Click **SUBMIT** to save settings and create the share. - -Click **CANCEL** to exit the **Add** screen without saving and return to the **AFP** screen. - -To edit an existing AFP share, go to **Sharing > Apple Shares (AFP)** and click . diff --git a/content/CORE/UIReference/Sharing/NFSShareScreen.md b/content/CORE/UIReference/Sharing/NFSShareScreen.md deleted file mode 100644 index 9c629b810e..0000000000 --- a/content/CORE/UIReference/Sharing/NFSShareScreen.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "NFS Share Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/sharing/nfssharescreen/" -description: "Use the NFS share screen to configure Network File System (NFS) shares on your TrueNAS." -weight: 30 -aliases: -- /core/uireference/sharing/nfs/nfssharescreen/ -- /core/uireference/sharing/nfs/ -tags: -- nfs ---- - -Unix and Unix-like operating systems often use the Network File System (NFS) protocol. NFS shares data across a network as part of a distributed file system. Go to **Sharing > Unix Shares (NFS)** to access the **NFS** screen to create a Network File System (NFS) share on TrueNAS. - -![NFSScreen](/images/CORE/Sharing/NFSScreen.png "Sharing NFS Screen") - -Click **COLUMNS** to change the NSF table view. Options include **Unselect All**, **Description**, **Enabled** or **Reset to Defaults**. - -Click **ADD** to open the **BASIC OPTIONS** configuration screen. - -### NFS Share Basic Option Settings - -![NFSBasicOptionsScreen](/images/CORE/Sharing/NFSBasicOptionsScreen.png "Services NFS Basic Options") - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Path** | Type or browse to the full path to the pool or dataset to share. Click **ADD** to add another **Path** setting field. Repeat to configure multiple paths. | -| **Description** | Enter any notes or reminders about the share. | -| **All dirs** | Select checkbox to allow the client to mount any subdirectory within the **Path**. Clear to only allow clients to mount the **Path** endpoint. | -| **Quiet** | Select to suppress some syslog diagnostics to avoid error messages. See [exports(5)](https://www.freebsd.org/cgi/man.cgi?query=exports) for examples. Clear checkbox to allow all syslog diagnostics. This can lead to additional cosmetic error messages. | -| **Enabled** | Select checkbox to enable this NFS share. Clear checkbox to disable this NFS share without deleting the configuration. | -{{< /truetable >}} - -Click **ADVANCED OPTIONS** to display extra settings. These settings allow tuning the share access permissions and defining authorized networks. - -### NFS Share Advanced Option Settings - -![NFSAdvancedOptionsScreen](/images/CORE/Sharing/NFSAdvancedOptionsScreen.png "Services NFS Advanced Options") - -**Access Settings** - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Read Only** | Select checkbox to prohibit writing to the share. Clear checkbox to allow writing to the share. | -| **Maproot User** | Enter a new string or select a user to apply that user permissions to the root user. Dropdown list displays a list of all users on the system. | -| **Maproot Group** | Enter a new string or select a group to apply that group permissions to the root user. Dropdown list displays a list of all groups on the system. | -| **Mapall User** | Enter a new string or select a user to apply permissions for the chosen user to all clients. | -| **Mapall Group** | Enter a new string or select a group to apply permissions for the chosen group to all clients. | -| **Authorized Networks** | Enter an allowed network in network/mask CIDR notation. Click **ADD** to define another authorized network. Defining an authorized network restricts access to all other networks. Leave empty to allow all networks. | -| **Authorized Hosts and IP addresses** | Enter a host name or IP address to allow that system access to the NFS share. Click **ADD** to define another allowed system. Defining authorized systems restricts access to all other systems. Leave field empty to allow all systems access to the share. | -{{< /truetable >}} - -Click **SUBMIT** to save NFS share settings. - -Click **CANCEL** to exit without saving and return to the NFS Shares screen. - -To edit an existing NFS share click the for the share and select **Edit**. -The options available are identical to the **ADD** share setting options. diff --git a/content/CORE/UIReference/Sharing/SMBShareScreen.md b/content/CORE/UIReference/Sharing/SMBShareScreen.md deleted file mode 100644 index 91e300b19c..0000000000 --- a/content/CORE/UIReference/Sharing/SMBShareScreen.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -title: "SMB Share Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/sharing/smbsharescreen/" -description: "Desctibes the SMB sharing screen in TrueNAS CORE" -weight: 50 -aliases: -- /core/uireference/sharing/smb/smbsharescreen/ -- /core/uireference/sharing/smb/ -tags: -- smb ---- - -Server Message Block (SMB) is a file sharing protocol. Windows and other operating systems use SMB. - -Go to **Sharing > Windows Shares (SMB)** to display the **SMB** screen and setup SMB shares on your TrueNAS. - -![SharingSMBScreen](/images/CORE/Sharing/SharingSMBScreen.png "SMB Share Screen") - -Click **Columns** to change the information displayed in the table. Options are **Unselect All**, **Path**, **Description**, **Enabled** and **Reset to Defaults**. - -Click **Add** to display the **BASIC Options** settings screen. - -## Basic Options - -![SharingSMBBasicOptions](/images/CORE/Sharing/SharingSMBBasicOptions.png "SMB Share Basic Options") - -{{< truetable >}} -| Name | Description | -|---------|--------------| -| **Path** | Use the file browser or click the **/mnt** to select the pool, dataset or directory to share. | -| **Name** | Enter a name for the SMB share. | -| **Purpose** | Select a preset purpose configuration. This locks in predetermined values for the share. This includes **Advanced Options**, as well as the **Path Suffix**. Select from the dropdown list. Options are:
**No presets**
**Default share parameters**
**Multi-user time machine**
**Multi-protocol (AFP/SMB) shares**
**Multi-protocol (NFSv3/SMB) shares**
**Private SMB Datasets and Shares**
**SMB WORM. Files become readonly via SMB after 5 minutes**. Note: The **SMB WORM** preset only impacts writes over the SMB protocol. Prior to deploying this option in a production environment the user needs to determine whether the feature meets his / her requirements.
See "What do all the presets do?" for more information on presets. | -| **Description** | Optional. Explains the purpose of the share. | -| **Enabled** | Select to enable this SMB share. Clear checkbox to disable the share without deleting the configuration. | -{{< /truetable >}} - -{{< expand "What do all the presets do?" "v" >}} -The following table shows the preset options for the different **Purposes** and if those options are locked. -An [x] indicates the option is enabled, [ ] means the option is disabled, and [text] indicates a specific value: - -{{< truetable >}} -| Default share parameters | Multi-user time machine | Multi-protocol (AFP/SMB) shares | Multi-protocol (NFSv3/SMB) shares | Private SMB Datasets and Shares | Files become readonly of SMB after 5 minutes | -|:-----------------------------------------------:|---------------------------------------------------|-------------------------------------------------|---------------------------------------------------|---------------------------------------------------|---------------------------------------------------| -| [x] Enable ACL (locked) | [x] Enable ACL (unlocked) | [x] Enable ACL (locked) | [ ] Enable ACL (locked) | [ ] Enable ACL (unlocked) | [ ] Enable ACL (unlocked) | -| [ ] Export Read Only (locked) | [ ] Export Read Only (unlocked) | [ ] Export Read Only (unlocked) | [ ] Export Read Only (unlocked) | [ ] Export Read Only (unlocked) | [ ] Export Read Only (unlocked) | -| [x] Browsable to Network Clients (locked) | [x] Browsable to Network Clients (unlocked) | [x] Browsable to Network Clients (unlocked) | [x] Browsable to Network Clients (unlocked) | [x] Browsable to Network Clients (unlocked) | [x] Browsable to Network Clients (unlocked) | -| [ ] Allow Guest Access (unlocked) | [ ] Allow Guest Access (unlocked) | [ ] Allow Guest Access (unlocked) | [ ] Allow Guest Access (unlocked) | [ ] Allow Guest Access (unlocked) | [ ] Allow Guest Access (unlocked) | -| [ ] Access Based Share Enumeration (locked) | [ ] Access Based Share Enumeration (unlocked) | [ ] Access Based Share Enumeration (unlocked) | [ ] Access Based Share Enumeration (unlocked) | [ ] Access Based Share Enumeration (unlocked) | [ ] Access Based Share Enumeration (unlocked) | -| [ ] Hosts Allow (locked) | [ ] Hosts Allow (unlocked) | [ ] Hosts Allow (unlocked) | [ ] Hosts Allow (unlocked) | [ ] Hosts Allow (unlocked) | [ ] Hosts Allow (unlocked) | -| [ ] Hosts Deny (locked) | [ ] Hosts Deny (unlocked) | [ ] Hosts Deny (unlocked) | [ ] Hosts Deny (unlocked) | [ ] Hosts Deny (unlocked) | [ ] Hosts Deny (unlocked) | -| [ ] Use as Home Share (locked) | [ ] Use as Home Share (unlocked) | [ ] Use as Home Share (unlocked) | [ ] Use as Home Share (unlocked) | [ ] Use as Home Share (unlocked) | [ ] Use as Home Share (unlocked) | -| [ ] Time Machine (locked) | [ ] Time Machine (unlocked) | [ ] Time Machine (unlocked) | [ ] Time Machine (unlocked) | [ ] Time Machine (unlocked) | [ ] Time Machine (unlocked) | -| [x] Enable Shadow Copies (locked) | [x] Enable Shadow Copies (unlocked) | [x] Enable Shadow Copies (unlocked) | [x] Enable Shadow Copies (unlocked) | [x] Enable Shadow Copies (unlocked) | [x] Enable Shadow Copies (unlocked) | -| [ ] Export Recycle Bin (locked) | [ ] Export Recycle Bin (unlocked) | [ ] Export Recycle Bin (unlocked) | [ ] Export Recycle Bin (unlocked) | [ ] Export Recycle Bin (unlocked) | [ ] Export Recycle Bin (unlocked) | -| [ ] Use Apple-style Character Encoding (locked) | [ ] Use Apple-style Character Encoding (unlocked) | [x] Use Apple-style Character Encoding (locked) | [x] Use Apple-style Character Encoding (unlocked) | [x] Use Apple-style Character Encoding (unlocked) | [x] Use Apple-style Character Encoding (unlocked) | -| [x] Enable Alternate Data Streams (locked) | [x] Enable Alternate Data Streams (unlocked) | [x] Enable Alternate Data Streams (locked) | [ ] Enable Alternate Data Streams (locked) | [ ] Enable Alternate Data Streams (unlocked) | [ ] Enable Alternate Data Streams (unlocked) | -| [x] Enable SMB2/3 Durable Handles (locked) | [x] Enable SMB2/3 Durable Handles (unlocked) | [ ] Enable SMB2/3 Durable Handles (locked) | [ ] Enable SMB2/3 Durable Handles (locked) | [ ] Enable SMB2/3 Durable Handles (unlocked) | [ ] Enable SMB2/3 Durable Handles (unlocked) | -| [ ] Enable FSRVP (locked) | [ ] Enable FSRVP (unlocked) | [ ] Enable FSRVP (locked) | [ ] Enable FSRVP (unlocked) | [ ] Enable FSRVP (unlocked) | [ ] Enable FSRVP (unlocked) | -| [ ] Path Suffix (locked) | [%U] Path Suffix (locked) | [%U] Path Suffix (unlocked) | [%U] Path Suffix (unlocked) | [%U] Path Suffix (locked) | [ ] Path Suffix (locked) | -| [ ] Auxiliary Parameters (unlocked) | [ ] Auxiliary Parameters (unlocked) | [ ] Auxiliary Parameters (unlocked) | [ ] Auxiliary Parameters (unlocked) | [ ] Auxiliary Parameters (unlocked) | [ ] Auxiliary Parameters (unlocked) | -{{< /truetable >}} -{{< /expand >}} - -## Advanced Options - -![SharingSMBAdvancedOptions](/images/CORE/Sharing/SharingSMBAdvancedOptions.png "SMB Share Advanced Options") - -**Access** and **Other Options** are the two options groups. -**Access** settings allow systems or users to access or change the shared data. - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Enable ACL** | Select to add Access Control List (ACL) support to the share. Leave checkbox clear to disable ACL support and delete any existing ACL for the share. | -| **Export Read Only** | Select to prohibit writes to the share. Leave checkbox clear to allow writes to the share. | -| **Browsable to Network Clients** | Select to include this share name when browsing shares. Home shares are only visible to the owner regardless of this setting. | -| **Allow Guest Access** | Select to make privileges the same as the guest account. Windows 10 version 1709 and Windows Server version 1903 have disabled guest access. Guest access for these clients requires extra client-side configuration.

**MacOS clients**: Trying to connect as a user that does not exist in TrueNAS does not default to the guest account. The **Connect As: Guest** option must be specifically chosen in MacOS to log in as the guest account. See the [Apple documentation](https://support.apple.com/guide/mac-help/connect-mac-shared-computers-servers-mchlp1140/mac) for more details. | -| **Access Based Share Enumeration** | Select to restrict share visibility to users with read or write access to the share. See the [smb.conf](https://www.samba.org/samba/docs/current/man-html/smb.conf.5.html) manual page. | -| **Hosts Allow** | Enter a list of allowed host names or IP addresses. Separate entries by pressing Enter. A more detailed description with examples see [here](https://www.samba.org/samba/docs/current/man-html/smb.conf.5.html#HOSTSALLOW). | -| **Hosts Deny** | Enter a list of denied host names or IP addresses. Separate entries by pressing Enter. | -{{< /truetable >}} - -{{< expand "Host Allow and Hosts Deny Fields" >}} -The **Hosts Allow** and **Hosts Deny** fields set up different access scenarios: -* If neither **Hosts Allow** or **Hosts Deny** contain an entry, then allow SMB share access for any host. -* If there is an entry in **Hosts Allow** list but none in **Hosts Deny** list, then only allow hosts on the **Hosts Allow** list. -* If there is an entry in **Hosts Deny** list but none in **Hosts Allow** list, then allow all hosts that are not on the **Hosts Deny** list. -* If there are both an entry in **Hosts Allow** and **Hosts Deny** list, then allow all hosts that are on the **Hosts Allow** list. If there is a host not on the **Hosts Allow** and not on the **Hosts Deny** list, then allow it. -{{< /expand >}} - -The **Other Options** have settings for improving Apple software compatibility. There are also ZFS snapshot features, and other advanced features. - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Use as Home Share** | Select to allow the share to host user home directories. Gives each user a personal home directory when connecting to the share. This personal home directory is not accessible by other users. This allows for a personal, dynamic share. It is only possible to use one share as the home share. See the configuring [Home Share article]({{< relref "/CORE/CORETutorials/Sharing/SMB/HomeShare.md" >}}) for detailed instructions. | -| **Time Machine** | Select to enable [Apple Time Machine](https://support.apple.com/en-us/HT201250) backups on this share. | -| **Enable Shadow Copies** | Select to allow export ZFS snapshots as [Shadow Copies](https://docs.microsoft.com/en-us/windows/win32/vss/shadow-copies-and-shadow-copy-sets) for Microsoft Volume Shadow Copy Service (VSS) clients. | -| **Export Recycle Bin** | When selected, moves files deleted from the same dataset to a recycle bin located in that dataset. These files do not take any extra space. | -| **Use Apple-style Character Encoding** | Select to convert NTFS illegal characters in the same manner as MacOS SMB clients. By default, Samba uses a hashing algorithm for NTFS illegal characters. | -| **Enable Alternate Data Streams** | Select to allow multiple [NTFS data streams](https://www.ntfs.com/ntfs-multiple.htm). Disabling this option causes MacOS to write streams to files on the file system. | -| **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. This option is not recommended 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 mountpoint. 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. This provides unique 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 connectpath must be preset before a client connects. | -| **Auxiliary Parameters** | Additional [smb.conf](https://www.samba.org/samba/docs/current/man-html/smb.conf.5.html) settings. | -{{< /truetable >}} - -Click **Submit** to save setings. This creates the share and adds it to the **Sharing > Windows Shares (SMB)** list. - -Click **CANCEL** to exit without saving and return to the main **SMB** screen. diff --git a/content/CORE/UIReference/Sharing/WebDAVShareScreen.md b/content/CORE/UIReference/Sharing/WebDAVShareScreen.md deleted file mode 100644 index 8c9cbdd453..0000000000 --- a/content/CORE/UIReference/Sharing/WebDAVShareScreen.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "WebDAV Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/sharing/webdavsharescreen/" -description: "Use the Sharing WebDAV screen to configure Web Distributed Authoring and Versioning (WebDAV) on your TrueNAS." -weight: 40 -aliases: -- /core/uireference/sharing/webdav/webdavsharescreen/ -- /core/uireference/sharing/webdav/ -tags: -- webdav ---- - -Web Distributed Authoring and Versioning (WebDAV) is an extension of HTTP. It is a protocol designed to help with web content authoring and management. Use the **Sharing WebDAV** screen to configure WebDAV on your TrueNAS. - -![WebDAVShareScreen](/images/CORE/Sharing/WebDAVShareScreen.png "Sharing WebDAV Screen") - -Click **COLUMNS** to change the columns displayed in the table. Options are **Select All**, **Description**, **Path**, **Enabled**, **Read Only**, **Change User and Group Owners** or **Reset to Defaults**. - -Click **ADD** to open the WebDAV configuration screen. - -![WebDAVAddScreen](/images/CORE/Sharing/WebDAVAddScreen.png "Sharing WebDAV Add Screen") - -{{< truetable >}} -| Name | Description | -|----------|-------------| -| **Name** | Enter a name for the share. | -| **Description** | Optional. | -| **Path** | Browse to the pool or dataset to share. | -| **Read Only** | Select to prohibit users from writing to this share. | -| **Change User & Group Ownership** | Change existing ownership of all files in the share to user webdav and group webdav. Clearing the check mark means you must manually set ownership of the files accessed through WebDAV to the **webdav** or **www** user/group. | -| **Enabled** | Select to enable this WebDAV share. Leave checkbox clear to disable this WebDAV share without deleting it. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/Sharing/_index.md b/content/CORE/UIReference/Sharing/_index.md deleted file mode 100644 index ee1d02d319..0000000000 --- a/content/CORE/UIReference/Sharing/_index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Sharing" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/sharing/" -description: "Reference documentation for all screens within the Sharing menu option." -geekdocCollapseSection: true -weight: 110 -related: false ---- - -File sharing is a core benefit of a NAS. TrueNAS helps foster collaboration between users through network shares. -TrueNAS can use AFP, iSCSI shares, Unix NFS shares, Windows SMB shares, and WebDAV shares. - -
- -## Sharing Contents - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/UIReference/Sharing/iSCSI/FibreChannel.md b/content/CORE/UIReference/Sharing/iSCSI/FibreChannel.md deleted file mode 100644 index 018589b73b..0000000000 --- a/content/CORE/UIReference/Sharing/iSCSI/FibreChannel.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: "Fibre Channel" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/sharing/iscsi/fibrechannel/" -description: "Provides information about using Fibre Channel with TrueNAS CORE." -weight: 20 -aliases: /core/sharing/iscsi/fibrechannel/ -tags: -- iscsi ---- - -{{< enterprise >}} -Fibre Channel is an Enterprise feature in TrueNAS CORE. -Only TrueNAS systems licensed for Fibre Channel have the **Fibre Channel Ports** tab on the **Sharing > Block Shares (iSCSI)** screen. -{{< /enterprise >}} - - - -Fibre Channel is a high-speed data transfer protocol providing in-order, lossless delivery of raw block data. -Fibre Channel is primarily used to connect computer data storage to servers in storage area networks in commercial data centers. -The Fibre Channel protocol is fast, cost effective, and reliable over a wide variety of storage workloads. - -{{< expand "Which TrueNAS Products can use Fibre Channel?" "v" >}} - -* [TrueNAS R-Series](https://www.truenas.com/r-series/)(4x16 Gbps) -* [TrueNAS X-10](https://www.truenas.com/x-series/)(2x8 Gbps) -* [TrueNAS X-20](https://www.truenas.com/x-series/)(2x8 Gbps) -* [TrueNAS M-40](https://www.truenas.com/m-series/)(4x16 Gbps) -* [TrueNAS M-50](https://www.truenas.com/m-series/)(4x16 Gbps or 2x32 Gbps) -* [TrueNAS M-60](https://www.truenas.com/m-series/)(4x32 Gbps) - -{{< /expand >}} - -{{< hint type=note >}} -**Initiators** and **Authorized Access** screens only apply to iSCSI block shares and can be ignored when configuring Fibre Channel ports. -{{< /hint >}} - -## Fibre Channel Ports -The **Fibre Channel Ports** screen displays a table of ports configured on the TrueNAS. - -![FibreChannelPortsScreen](/images/CORE/Sharing/FibreChannelPortsScreen.png "Fibre Channel Ports Screen") - -Use the blue **Columns** button to display options to can change the **Fibre Channel** table display. Options are **Unselect All**, **WWPN**, **State** or **Reset to Defaults**. - -Click to expand the **Fibre Channel Ports** options. - -![FibreChannelPortsScreenExpanded](/images/CORE/Sharing/FibreChannelPortsScreenExpanded.png "Fibre Channel Ports Screen Expanded") - -### Fibre Channel Mode Settings -The **Mode** radio buttons display additional information on the screen based on the selection made. - -![FibreChannelPortConnectedInitiators12U8](/images/CORE/Sharing/FibreChannelPortConnectedInitiators12U8.png "Fibre Channel Port Connected Initiators") - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Initiator** | Sets the port as an initiator. Displays Connected Initiators on the right side of the screen for the selected target. | -| **Target** | Sets the port as a target. Dipslays the **Targets** dropdown list field on the right side of the screen. Select the port from the list. Connected Initiators for the selected target display below the dropdown field. | -| **Disabled** | Disables the selected Fibre Channel port. | -{{< /truetable >}} - -**SAVE** after making any setting change. - -## Targets Settings for Fibre Channels - -![Sharing ISCSI Targets Add Fibre](/images/CORE/Sharing/SharingISCSITargetsAddFibre.png "ISCSI Targets: Fibre") - -The **Targets > Add** screen **Target Mode** dropdown list includes options to select **iSCSI**, **Fibre Channel**, or **Both**. - -## Associated Target Settings for Fibre Channels - -![FibreChannelAssoicatedTargetsScreen](/images/CORE/Sharing/FibreChannelAssoicatedTargetsScreen.png "Fibre Channel Assoicated Targets Screen") - -The **Targets > Add** screen **Target Mode** dropdown list includes options to select **iSCSI**, **Fibre Channel**, or **Both**. diff --git a/content/CORE/UIReference/Sharing/iSCSI/_index.md b/content/CORE/UIReference/Sharing/iSCSI/_index.md deleted file mode 100644 index b8922c3904..0000000000 --- a/content/CORE/UIReference/Sharing/iSCSI/_index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "Block Shares (iSCSI)" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/sharing/iscsi/" -description: "Provides information about iSCSI terminology and configuration for TrueNAS CORE." -geekdocCollapseSection: true -weight: 20 -aliases: /core/sharing/iscsi/ -related: false ---- - -{{< include file="/static/includes/iSCSIRef.md" >}} - -
- -## Block Share (iSCSI) Contents -For more information on iSCSI shares also see: - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/UIReference/Sharing/iSCSI/iSCSIShare.md b/content/CORE/UIReference/Sharing/iSCSI/iSCSIShare.md deleted file mode 100644 index 991b40157d..0000000000 --- a/content/CORE/UIReference/Sharing/iSCSI/iSCSIShare.md +++ /dev/null @@ -1,319 +0,0 @@ ---- -title: "iSCSI Shares" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/sharing/iscsi/iscsishare/" -description: "Describes how to configure iSCSI block share on TrueNAS CORE." -weight: 10 -aliases: /core/sharing/iscsi/iscsishare/ -tags: -- iscsi ---- - -Users can configure an iSCSI block share using either the wizard or the individual configuration screens. The wizard steps users through the configuration process in an ordered sequence. Using the seven tabs on the **iSCSI** screen allows users to configure settings in any order they choose (a manual process). - -## iSCSI Wizard Configuration Screens - -The iSCSI Wizard configuration forms guide users through the process of setting up an iSCSI block share. Click **WIZARD** to display the first configuration screen. - -### Wizard Navigation - -Use **Next** to advance to the next wizard configuration form. -Use **Back** to return to a previous wizard configuration form. -Use **Cancel** to exit the configuration wizard. - -{{< expand "Wizard Configuration Screens and Settings" >}} -{{< expand "Create or Choose Block Device Screen Settings">}} - -### Create or Choose Block Device - -![SharingISCSIWizardDevice](/images/CORE/Sharing/SharingISCSIWizardDevice.png "iSCSI Wizard: Block Device") - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Name** | Type a lower case alphanumeric character string that can include a dot (.), dash (-), or colon (:). Keep the string short and do not exceed 63 characters. | -| **Extent Type** | Choose either **Device** or **File**. If selecting **Device** use a zvol created for the share. If selecting **File** also select the path to the extent and include the file size. | -| **Device** | Required field. Create New or select from devices listed | -| **Sharing Platform** | Select from the options provided:
**VMware: extent block size 512b, TCP enabled, no Xen compat mode, SSD speed**
**Xen: Extent block size 512b, TCP enabled, Xen compat mode enabled, SSD speed**
**Legacy OS: Extent block size 512b, TCP enabled, no Xen compat mode, SSD speed**
**Modern OS: Extent block size 4k, TCP enabled, no Xen compat mode, SSD speed**
Use Moderon OS for updated operating systems like Linux OS. | -{{< /truetable >}} -{{< /expand >}} -{{< expand "Portal Screen Settings" >}} - -### Portal - -The Wizard **Portal** configuration form includes only the **Portal** field unless you select **Create New** on the dropdown list. - -![iSCSIWizardPortalAfterCreateNewAndAddIPAddress](/images/CORE/Sharing/iSCSIWizardPortalAfterCreateNewAndAddIPAddress.png "iSCSI Wizard: Portal") - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Portal** | Select either **Create New** or an existing portal from the dropdown list. Selecting **Create New** displays the **Discovery Authentication Method**, **Discovery Authentication Group**, **IP Address** and **Port** fields. | -| **Discovery Authentication Method** | Required if creating a new portal. Select either **NONE**, **CHAP** or **Mutual CHAP** from the dropdown list. If **NONE** you can leave **Discovery Authentication Group** set to **NONE** as well. | -| **Discovery Authentication Group** | Required if the discovery authentication method is set to CHAP or MUTUAL CHAP. Select either **NONE** or **Create New** on the dropdown list. If **Discovery Authentication Method** is set to **NONE** you can select **NONE** here but if **Discovery Authentication Method** is set to **CHAP** or **MUTUAL CHAP** select **CREATE NEW**. This displays the **Group ID**, **User**, **Secret** and **Secret (Confirm)** configuration fields. | -| **Group ID** | Displays after selecting **Create New** in the **Discovery Authentication Group** field. Group IDs allow you to configure different groups with different authentication profiles. For example, all users with a group ID of 1 inherits the authentication profile associated with group 1. Type a number for the group ID. | -| **User** | Displays after selecting **Create New** in for the discovery authentication group. Type the name of the user account to create for the CHAP authentication with the user on the remote system. For example, you could use the initiator name as the user name. | -| **Secret** | Displays after selecting **Create New** as the discovery authentication group. Type a user password of at least 12 but no more than 16 characters. | -| **Secret (Confirm)** | Displays after selecting **Create New** as the discovery authentication group. Retype the user password entered into the **Secret** field. Click the icon to display the characters you typed to verify you typed the desired password string. Click to hide the password string. | -| **IP Address** | Select the IP address from the dropdown list. This is the IP address to list on the portal. Click **ADD** to add more IP addresses if desired or necessary. Click **DELETE** to remove any IP addresses and ports you added after clicking **ADD**. Use **0.0.0.0** to listen on all IPv4 addresses or use **::** to listen on all IPv6 IP addresses. | -| **Port** | Type the TCP port used to access the iSCSI target. The default port is **3260**. | -| **ADD** | Saves the selected IP address and allows the user to add another IP address. New IP address and port entry fields includes the **DELETE** button allows you to remove the new entry if necessary. | -| **DELETE** | Displays after clicking **ADD**. Removes the new IP address and port line created after clicking **ADD**. | -{{< /truetable >}} -{{< /expand >}} -{{< expand "Initiator Screen Settings" >}} - -### Initiator - -![SharingISCSIWizardInitiator](/images/CORE/Sharing/SharingISCSIWizardInitiator.png "iSCSI Wizard: Initiator") - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Initiators** | Leave blank to allow all host names or to enter a list of initiator host names. Use the keyboard Enter after entering each host name to save. | -| **Authorized Networks** | Network addresses allowed to use this initiator. Leave blank to allow all networks or list all network addresses with a CIDR mask. Separate each entry with the keyboard Enter. | -{{< /truetable >}} -{{< /expand >}} -{{< expand "Confirm Options Screen Settings" >}} - -### Confirm Options Form - -![SharingISCSIWizardSummary](/images/CORE/Sharing/SharingISCSIWizardSummary.png "iSCSI Wizard: Summary") - -Use **Back** to return to a previous configuration form to make any changes on that form. -Use **SUBMIT** to save the settings and the new iSCSI share. -{{< /expand >}} -{{< /expand >}} - -## Manual Setup Screens - -The manual configuration screens allow you to add or edit an iSCSI block share. -There are seven configuration screens accessed from tabs at the top of the **iSCSI** screen. -Unlike the wizard configuration option, you can move from one screen to another in any sequence. - -{{< expand "Manual Configuration Screens and Settings" >}} -{{< expand "Target Global Configuration Tab" >}} - -The **Target Global Configuration** screen allows user to add or edit global configuration settings that apply to all iSCSI shares. - -![SharingISCSIManualTargetGlobalConfig](/images/CORE/Sharing/SharingISCSIManualTargetGlobalConfig.png "iSCSI Target Global Configuration") - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Base Name** | Lowercase alphanumeric characters plus dot (.), dash (-), and colon (:) are allowed. See the "Constructing iSCSI names using the *iqn.format*" section of [RFC3721](https://tools.ietf.org/html/rfc3721.html). | -| **ISNS Servers** | Host names or IP addresses of the ISNS servers to register with the iSCSI targets and portals of the system. Use keyboard Enter. to separate entries. | -| **Pool Available Space Threshold (%)** | Generates an alert when the pool has this percent space remaining. It is typical to configure this at the pool level when using zvols or at the extent level for both file and device-based extents. | -{{< /truetable >}} - -Click **SAVE** before leaving the global configuration settings screen. -{{< /expand >}} -{{< expand "Portals Tab" >}} - -The **Portals** screen displays a list of configured portals. It lets users create new portals or edit the existing ones in the list. -Use the blue **Columns** dropdown list to display a list of available options to add or remove columns in the **Portals** table. Select from **Unselect All**, **Listen**, **Description**, **Discovery Auth Method**, **Discover Auth Group** or **Reset to Defaults** to reverse any changes you made to the table. - -![SharingISCSIManualPortals](/images/CORE/Sharing/SharingISCSIManualPortals.png "iSCSI Portal") - -Use **ADD** to display the **Portals Add** configuration form. -Click the icon for the portal and select **Edit** to display the **Portal Edit** configuration form. -Both the **Add** and **Edit** forms have the same settings fields. - -![SharingISCSIManualPortalsForm](/images/CORE/Sharing/SharingISCSIManualPortalsForm.png "iSCSI Portals Form") - -**Basic Info** - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Description** | Optional description. Portals are automatically assigned a numeric group. | -{{< /truetable >}} - -**Authentication Method and Group** - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Discovery Authentication Method** | iSCSI supports multiple authentication methods that the target uses to discover valid devices. **None** allows anonymous discovery while **CHAP** and **Mutual CHAP** require authentication. | -| **Discovery Authentication Group** | Group ID created in Authorized Access. Required when the discovery authentication method is CHAP or Mutual CHAP. | -{{< /truetable >}} - -**IP Address** - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **IP Address** | Select the IP addresses the portal uses to listened on. Click **ADD** to add IP addresses with a different network port. **0.0.0.0** listens on all IPv4 addresses and **::** listens on all IPv6 addresses. | -| **Port** | TCP port used to access the iSCSI target. Default is **3260**. | -| **ADD** | Adds another IP address row. | -{{< /truetable >}} -{{< /expand >}} -{{< expand "Initiators Groups Tab" >}} - -The **Initiators Groups** screen displays a lis of configured initiators. It lets users create new authorized access client groups or edit existing ones on the list. -Use the blue **Columns** dropdown list to display a list of available options to add or remove columns in the **Initiator Groups** table. Select from **Unselect All**, **Initiators**, **Authorized Networks**, **Description** or **Reset to Defaults** to reverse any changes you made to the table. - -![SharingISCSIManualInitiators](/images/CORE/Sharing/SharingISCSIManualInitiators.png "iSCSI Initiators Groups") - -Use **ADD** to display the **Initiators Add** configuration screen. -Click the icon for the initiator and select **Edit** to display the **Initiators Edit** configuration form. -Both the **Add** and **Edit** forms have the same settings fields. - -![iSCSIAddInitiators](/images/CORE/Sharing/iSCSIAddInitiators.png "iSCSI Add Initiators") - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Connected Initiators** | Initiators currently connected to the system, displayed in the IQN format with an IP address. Set initiators and click an to add the initiators to either the **Allowed Initiators** or **Authorized Networks** lists. Click **Refresh** to update the list of connected initiators. | -| **Allow All Initiators** | Allows all initiators when selected. If not selected, configure your own allowed initiators and authorized networks. | -| **Allowed Initiators (IQN)** | Initiators allowed access to this system. Enter an [iSCSI Qualified Name (IQN)](https://tools.ietf.org/html/rfc3720#section-3.2.6) and click the to add it to the list. Example: *iqn.1994-09.org.freebsd:freenas.local*. | -| **Authorized Networks** | Network addresses allowed use this initiator. Each address can include an optional [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) netmask. Click to add the network address to the list. Example: *192.168.2.0/24*. | -| **Description** | Enter any notes about initiators. | -| **REFRESH** | Refreshes the list displayed in **Connected Initiators**.| -| **SAVE** | Saves changes made on the **Add** or **Edit** initiator screens. | -| **CANCEL**| Discards changes made on and closes the **Add** or **Edit** initiator screens. | -{{< /truetable >}} -{{< /expand >}} -{{< expand "Authorized Access Tab" >}} - -The **Authorized Access** screen displays a list of authorized access networks. It lets users create new authorized access networks or edit existing ones in the list. -Use the blue **Columns** dropdown list to display a list of available options to add or remove columns in the **Initiator Groups** table. Select from **Unselect All**, **User**, **Peer User** or **Reset to Defaults** to reverse any changes you made to the table. - -![SharingISCSIManualAuthorizedAccess](/images/CORE/Sharing/SharingISCSIManualAuthorizedAccess.png "iSCSI Authorized Access") - -Use **ADD** to display the **Authorized Access Add** configuration screen. -Click the icon for the authorized access and select **Edit** to display the **Authorized Access Edit** configuration form. -Both the **Add** and **Edit** forms have the same settings fields. - -![SharingISCSIManualAuthorizedAccessForm](/images/CORE/Sharing/SharingISCSIManualAuthorizedAccessForm.png "iSCSI Authorized Access Form") - -**Group** - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Group ID** | Allow you to configure different groups with different authentication profiles. For example, all users with a group ID of *1* inherit the authentication profile associated with Group *1*. | -{{< /truetable >}} - -**User** - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **User** | User account to create for CHAP authentication with the user on the remote system. Many initiators use the initiator name as the user name. | -| **Secret** | User password of at least 12 but no more than 16 characters. Click the icon to display the characters you typed to verify you typed the desired password string. Click to hide the password string. | -| **Secret (Confirm)** | Confirm the user password. | -{{< /truetable >}} - -**Peer User** - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Peer User** | Only entered when configuring mutual CHAP. Usually the same value as **User**. | -| **Peer Secret** | Mutual secret password. Required when Peer User is set up. Must be different than the password used in **Secret**. Click the icon to display the characters you typed to verify you typed the desired password string. Click to hide the password string. | -| **Peer Secret (Confirm)** | Confirm the mutual secret password. | -{{< /truetable >}} - -{{< /expand >}} -{{< expand "Targets Tab" >}} - -The **Targets** screen displays a list of storage resources configured in the system. It lets users create new TrueNAS storage resources or edit existing ones in the list. -Use the blue **Columns** dropdown list to display a list of available options to add or remove columns in the **Targets** table. Select from **Unselect All**, **Target Alias** or **Reset to Defaults** to reverse any changes you made to the table. - -![SharingISCSIManualTargets](/images/CORE/Sharing/SharingISCSIManualTargets.png "iSCSI Targets") - -Use **ADD** to display the **Targets Add** configuration screen. -Click the icon for the target and select **Edit** to display the **Targets Edit** configuration form. -Both the **Add** and **Edit** forms have the same settings fields. - -![SharingISCSIManualTargetsForm](/images/CORE/Sharing/SharingISCSIManualTargetsForm.png "iSCSI Targets Form") - -**Basic Info** - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Target Name** | The base name for the target. It is automatically prepended if the target name does not start with **iqn**. Allowed characters are lowercase alphanumeric characters plus dot (.), dash (-), and colon (:). See the "Constructing iSCSI names using the iqn.format" section of [RFC3721](https://tools.ietf.org/html/rfc3721.html). | -| **Target Alias** | Optional user-friendly name for the **Target Name**. | -{{< /truetable >}} - -**iSCSI Group** - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Portal Group ID** | Leave empty or select an existing portal to use. If you click the dropdown arrow, you must select a portal group ID from the list. | -| **Initiator Group ID** | Select the existing initiator group that has access to the target. Leave empty if **Portal Group ID** is empty. | -| **Authentication Method** | Select **None**, **CHAP**, or **Mutual CHAP**. | -| **Authentication Group Number** | Select **None** or an integer. This value represents the number of existing authorized accesses. | -{{< /truetable >}} -{{< /expand >}} -{{< expand "Extents Tab" >}} - -The **Extents** screen displays a list of available shared storage units configured on the system. It lets users create new shared storage units or edit existing ones in the list. -Use the blue **Columns** dropdown list to display a list of available options to add or remove columns in the **Extents** table. Select from **Unselect All**, **Description**, **Serial**, **NAA**, **Enabled** or **Reset to Defaults** to reverse any changes you made to the table. - -![SharingISCSIManualExtents](/images/CORE/Sharing/SharingISCSIManualExtents.png "iSCSI Extents") - -Use **ADD** to display the **Extents Add** configuration screen. -Click the icon for the shared storage unit and select **Edit** to display the **Extents Edit** configuration form. -Both the **Add** and **Edit** forms have the same settings fields. - -![SharingISCSIManualExtentsForm](/images/CORE/Sharing/SharingISCSIManualExtentsForm.png "iSCSI Extents Form") - -**Basic Info** - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Name** | Name of the extent. An extent with a size of zero can be an existing file within the pool or dataset. An extent with a size other than zero cannot be an existing file within the pool or dataset. | -| **Description** | Type any notes about this extent. | -| **Enabled** | Select to enable the iSCSI extent. | -{{< /truetable >}} - -**Type** - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Extent Type** | Specify the storage unit type. Select **Device** or **File** from the dropdown list. **Device** provides virtual storage access to zvols, zvol snapshots, or physical devices. **File** provides virtual storage access to a single file. | -| **Device** | Only displays only if **Device** is the selected in **Extent Type**. Select the unformatted disk, controller, or zvol snapshot. | -| **Path to the Extent** | Only displays if the **Extent Type** is set to **File**. Browse to an existing file. Create a new file by browsing to a dataset and appending /\{filename.ext\} to the path. Users cannot create extents inside a jail root directory. | -| **Filesize** | Only displays if the **Extent Type** is set to **File**. Enter **0** to use the actual file size and it requires that the file already exists. Otherwise, specify the file size for the new file. | -| **Logical Block Size** | Leave at the default of **512** unless the initiator requires a different block size. Select from **512**, **1024**, **2048** or **4096** on the dropdown list.| -| **Disable Physical Block Size Reporting** | Select if the initiator does not support physical block size values over 4K (MS SQL). | -{{< /truetable >}} - -**Compatibility** - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Enable TPC** | Select to allow an initiator to bypass normal access control and access any scannable target. This allows [xcopy](https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/cc771254(v=ws.11)) operations that are otherwise blocked by access control. | -| **Xen initiator compat mode** | Select when using Xen as the iSCSI initiator. | -| **LUN RPM** | *Do not* change this setting when using Windows as the initiator! Only change the default **SSD** setting if in a large environment where you need a number of systems using a specific RPM for accurate reporting statistics. Options are **SSD**, **5400**, **7200**, **10000** or **15000**. | -| **Read-only** | Select to prevent the initiator from initializing this LUN. | -{{< /truetable >}} -{{< /expand >}} -{{< expand "Associated Targets Tab" >}} - -The **Associated Targets** screen displays a list of associated TrueNAS storage resources configured on the system. It lets users create new associated TrueNAS storage resources or edit existing ones in the list. -Use the blue **Columns** dropdown list to display a list of available options to add or remove columns in the **Associated Targets** table. Select from **Unselect All**, **LUN ID**, **Extent** or **Reset to Defaults** to reverse any changes you made to the table. - -![SharingISCSIManualAssociatedTargets](/images/CORE/Sharing/SharingISCSIManualAssociatedTargets.png "iSCSI Associated Targets") - -Use **ADD** to display the **Associated Targets Add** configuration screen. -Click the icon for the associated TrueNAS storage resource and select **Edit** to display the **Associated Targets Edit** configuration form. -Both the **Add** and **Edit** forms have the same settings fields. - -![SharingISCSIManualAssociatedTargetsForm](/images/CORE/Sharing/SharingISCSIManualAssociatedTargetsForm.png "iSCSI Associated Targets Form") - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Target** | Select an existing target. This is a required field. | -| **LUN ID** | Select the value or enter a value between 0 and 1023. Some initiators expect a value below 256. Leave this field blank to automatically assign the next available ID. | -| **Extent** | Select an existing extent. This is a required field. | -{{< /truetable >}} -{{< /expand >}} -{{< /expand >}} diff --git a/content/CORE/UIReference/Storage/DisksScreens.md b/content/CORE/UIReference/Storage/DisksScreens.md deleted file mode 100644 index 80ff78f303..0000000000 --- a/content/CORE/UIReference/Storage/DisksScreens.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "Disks Screens" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/storage/disksscreens/" -description: "Describes the fields in the Disk Screens in TrueNAS CORE." -weight: 40 -aliases: -- /core/uireference/storage/disks/disksscreens/ -- /core/uireference/storage/disks/ -tags: -- disks -- storage ---- - -Use the **Storage > Disks** screen to add or manage disks in your TrueNAS. - -![StorageDisksScreen](/images/CORE/Storage/StorageDisksScreen.png "Storage Disks Screen") - -Use the blue **Columns** button to display a list of options to modify the information displayed in the list of disks. - -Use the arrow_forward_ios expand symbol to the right of any disk on the list to expand that disk to show settings and actions for that disk. - -## Disk Information Screen -The **Disks** individual disk information screen includes details about the disk settings and status. It also provides access to disk actions the user can take. - -![StorageDiskInformationScreen](/images/CORE/Storage/StorageDiskInformationScreen.png "Storage Disk Information Screen") - -Use **EDIT** to display the **Edit Disk** screen. - -Use **MANUAL TEST** to display the **Manual S.M.A.R.T. Tests** dialog where you can specify the type of test as **LONG**, **SHORT**, **CONVEYANCE** or **OFFLINE**. - -Use **S.M.A.R.T. TEST RESULTS** to display the results of any S.M.A.R.T. tests executed on the system. - -Use **WIPE** to delete obsolete data off an unused disk. This option does not display unless your disk is unused. See [Wiping a Disk]({{< relref "/CORE/CORETutorials/Storage/Disks/DiskWipe.md" >}}) for more information on how to use this function. - -## Edit Disk Screen -The settings on the **Edit Disk** are the same as those on the **Add Disk** screen. - -![StorageDisksEditScreen](/images/CORE/Storage/StorageDisksEditScreen.png "Storage Disks Edit Screen") - -{{< truetable >}} -| Settings | Description| -|----------|------------| -| **Name** | Enter the FreeBSD disk device name. For example, *ada0*. | -|**Serial** | Enter the serial number for this disk. | -| **Description** | Enter notes or a description for this disk. For example, where it is located or what it is used for. | -| **HDD Standby** | Select the option from the dropdown list for the minutes of inactivity before the drive enters standby mode. Select from **Always On** or the minutes in a range from **5** to **330**. See [this forum post](https://forums.freenas.org/index.php?threads/how-to-find-out-if-a-drive-is-spinning-down-properly.2068/) for information on identifying spun down drives. Temperature monitoring is disabled for standby disks. | -| **Force HDD Standby** | Select to allow the drive to enter standby, even when non-physical S.M.A.R.T. operations could prevent the drive from sleeping. | -| **Advanced Power Management** | Select an option from the dropdown list to select a power management profile from the menu. Options are **Disabled**, **Level 1 - Minimum power usage with Standby (spindown)**, **Level 64 - Intermediate power usage with Standby**, **Level 127 - Maximum power usage with Standby**, **Level 128 - Minimum with power usage without Standby (no spindown)**, **Level 192 - Intermediate power usage without Standby**, **Level 254 - Maximum performance, maximum power usage**. | -| **Acoustic Level** | Select the option from the dropdown list to modify disks that understand [AAM](https://en.wikipedia.org/wiki/Automatic_acoustic_management) Options are **Disabled**, **Minimum**, **Medium** or **Maximum**. | -| **Enable S.M.A.R.T.** | Select to enable allowing the system to conduct periodic [S.M.A.R.T. tests](https://www.truenas.com/docs/core/coretutorials/tasks/runningsmarttests/). | -| **S.M.A.R.T. extra opitons** | Enter additional [smartctl(8)](https://www.unix.com/man-page/suse/8/smartctl/) options. | -| **Critical** | Enter a numeric value to set the threshold temperature in Celsius. If the drive temperature is higher than this value, a LOG_CRIT level log entry is created and an email i s sent. **0** disables this check. | -| **Difference** | Enter a value where the the system reports if the drive temperature changed by this many degrees Celsius since the last report. **0** disables the report. | -| **Informational** | Enter a value where the system reports if the drive temperature is at or above this temperature in Celsius. **0** disables this report. | -| **SED Password** | Use to set or change the password of this SED. This password is used insead of the global SED password. | -| **Clear SED Password** | Select to chear the SED password for this disk. | -{{< /truetable >}} - -Use **SAVE** to save settings and return the **Disks** screen or use **CANCEL** to exit without saving. - -## Import Disk Screen - -Use the **Import Disk** screen to perform a one time disk import, only one disk at a time, on you TrueNAS system. - -![StorageImportDiskScreen](/images/CORE/Storage/StorageImportDiskScreen.png "Storage Import Disk Screen") - -{{< truetable >}} -| Settings | Description| -|----------|------------| -| **Disk** | Select the disk to import from the dropdown list. The import copies the data from the selected disk to an existing ZFS dataset. Only one disk can be imported at a time. This is a required field. | -| **Filesystem type** | Select one radio button option to specity the file system type that is on the disk to import. Options are **UFS**, **NTFS**, **MSDOSFS** or **EXT2FS**. | -| **Destination Path** | Browse to locate the dataset on the TrueNAS that is to hold the copied data. | -{{< /truetable >}} - -The **SAVE** button activates after required fields are populated. - -See [Import Disks]({{< relref "/CORE/CORETutorials/Storage/ImportDisk.md" >}}) for more information on importing a disk into your TrueNAS. diff --git a/content/CORE/UIReference/Storage/Pools/COREQuotaScreens.md b/content/CORE/UIReference/Storage/Pools/COREQuotaScreens.md deleted file mode 100644 index 5f9a548ce3..0000000000 --- a/content/CORE/UIReference/Storage/Pools/COREQuotaScreens.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "User and Group Quota Screens" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/storage/pools/corequotascreens/" -description: "Describes CORE Dataset User and Group Quota screen settings and functions." -weight: 18 -tags: - - accounts ---- - -TrueNAS allows setting data or object quotas for user accounts and groups cached on or connected to the system. -Go to **Storage > Pools**, find the desired dataset, and click to open the **Dataset Actions** menu and see the **User Quota** and **Group Quota** options. - -## User Quotas Screen - -Clicking **User Quotas** from the **Dataset Actions** menu shows the **User Quotas** screen. - -![UserQuotasScreenNoQuotas](/images/CORE/Storage/UserQuotasScreenNoQuotas.png "User Quotas Screen") - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| Filter User Quotas | Enter a string to show saved quotas that match the string. | -| Columns | Displays options to customize the table view to add or remove information. Options are **Select All**, **ID**, **Data Quota**, **DQ Used**, **DQ % Used**, **Object Quota**, **Objects Used**, **OQ % Used**, and **Reset to Defaults**. After selecting **Select All** the option toggles to **Unselect All**. | -| Actions | Shows additional options to manage or add entries to this screen. | -{{< /truetable >}} - -### Actions - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| Toggle Display | Changes the view between filter and list views. By default, only user accounts with a quota are shown (filter view). Switching to the list view shows all available users, even if the user has no quota assigned. | -| Set Quotas (Bulk) | Opens the **Set User Quotas** screen to add quotas. | -{{< /truetable >}} - -### User Expanded View - -Click the expand_more icon to display a detailed individual user quota view. - -![UserQuotasRootUserExpanded](/images/CORE/Storage/UserQuotasRootUserExpanded.png "User Quota Expanded View") - -Click the edit **Edit** button to display the **[Edit User](#edit-user-configuration-window)** window. - -### Edit User Configuration Window - -The **Edit User** window allows modifying individual user data and object quota values. - -![EditUserQuotaWindow](/images/SCALE/Credentials/EditUserQuotaWindow.png "Edit User Quota") - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **User** | Displays the name of the selected user. | -| **User Data Quota (Examples: 500KiB, 500M, 2 TB)** | Enter the amount of disk space the selected user can use. Entering **0** allows the user to use all disk space. You can enter human-readable values such as 50 GiB, 500M, 2 TB, etc.). If units are not specified, the value defaults to bytes. | -| **User Object Quota** | Enter the number of objects the selected user can own. Entering **0** allows unlimited objects. | -{{< /truetable >}} - -Click **Set Quota** to save changes or **Cancel** to close the window without saving. - -## Set User Quotas Screen - -Click **Actions > Set Quotas (Bulk)** to see the **Set User Quotas** screen. - -![SetUserQuotasScreen](/images/CORE/Storage/SetUserQuotasScreen.png "Set User Quotas") - -### Set Quotas Settings - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **User Data Quota (Examples: 500KiB, 500M, 2 TB)** | Enter the amount of disk space the selected user can use. Entering **0** allows the user to use all disk space. You can enter human-readable values such as 50 GiB, 500M, 2 TB, etc.). If units are not specified, the value defaults to bytes. | -| **User Object Quota** | Enter the number of objects the selected user can own. Entering **0** allows unlimited objects. | -{{< /truetable >}} - -### Apply Quotas to Selected Users Settings - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **Select Users Cached by this System** | Select the users from the dropdown list of options. | -| **Search for Connected Users** | Click in the field to see the list of users on the system or type a user name and press Enter. A clickable list displays of found matches as you type. Click on the user to add the name. A warning dialog displays if there are not matches found. | -{{< /truetable >}} - -Click **Submit** to set the quotas or **Cancel** to exit without saving. - -## Group Quotas Screens - -Clicking **Group Quotas** from the **Dataset Actions** menu shows the **Edit Group Quotas** screen. - -![EditGroupQuotasNoGroups](/images/CORE/Storage/EditGroupQuotasNoGroups.png "Group Quotas Screen") - -The **Edit Group Quotas** screen displays the names and quota data of any groups cached on or connected to the system. - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| Filter Group Quotas | Enter a string to show saved quotas that match the string. | -| Columns | Displays options to customize the table view to add or remove information. Options are **Select All**, **ID**, **Data Quota**, **DQ Used**, **DQ % Used**, **Object Quota**, **Objects Used**, **OQ % Used**, and **Reset to Defaults**. After selecting **Select All** the option toggles to **Unselect All**. | -| Actions | Shows additional options to manage or add entries to this screen. | -{{< /truetable >}} - -### Actions - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| Toggle Display | Changes the view between filter and list views. By default, only group accounts with a quota are shown (filter view). Switching to the list view shows all available groups, even if the group has no quota assigned. | -| Set Quotas (Bulk) | Opens the **Set Group Quotas** screen to add quotas. | -{{< /truetable >}} - -### Group Expanded View - -Click the expand_more icon to display a detailed individual group quota view. - -![EditGroupQuotasExpandedView](/images/CORE/Storage/EditGroupQuotasExpandedView.png "Group Quotas Expanded View") - -Click the edit **Edit** button to display the **[Edit Group](#edit-group-configuration-window)** window. - -### Edit Group Configuration Window -The **Edit Group** window allows you to modify the group data quota and group object quota values for an individual group. - -![EditGroupQuotaWindow](/images/SCALE/Credentials/EditGroupQuotaWindow.png "Edit Group Quota") - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **Group** | Displays the name of the selected group(s). | -| **Group Data Quota (Examples: 500KiB, 500M, 2 TB)** | Enter the amount of disk space the selected group can use. Entering **0** allows the group to use all disk space. You can enter human-readable values such as 50 GiB, 500M, 2 TB, etc.). If units are not specified, the value defaults to bytes. | -| **Group Object Quota** | Enter the number of objects the selected group can own or use. Entering **0** allows unlimited objects. | -{{< /truetable >}} - -Click **Set Quota** to save changes or **Cancel** to close the window without saving. - -### Set Group Quotas Screen - -Click **Actions > Set Quotas (Bulk) ** to see the **Set Group Quotas** screen. - -![SetGroupQuotasScreen](/images/CORE/Storage/SetGroupQuotasScreen.png "Set Group Quotas") - -#### Set Quotas Settings - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **Group Data Quota (Examples: 500KiB, 500M, 2 TB)** | Enter the amount of disk space the selected group can use. Entering **0** allows the group to use all disk space. You can enter human-readable values such as 50 GiB, 500M, 2 TB, etc.). If units are not specified, the value defaults to bytes. | -| **Group Object Quota** | Enter the number of objects the selected group can own or use. Entering **0** allows unlimited objects. | -{{< /truetable >}} - -#### Apply Quotas to Selected Groups Settings - -{{< truetable >}} -| Settings | Description | -|----------|-------------| -| **Select Groups Cached by this System** | Select the users from the dropdown list of options. | -| **Search for Connected Groups** | Click in the field to see the list of groups on the system or type a group name and press Enter. A clickable list displays of found matches as you type. Click on the group to add the name. A warning dialog displays if there are no matches found. | -{{< /truetable >}} - -Click **Submit** to set the quotas or **Cancel** to exit without saving. diff --git a/content/CORE/UIReference/Storage/Pools/DatasetsScreen.md b/content/CORE/UIReference/Storage/Pools/DatasetsScreen.md deleted file mode 100644 index f5d42f9577..0000000000 --- a/content/CORE/UIReference/Storage/Pools/DatasetsScreen.md +++ /dev/null @@ -1,162 +0,0 @@ ---- -title: "Datasets Screens" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/storage/pools/datasetsscreen/" -description: "Describes how to configure a dataset on TrueNAS CORE." -weight: 17 -tags: -- datasets -- acl ---- - -Use the **Storage > Pools Add Dataset** screen to add a dataset to your TrueNAS. A TrueNAS dataset is a file system that is created within a data storage pool. There are two settings options, **BASIC OPTIONS** and **ADVANCED OPTIONS**. Use the basic option unless you want to customize your dataset for specific uses cases. - -## Add Dataset Screen - -### Dataset Basic Options - -{{< trueimage src="/images/CORE/Storage/AddDatasetBasicOptionsScreen.png" alt="Add Dataset Screen" id="Add Dataset Screen" >}} - -Use **SUBMIT** without entering settings to quickly create a dataset with the default options or after entering settings to save and create the dataset. - -#### Name and Options -The **Name and Options** fields are required to create the dataset. -Datasets typically inherit most of these settings from the root or parent dataset, only a dataset name is required before clicking **SUBMIT**. - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Name** | Enter a unique identifier for the dataset. The name cannot be changed after the dataset is created. | -| **Comments** | Enter notes about the dataset. | -| **Sync** | Select an option from the dropdown list. Select **Standard** uses the sync settings requested by the client software. Select **Always** to wait for data writes to complete, or select **Disabled** to never wait for writes to complete. | -| **Compression level** |Select an option to encode information in less space than the original data occupies. It is recommended to choose a compression algorithm that balances disk performance with the amount of saved space:
**lz4** is generally recommended as it maximizes performance and dynamically identifies the best files to compress.
**zstd** is the [Zstandard](https://tools.ietf.org/html/rfc8478) compression algorithm that has several options for balancing speed and compression.
**gzip** options range from **1** for least compression, best performance, through **9** for maximum compression with greatest performance impact.
**zle** is a fast algorithm that only eliminates runs of zeroes.
**lzjb** is a legacy algorithm that is not recommended for use. | -| **Enable Atime**| Select an option from the dropdown list. **Inherit (off)** inherits from the pool. **on** updates the access time for files when they are read. **off** disables creating log traffic when reading files to maximize performance. | -| **Encryption** | Select **Inherit (non-encrypted)** to inherit the root or parent dataset encryption properties. Clear the checkmark to either not encrypt the dataset or to configure encryption settings other than those used by the root or parent dataset. See [Encryption]({{< relref "/CORE/CORETutorials/Storage/Pools/StorageEncryption.md" >}}) for more information on encryption. | -{{< /truetable >}} - -#### Other Options -Use the **Other Options** to help tune the dataset for particular data sharing protocols: - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **ZFS Deduplication** | Select an option to transparently reuse a single copy of duplicated data to save space from the dropdown list. Options are **Inherit (off)**, **on**, **verify** or **off**. Deduplication can improve storage capacity, but is RAM intensive. Compressing data is generally recommended before using deduplication. Deduplicating data is a one-way process. *Deduplicated data cannot be undeduplicated! | -| **Case Sensitivity** | Select an option from the dropdown list. **Sensitive** assumes file names are case sensitive. **Insensitive** assumes file names are not case sensitive. **Mixed** understands both types of file names. Case sensitivity cannot be changed after the dataset is created! | -| **Share Type** | Select an option from the dropdown list to define the type of data sharing the dataset uses to optimize the dataset for that sharing protocol. Options are **Generic** or **SMB**. AFP type shares use **SMB** unless directed to select **Generic**. The type of share cannot be changed after the dataset is created! | -{{< /truetable >}} - -### Dataset Advanced Options - -Use **ADVANCED OPTIONS** to add additional dataset settings such as quota management tools, basic ACL permissions and a few additional **Other Options** settings fields. - -{{< trueimage src="/images/CORE/Storage/AddDatasetAdvancedOptionsTop.png" alt="Add Dataset Advanced Options" id="Add Dataset Advanced Options" >}} - -#### Quota Settings for this dataset and/or this dataset and its child datasets - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Quota for this datset** | Enter an integer to define the maximum allowed space for the dataset. **0** disables quotas. | -| **Quota warning alert at, %** | Enter an integer to generate a warning level [alert]({{< relref "/CORE/UIReference/System/AlertSettings.md" >}}) when consumed space reaches the defined percentage. By default, **Inherit** is selected and the dataset inherits this value from the parent dataset. Clear the checkmark to change the value. | -| **Quota critical alert at, %** | Enter an integer to generate a critical level [alert]({{< relref "/CORE/UIReference/System/AlertSettings.md" >}}) when consumed space reaches the defined percentage. By default, **Inherit** is selected and the dataset inherits this value from the parent dataset. Clear the checkmark to change the value. | -| **Reserved space for this dataset** | Enter an integer to reserve additional space for datasets that contain logs which could eventually take up all the available free space. **0** is unlimited. | -{{< /truetable >}} - -{{< trueimage src="/images/CORE/Storage/AddDatasetAdvancedOptionsScreenBottom.png" alt="Add Dataset Advanced Options 2" id="Add Dataset Advanced Options 2" >}} - -#### Other Options -Additional **Other Options** settings - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Read-only** | Select an option from the dropdown list. **On** prevents the dataset being modified. **Off** allows users accessing the dataset to modify its contents. | -| **Exec** | Select an option from the dropdown list. **On** allows processes to executd from within this dataset. **Off** prevents processes from executing in the dataset. It is recommended to set to **On**. | -| **Snapshot directory** | Select an option to control visibility of the .zfs directory on the dataset. Options are **Visible** or **Invisible**. | -|**Copies** | Select an option from the dropdown list to specify the number of duplicate ZFS user data copies stored on this dataset. Choose between **1**, **2**, or **3** redundant data copies. This can improve data protection and retention, but is not a substitute for storage pools with disk redundancy. | -| **Record Size** | Select an option from the dropdown list for the Logical block size in the dataset. Matching the fixed size of data, as in a database, could result in better performance. | -| **ACL Mode**| Select an option from the dropdown list to determine how [chmod](https://www.freebsd.org/cgi/man.cgi?query=chmod) behaves when adjusting file ACLs. See the [zfs](https://www.freebsd.org/cgi/man.cgi?query=zfs) `aclmode` property.
**Passthrough** only updates ACL entries that are related to the file or directory mode.
**Restricted** does not allow chmod to make changes to files or directories with a non-trivial ACL. An ACL is trivial if it can be fully expressed as a file mode without losing any access rules. **Restricted** is typically used to optimize a dataset for SMB sharing, but can require further optimizations. For example, configuring an [rsync task]({{< relref "/CORE/CORETutorials/Tasks/CreatingRsyncTasks.md" >}}) with this dataset could require adding `--no-perms` in the Rsync task **Auxiliary Parameters** field. | -| **Metadata (Special) Small Block Size** | Enter an integer for the threshold block size for including small file blocks into the [special allocation class (fusion pools)]({{< relref "/CORE/CORETutorials/Storage/Pools/FusionPool.md" >}}). Blocks smaller than or equal to this value are assigned to the special allocation class while greater blocks are assigned to the regular class. Valid values are zero or a power of two from 512B up to 1M. The default size **0** means no small file blocks are allocated in the special class. Add a [special class vdev]({{< relref "/CORE/CORETutorials/Storage/Pools/FusionPool.md" >}}) to the pool before setting this property. | -{{< /truetable >}} - -## Edit Datasets Screen - -Use the **Storage > Pools Edit Dataset** screen to change setting for an existing dataset. The settings are identical to the **Add Dataset** screens above. to access the **Edit Dataset** screens, click the   for a dataset and select **Edit Options**. - -### Dataset Edit Permissions Screen - -Use the **Storage > Pools Edit Permissions** screen to change permissions settings for a parent dataset. To access the **Edit Permissions** screens, click the   for a dataset and select **Edit Options**. - -{{< trueimage src="/images/CORE/Storage/DatasetEditPermissionsScreen.png" alt="Edit Permissions Screen" id="Edit Permissions Screen" >}} - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Dataset Path** | Displays the dataset path for the selected dataset. | -{{< /truetable >}} - -#### Owner Settings - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **User** | Either type to search for or use dropdown list to select an existing user on the system that controls this dataset. Dropdown list displays all user on the TrueNAS system. | -| **Apply User** | Select to confirm selected user. As a check on errors, if not selected the user is not submitted. | -| **Group** | Either type to search for or use dropdown list to select an existing group on the system that controls this dataset. Dropdown list displays all user on the TrueNAS system. | -| **Apply Group** | Select to confirm selected group. As a check on errors, if not selected the group is not submitted. | -{{< /truetable >}} - -#### Access Settings - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Access Mode** | Select the **Read**, **Write** and **Execute** checkboxes for **User**, **Group**, and **Other** to set the permissions levels. | -{{< /truetable >}} - -#### Advanced Settings - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Apply Permissions Recursively** | Select to apply permissions recursively to all directories and files within the current dataset. | -| **Traverse** | Select to apply permissions recursively to all child datasets of the current dataset. | -{{< /truetable >}} - -### USE ACL Manager Screen - -Click **USE ACL MANAGER** to open the ACL editor to further customize permissions. After selecting the **Select a preset ACL** radio buttons on the **Create an ACL** dialog, select a **Default ACL Option** from the dropdown list. Options are **OPEN**, **Restricted** or **HOME**. Or **Create a custom ACL** and then click **CONTINUE** to display the **Edit ACL** screen with the default permissions for the option you selected. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsEditACLTop.png" alt="Edit ACL Screen Top" id="Edit ACL Screen Top" >}} - -{{< trueimage src="/images/CORE/Storage/StoragePoolsEditACLBottom.png" alt="Edit ACL Screen Bottom" id="Edit ACL Screen Bottom" >}} - -#### File Information Settings - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Path** | Displays the dataset path for the selected dataset. | -| **User** | Either type to search for or use dropdown list to select an existing user on the system that controls this dataset. Dropdown list displays all user on the TrueNAS system. | -| **Apply User** | Select to confirm selected user. As a check on errors, if not selected the user is not submitted. | -| **Group** | Either type to search for or use dropdown list to select an existing group on the system that controls this dataset. Dropdown list displays all user on the TrueNAS system. | -| **Apply Group** | Select to confirm selected group. As a check on errors, if not selected the group is not submitted. | -{{< /truetable >}} - -#### Access Control List Settings - owner@, group@ and everyone@ - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Who** | Select from the dropdown list of options. Default for each of the three groups of settings is **owner@**, **group@** and **everyone@** but you can change this to either of these additional options **User** or **Group**. Selection modifies values displayed in other settings. | -| **ACL Type** | Select either **Allow** or **Deny** from the dropdown list to specify how permissions apply to the value selected in **Who**. Select **Allow** to grant the specified permissions or **Deny** to restrict the specified permissions. | -| **Permissions Type** | Select either **Basic** or **Advanced** from the dropdown list. **Basic** shows general permissions. **Advanced** shows each specific type of permission for finer control. | -| **Permissions** | Select the permissions to apply to the selected value in **Who**. The list of permissions changes based on the value selected in **Permissions Type**. See [Permissions]({{< relref "/CORE/CORETutorials/Storage/Pools/Permissions.md" >}}) for more information on permissions by permissions type (**Basic** and **Advanced**). | -| **Flags Type** | Select the set of ACE inheritance flags to display. Options are **Basic** or **Advanced**. If **Basic** non-specific inheritance options show in the list. If **Advanced** the dropdown list shows specific inheritance settings for finer control. | -| **Flags** | Select how this ACE applies to newly created directories and files within the dataset. If **Flag Type** is set to **Basic** options are **Inherit** or **No Inherit**. If **Flag Type** is set to **Advanced** flags are **File Inherit**, **Directory Inherit**, **No Propagate Inherit**, **Inherit Only**, or **Inherited**. | -{{< /truetable >}} - -Use **ADD ACL ITEM** to add another set of the ACL permission settings. - -Select **Apply permissions recursively** to apply the ACL settings recursively to all directories and files in the current dataset. - -**USE PERMISSIONS EDITOR** opens the [**Edit Permissions**](#dataset-edit-permissions-screen) screen. diff --git a/content/CORE/UIReference/Storage/Pools/ZvolsScreen.md b/content/CORE/UIReference/Storage/Pools/ZvolsScreen.md deleted file mode 100644 index 6a32813be2..0000000000 --- a/content/CORE/UIReference/Storage/Pools/ZvolsScreen.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "Zvols Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/storage/pools/zvolsscreen/" -description: "Describes the fields in the Storage Pools Add Zvol screen in TrueNAS CORE." -weight: 19 -tags: -- zvol -- storage ---- - -Use the **Storage > Pools Add Zvol** screen to add a zvol to a pool. - -![AddZvolAdvancedOptionScreen](/images/CORE/Storage/AddZvolAdvancedOptionScreen.png "Add Zvol Advanced Options Screen") - -**Basic Options** - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Zvol name** | Enter a short name for the zvol. Using a zvol name longer than 63-characters can prevent accessing zvols as devices. For example, a zvol with a 70-character filename or path cannot be used as an iSCSI extent. This setting is required. | -| **Comments** | Enter any notes about this zvol. | -| **Size for this zvol** | Specify size and value. Units like **t**, **TiB**, and **G** can be used. The size of the zvol can be increased later, but cannot be reduced. If the size is more than 80% of the available capacity, the creation fails with an **out of space** error unless **Force size** is also selected. | -| **Force size** | Select to force the system to create a zvol that brings a pool to over 80% capacity (not recommended). By default, the system does not create a zvol if that operation brings the pool to over 80% capacity. | -| **Sync** | Select an option from the dropdown list that sets the data write synchronization. **Inherit** sets zvol to get sync settings from the parent dataset, **Standard** uses the sync settings requested by the client software, **Always** that waits for data writes to complete,or **Disabled** that never waits for writes to complete. | -| **Compression level** | Select a compression option from the dropdown list. Select **Off** to not compress data to save space. Refer to Compression for a description of the available algorithms. | -| **ZFS Deduplication** | Do not change this setting unless instructed to do so by your iXsystems support engineer. | -| **Sparse** | Select to provide [thin provisioning]({{< relref "thinprovisioning.md" >}}). Use with caution as writes fail when the pool is low on space. | -| **Read-only** | Select an option from the dropdown list to set whether the zvol can be modified. Options are **Inherit** to get and use the parent pool or root dataset settings, **On** to prevent modifying the zvol, or **Off** to allow the zvol to be modified. | -| **Inherit** (**Encryption Options**) | Select to enable the zvol to use the encryption properties of the root dataset. | -{{< /truetable >}} - -Selecting **ADVANCED OPTIONS** adds one additional setting. - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Block size** | select the default **Inherit** or select from the other dropdown list options **4KiB**, **8KiB**, **16KiB**, **32KiB**, **64KiB** or **128KiB**. See [Creating a Zvol]({{< relref "/CORE/CORETutorials/Storage/Pools/zvols.md" >}}) for more information on these options and block sizes. | -{{< /truetable >}} - -**SUBMIT** activates after all required fields are populated. Use to save settings. - -Use **CANCEL** to exit without saving settings and display the **Pools** screen. diff --git a/content/CORE/UIReference/Storage/Pools/_index.md b/content/CORE/UIReference/Storage/Pools/_index.md deleted file mode 100644 index b8bf1dc64e..0000000000 --- a/content/CORE/UIReference/Storage/Pools/_index.md +++ /dev/null @@ -1,151 +0,0 @@ ---- -title: "Pools" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/storage/pools/poolsscreens/" -description: "Lists the screens related to Pools in TrueNAS CORE." -geekdocCollapseSection: true -weight: 10 -aliases: /core/uireference/storage/pools/poolsscreens/ -related: false -tags: -- datasets -- pools ---- - - -Use the **Storage Pools** screens to add or manage storage pools on your TrueNAS. -The **Pools** screen displays a table of all the pools and datasets configured in your TrueNAS. - -{{< trueimage src="/images/CORE/Storage/StoragePoolsScreen.png" alt="Storage Pools Screen" id="Storage Pools Screen" >}} - -Use the to display the [**Pools Actions**](#pools-actions-dropdown-list) dropdown list of pool operations. - -Use **ADD** to display the [**Import Pool**](#import-pools-screens) configuration wizard screens. - -Use the   for the root dataset to display the **Action Menu** for the root dataset which is different than the options for nested datasets. -Use the   for nested datasets to display the **Action Menu** for nested datasets. -See [Datasets Screen]({{< relref "/CORE/UIReference/Storage/Pools/DatasetsScreen.md" >}}) for more information on dataset screens. - -## Import Pools Screens - -The import pool wizard has four configuration screens that allow you to add a new pool or import an existing pool based on the selection made. - -### Create or Import Pool Screen - -{{< trueimage src="/images/CORE/Storage/CreateImportPoolScreen.png" alt="Create or Import Pool Screenr" id="Create or Import Pool Screen" >}} - -Select the **Create new Pool** radio button to add a new pool and configure each setting. - -Select the **Import an existing pool** to import an existing pool. See [Importing a Pool]({{< relref "/CORE/CORETutorials/Storage/Pools/PoolImport.md" >}}) for more information. - -Use the **CREATE POOL** button to display the **Create Pool** screen which is the [**Pool Manager**](#pool-manager-screen) screen. - -## Pools Actions Dropdown List - -{{< trueimage src="/images/CORE/Storage/StoragePoolsActionOptions.png" alt="Storage Pools Action Options" id="Storage Pools Action Options" >}} - -### Pools Options - -Displays a dialog with the **Auto TRIM** and **Confirm** checkoboxes. Auto TRIM allows TrueNAS to periodically check the pool disks for storage blocks it can reclaim. - -### Export/Disconnect - -Displays a dialog with a warning about unavailable data, backing up data before exporting/disconnecting, and lists services that could be disrupted by the process. Select from the three options: - -{{< truetable >}} -| Setting | Description| -|---------|------------| -| **Destroy data on this pool?** | Select to destroy data on the pool disks. | -| **Delete configuration of shares that used this pool?** | Selected by default to delete share configurations listed. | -| **Confirm Export/Disconnect** | Activates the **Export/Disconnect** button. | -| **Export/Disconnect** | Use to display the confirmation dialog where you must enter the name of the pool and confirm you want to proceed with this operation. | -{{< /truetable >}} - -Use **CANCEL** to exit the process and close the dialog. - -### Add Vdev - -Displays the [**Pool Manager**](#pool-manager-screen) screen. - -{{< trueimage src="/images/CORE/Storage/AddVdevsScreen.png" alt="Add Vdevs Screen" id="Add Vdevs Screen" >}} - -Use **CANCEL** to exit without saving and display the **Pools** screen. - -Use **ADD VDEVS** to add vdevs to the exiting pool. - -### Scrub Pool - -Displays a start-scrub confirmation dialog. Select **Confirm** to activate the **START SCRUB** button. Use **CANCEL** to exit back to the **Pools** screen without starting the scrub. - -### Expand Pool - -Displays the [**Pool Status**](#pool-status-screen) screen which displays the status of the pool, the datasets and the disks for the selected pool. Select the   to display the options available to datasets and disks. -Use the **Expand Pool** function to add a new disk to a single-disk stripe pool in order to create or re-create a mirror pool, if the disk capacity of the new disk meets the requirements. - -## Pool Manager Screen - -The **Pool Manager** screen displays after selecting either the **Create new Pool** radio button on the **Create or Import Pool** screen or the **Add Vdev** option for an existing pool. - -**Pool Manager** adds the initial vdev when you create the pool or want to add to an existing pool. -At initial creation you have the option to select the type of vdev for this pool. -When accessing **Pool Manager** for an existing pool from the **Pool Actions** dropdown and selecing **Add Vdev**, the pool vdev type is already specified and limits what you can add as a **Data** type vdev. For example, a pool with a mirror vdev requires you to add a minimum of two disks to the existing mirror. In order to transform a single disk stripe to a mirror, use [**Expand Pool**](#expand-pool). - -{{< trueimage src="/images/CORE/Storage/CreatePoolScreen.png" alt="Storage Create Pool Screen" id="Storage Create Pool Screen" >}} - -{{< truetable >}} -| Setting | Description| -|---------|------------| -| **Name** | Displays the name of the pool for which you are adding the vdev. | -| **Encryption** | Select to apply encryption to the storage pool. All datasets created on an encrypted pool inherit encryption from this root dataset. | -| **RESET LAYOUT** | Click to reset the proposed layout displayed. Click before you save to remove any vdev types selected and move disks assigned to any vdev back to the **Available Disks** list. | -| **ADD VDEV** | Displays a dropdown list of the types of vdevs on the system. Vdev types are **Data**, **Cache**, **Log**, **Hot Spare**, **Metadata** or **Dedup**. Click to add vdev types to an existing or new pool vdev setup. | -| **Available Disks** | List of available disks on the TrueNAS. Select the checkbox to the left of the disk and then select the blue to the right of the vdev type (if more than one vdev type exists or is added with the **ADD VDEV** button) to move the disks to that vdev. To move it back to the **Available Disks** list select the disk checkbox(es) and the blue . | -| **Data VDevs** | List of disks assigned to the vdev(s). To move disks back to the **Available Disks** list select the disk checkbox(es) and the blue symbol. | -| **vdev type** | Displays under the **Data Vdevs** table(s). For an existing pool, the default vdev type is the vdev type for that existing pool. For initial pool creation, the default type is **Stripe**. After adding disks to the **Data VDevs** a expand symbol displays with avaialbe options to change the default type of vdev (for example, if two disks are moved to a Data VDev, the **Mirror** option displays along with **Strip**). | -| **Estimated raw capacity: 0 B** | Displays the raw storage capacity of the disks for the data vdev type. | -| **Filter disks by name** | Click on to display the field where you enter the filter or search parameters. | -| **Filter disks by capacity** | Click on to display the field where you enter the filter or search parameters. | -{{< /truetable >}} - -Use **CANCEL** to exit without saving and display the **Pools** screen. - -Use **CREATE** to add the pool vdev. - -Use **ADD VDEVS** to add vdevs to the exiting pool. - -## Pool Status Screen - -The **Pool Status** screen which displays the status of the pool, the datasets and the disks for the selected pool. - -{{< trueimage src="/images/CORE/Storage/PoolStatusScreen.png" alt="Pool Status Screenr" id="Pool Status Screen" >}} - -Each Dataset has two options available from the  . Select either **Extend** which displays the **Extend Vdev** dialog that allows you to select a new disk from a dropdown list, or **Remove** which displays a confirmation dialog before you remove the dataset from the pool. - -Each disk has four options available from the  : - -**Edit** displays the [**Edit Pool Disk**](#edit-pool-disk-screen) screen where you can change disk settings. - -**Offline** displays the **Offline Disk** conformation dialog where you confirm you want to offline the disk. Select the **Confirm** checkbox to activate the **OFFLINE** button or click **CANCEL** to exit the dialog and return to the **Pool Status** screen. - -**Replace** displays the **Replacing disk** dialog where you select the member disk from a dropdown list. Use **Force** to override safety checks and add the disk to the pool. Warning, this erases data on the disk! - -**Detach** displays the **Detach Disk** dialog where you must select **Confirm** before the **DETACH** button activates. This detaches the disk from the pool. - -## Edit Pool Disk Screen - -The **Edit Pool Disk** screen displays disk configutation settings. - -{{< trueimage src="/images/CORE/Storage/StorageDiskEditPoolDiskScreen.png" alt="Edit Pool Disk Screen" id="Edit Pool Disk Screen" >}} - -Settings on the **Edit Pool Disk** screen are the same as those on the **Storage > Disks > Edit Disk** screen. See [Disk Screens]({{< relref "DisksScreens.md" >}}) for more information on disk settings. - -## Pools Edit Permissions Screen - -Use the **Edit Permissions** option on the parent dataset **Dataset Actions** menu to display the **Edit Permissions** screen. This option is only availble on the parent dataset. See [Dataset Screens]({{< relref "/CORE/UIReference/Storage/Pools/DatasetsScreen.md" >}}) and [Setting Up Permissions]({{< relref "/CORE/CORETutorials/Storage/Pools/Permissions.md" >}}) for more information on pool and dataset permissions. - -
- -## Pools Contents - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/UIReference/Storage/SnapshotsScreen.md b/content/CORE/UIReference/Storage/SnapshotsScreen.md deleted file mode 100644 index 893937fded..0000000000 --- a/content/CORE/UIReference/Storage/SnapshotsScreen.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "Snapshots Screens" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/storage/snapshotsscreen/" -description: "Describes the Snapshots screens on TrueNAS CORE." -weight: 20 -tags: -- snapshots ---- - -Use the **Storage > Snapshots** screens to create and manage snapshots on your TrueNAS. - -![StorageSnapshotsScreen](/images/CORE/Storage/StorageSnapshotsScreen.png "Stprage Snapshots Screen") - -Use the to display the **Show Extra Columns** dialog, and after clickng **SHOW**, the **Snapshot** screen changes to dipslay the blue **COLUMNS** button with options to modify the table information. -It also changes the individual snapshots listed to show the individual snapshot action options from the more_vert rather than the navigate_next expand symbol that, after clicking on it, expands the selected snapshot to show details with the action options on the bottom of the expanded view of the snapshot. -To return to the previous display click the to display the **Hide Extra Columns** dialog, and after clickng **HIDE**, the blue **COLUMNS** button no longer displays and the list of snapshots displays the navigate_next expand symbol. - -Use **ADD** to display the **Snapshot > Add** screen. - -## Snapshot Add Screen - -![AddSnapShotScreen](/images/CORE/Storage/AddSnapShotScreen.png "Add Snapshot Screen") - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Dataset** | Select a dataset or zvol from the dropdown list to use as the storage location for snapshots. | -| **Name** | Enter a unique name. This cannot be used with the value in **Naming Schema** | -| **Naming Schema** | Used to generate a name for the snapshot from a previously created periodic snapshot task. This allows replication of the snapshot. Value cannot be used with a value specified in **Name**. | -| **Recursive** | Select to include child datasets of the selected dataset. | -{{< /truetable >}} - -Use **SUBMIT** to save settings. -Use **CANCEL** to exit without saving and display the **Snapshots** screen. - -## Snapshot Details Screen -The expanded snapshot view includes date created, space used, and the amount of data accessible by this dataset. - -![StorageSnapshoExpandedtInfoScreen](/images/CORE/Storage/StorageSnapshoExpandedtInfoScreen.png "Snapshot Expanded Screen") - -{{< truetable >}} -| Name | Icon | Description | -|---------|------|-------------| -| **Delete** | delete | Displays a delete confirmation dialog. Select **Confirm** to activate the **DELETE** button. | -| **Clone to New Dataset** | | Displays the **Clone to New Dataset** screen. | -| **Rollback** | restore | Displays the **Dataset Rollback From Snapshot** dialog. | -{{< /truetable >}} - -### Dataset Rollback from Snapshot Dialog -{{< hint type=warning >}} -WARNING: Rolling the dataset back destroys data on the dataset and can destroy additional snapshots that are related to the dataset. -This can result in permanent data loss! -Do not roll back until all desired data and snapshots are backed up. -{{< /hint >}} - -![DatasetRollbackFromSnapshot](/images/CORE/Storage/DatasetRollbackFromSnapshot.png "Dataset Rollback from Snapshot") - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Stop Roolback if Snapshot Exists** | Select the safety level for the rollback action. Select the radio button that best fits. Rollback is cancelled when the safety check finds additional snapshots that are directly related to the dataset being rolled back. | -| **Newer intermeidate, Child, and clone** | Select to stop rollback when the safety check finds any related intermediate, child dataset, or clone snapshots that are newer than the rollback snapshots. | -| **Newer Clone** | Select to stop rollbck when the safety check finds any related clone snapshots that are newer than the rollback snapshot. | -| **No Safety Check (CAUTION)** | Select to stop rollback if snapshot exists. The rollback destroys any related intermediate, child dataset, and cloned snapshots that are newer than the rollback snapshot. | -| **Confirm** | Select to confirm the selection and activate the **ROLLBACK** button. | -{{< /truetable >}} - -See [Creating Snapshots]({{< relref "/CORE/CORETutorials/Storage/Snapshots.md" >}}) for more information on creating and managing snapshots. diff --git a/content/CORE/UIReference/Storage/VMware-SnapshotsScreen.md b/content/CORE/UIReference/Storage/VMware-SnapshotsScreen.md deleted file mode 100644 index 91fa7e5181..0000000000 --- a/content/CORE/UIReference/Storage/VMware-SnapshotsScreen.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "VMware-Snapshots Screen" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/storage/vmware-snapshotsscreen/" -description: "Describes the fields in the VMware Snapshot screen on TrueNAS CORE." -weight: 30 -tags: -- snapshots ---- - -Use **Storage** > **VMware-Snapshots** to add a VMWare snapshot that coordinates ZFS snapshots when using TrueNAS as a VMware datastore. - -![StorageVMwareSnapshotsAdd](/images/CORE/Storage/StorageVMwareSnapshotsAdd.png "Creating a VMware Snapshot") - -{{< truetable >}} -| Name | Description | -|---------|-------------| -| **Hostname** | Enter the IP address or host name of the VMware host. When clustering, use the IP address or host name of the vCenter server for the cluster. | -| **Username** |Enter a user account name created on the VMware host. The account must have permission to snapshot virtual machines. | -| **Password** | Enter the password associated with the value in **Username**. | -| **ZFS Filesystem** | Select a file system to snapshot from the dropdown list. Values populate from the VMWare host response. | -| **Datastore** | Select an option from the dropdown list after entering the **Hostname**, **Username**, and **Password**, click **FETCH DATASTORES** to populate the menu. Select the datastore to synchronize. Selecting a datastore also select any previously mapped datasets. | -{{< /truetable >}} - -Use **FETCH DATASTORES** to have TrueNAS connect to the VMware host. diff --git a/content/CORE/UIReference/Storage/_index.md b/content/CORE/UIReference/Storage/_index.md deleted file mode 100644 index e02a0026e0..0000000000 --- a/content/CORE/UIReference/Storage/_index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Storage" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/storage/" -description: "Reference documentation for the various screens within the Storage menu option." -geekdocCollapseSection: true -weight: 90 -related: false ---- - -
- -## Storage Contents - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/UIReference/System/2FA.md b/content/CORE/UIReference/System/2FA.md deleted file mode 100644 index 4a6a58bcc3..0000000000 --- a/content/CORE/UIReference/System/2FA.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "2FA (Two-Factor Authentication)" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/2fa/" -description: "Describes the Two-Factor Authentication User Settings screen on TrueNAS CORE." -weight: 190 -tags: -- 2fa ---- - -TrueNAS offers Two-Factor Authentication (2FA) to ensure that a compromised administrator (*root*) password cannot be used by itself to gain access to the administrator interface. - -![UIRef2FA](/images/CORE/System/UIRef2FA.png "2FA Configuration") - -## 2FA Configuration - -{{< include file="/static/includes/System2FAFields.md" >}} diff --git a/content/CORE/UIReference/System/ACMEDNS.md b/content/CORE/UIReference/System/ACMEDNS.md deleted file mode 100644 index 3426702fee..0000000000 --- a/content/CORE/UIReference/System/ACMEDNS.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "ACME DNS" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/acmedns/" -description: "Describes the fields in the Add ACME DNS Authenticators screen on TrueNAS CORE." -weight: 170 -tags: -- acme -- certificates ---- - -[Automatic Certificate Management Environment (ACME)](https://ietf-wg-acme.github.io/acme/draft-ietf-acme-acme.html) is available for automating certificate issuing and renewal. - -## Add DNS Authenticators - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Name**| Internal identifier for the authenticator. | -| **Authenticator** | DNS provider for the authenticator. Amazon Route 53 is the only supported DNS provider in TrueNAS CORE. | -| **Access ID Key** | Key generated by the Amazon Web Services account. See the [AWS Access Key documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for instructions to generate the key. | -| **Secret Access Key** | Key generated by the Amazon Web Services account. See the [AWS Access Key documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) for instructions to generate the key. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/System/Advanced.md b/content/CORE/UIReference/System/Advanced.md deleted file mode 100644 index 0d19299b7f..0000000000 --- a/content/CORE/UIReference/System/Advanced.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Advanced" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/advanced/" -description: "Describes the System > Advanced screen on TrueNAS CORE." -weight: 40 -tags: -- settings ---- - -**System > Advanced** contains advanced options for configuring system settings. - -{{< hint type=important >}} -These options have reasonable defaults in place. -Make sure you are comfortable with ZFS, FreeBSD, and system [configuration backup and restoration]({{< relref "/CORE/CORETutorials/SystemConfiguration/UsingConfigurationBackups.md" >}}) before making any changes. -{{< /hint >}} - -![SystemAdvancedSyslogTransportTLS](/images/CORE/System/SystemAdvancedSyslogTransportTLS.png "Advanced Syslog Transport TLS Settings") - -{{< include file="/static/includes/SystemAdvancedFields.md" >}} - -**SAVE DEBUG** generates text files that contain diagnostic information. diff --git a/content/CORE/UIReference/System/AlertServices.md b/content/CORE/UIReference/System/AlertServices.md deleted file mode 100644 index 526226d5ef..0000000000 --- a/content/CORE/UIReference/System/AlertServices.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: "Alert Services" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/alertservices/" -description: "Describes the fields on the Alert Services screen on TrueNAS CORE." -weight: 80 -tags: -- alerts ---- - -![SystemAlertServicesAdd](/images/CORE/System/SystemAlertServicesAdd.png "New Alert Service") - -{{< include file="/static/includes/SystemAlertServicesAddEditFields.md" >}} - -**Authentication** - -{{< expand "AWS" "v" >}} - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **AWS Region** | Enter the [AWS account region](https://docs.aws.amazon.com/sns/latest/dg/sms_supported-countries.html). | -| **ARN** | Topic [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) for publishing. Example: `arn:aws:sns:us-west-2:111122223333:MyTopic`. | -| **Key ID** | Access Key ID for the linked AWS account. | -| **Secret Key** | Secret Access Key for the linked AWS account. | -{{< /truetable >}} -{{< /expand >}} - -{{< expand "Email" "v" >}} -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Email Address** | Enter a valid email address to receive alerts from this system. | -{{< /truetable >}} -{{< /expand >}} - -{{< expand "InfluxDB" "v" >}} -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Host** | Enter the [InfluxDB](https://docs.influxdata.com/influxdb/) hostname. | -| **Username** | Username for this service. | -| **Password** | Enter password. | -| **Database** | Name of the InfluxDB database. | -| **Series** | InfluxDB time series name for collected points. | -{{< /truetable >}} -{{< /expand >}} - -{{< expand "Mattermost" "v" >}} -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Webhook URL** | Enter or paste the [incoming webhook](https://docs.mattermost.com/developer/webhooks-incoming.html) URL associated with this service. | -| **Username** | Mattermost username. | -| **Channel** | Name of the [channel](https://docs.mattermost.com/messaging/managing-channels.html) to receive notifications. This overrides the default channel in the incoming webhook settings. | -| **Icon Url** | Icon file to use as the profile picture for new messages. Example: https://mattermost.org/wp-content/uploads/2016/04/icon.png. Requires configuring Mattermost to [override profile picture icons](https://docs.mattermost.com/configure/configuration-settings.html#enable-integrations-to-override-profile-picture-icons). | -{{< /truetable >}} -{{< /expand >}} - -{{< expand "OpsGenie" "v" >}} -{{< truetable >}} -| Name | Description | -|------|-------------| -| **API Key** | Enter or paste the [API key](https://docs.opsgenie.com/v1.0/docs/api-integration). Find the API key by signing into the OpsGenie web interface and going to Integrations/Configured Integrations. Click the desired integration, Settings, and read the API Key field. | -| **API URL** | Leave empty for default OpsGenie API. | -{{< /truetable >}} -{{< /expand >}} - -{{< expand "PagerDuty" "v" >}} -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Service Key** | Enter or paste the "integration/service" key for this system to access the [PagerDuty API](https://v2.developer.pagerduty.com/v2/docs/events-api). | -| **Client Name** | PagerDuty client name. | -{{< /truetable >}} -{{< /expand >}} - -{{< expand "Slack" "v" >}} -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Webhook URL** | Paste the [incoming webhook](https://api.slack.com/incoming-webhooks) URL associated with this service. | -{{< /truetable >}} -{{< /expand >}} - -{{< expand "SNMP Trap" "v" >}} -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Hostname** | Hostname or IP address of the system to receive SNMP trap notifications. | -| **Port** | UDP port number on the system receiving SNMP trap notifications. The default is 162. | -| **SNMPv3 Security Model** | Enable the SNMPv3 security model. | -| **SNMP Community** | Network community string. The community string acts like a user ID or password. A user with the correct community string has access to network information. The default is public. For more information, see this helpful [SNMP Community Strings tutorial](https://www.dnsstuff.com/snmp-community-string). | -{{< /truetable >}} -{{< /expand >}} - -{{< expand "VictorOps" "v" >}} -{{< truetable >}} -| Name | Description | -|------|-------------| -| **API Key** | Enter or paste the [VictorOps API key](https://help.victorops.com/knowledge-base/api/). | -| **Routing Key** | Enter or paste the [VictorOps routing key](https://portal.victorops.com/public/api-docs.html). | -{{< /truetable >}} -{{< /expand >}} diff --git a/content/CORE/UIReference/System/AlertSettings.md b/content/CORE/UIReference/System/AlertSettings.md deleted file mode 100644 index a379dcf5a0..0000000000 --- a/content/CORE/UIReference/System/AlertSettings.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "Alert Settings" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/alertsettings/" -description: "Describes the Alert Settings screen on TrueNAS CORE." -weight: 90 -tags: -- alerts -- topmenu ---- - -![System Alert Settings](/images/CORE/System/SystemAlertSettings.png "Alert Settings") - -{{< include file="/static/includes/SystemAlertSettingsFields.md" >}} - -**Alert Warning Levels** - -{{< truetable >}} -| Level | Icon | Alert Notification? | -|-------|------|-------------| -| 1 INFO | ![COREAlertLevelInfoNoticeAlertEmergency](/images/CORE/System/COREAlertLevelInfoNoticeAlertEmergency.png "Alert Levels") | No | -| 2 NOTICE | ![COREAlertLevelInfoNoticeAlertEmergency](/images/CORE/System/COREAlertLevelInfoNoticeAlertEmergency.png "Alert Levels") | Yes | -| 3 WARNING | ![COREAlertLevelWarning](/images/CORE/System/COREAlertLevelWarning.png "Alert Levels") | Yes | -| 4 ERROR | ![COREAlertLevelErrorCritical](/images/CORE/System/COREAlertLevelErrorCritical.png "Alert Levels") | Yes | -| 5 CRITICAL | ![COREAlertLevelErrorCritical](/images/CORE/System/COREAlertLevelErrorCritical.png "Alert Levels") | Yes | -| 6 ALERT | ![COREAlertLevelInfoNoticeAlertEmergency](/images/CORE/System/COREAlertLevelInfoNoticeAlertEmergency.png "Alert Levels") | Yes | -| 7 EMERGENCY | ![COREAlertLevelInfoNoticeAlertEmergency](/images/CORE/System/COREAlertLevelInfoNoticeAlertEmergency.png "Alert Levels") | Yes | -{{< /truetable >}} diff --git a/content/CORE/UIReference/System/BootScreen.md b/content/CORE/UIReference/System/BootScreen.md deleted file mode 100644 index 5c91563f5c..0000000000 --- a/content/CORE/UIReference/System/BootScreen.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Boot" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/bootscreen/" -description: "Provides information about the Boot screen for the TrueNAS CORE." -weight: 30 -aliases: -- /core/uireference/system/boot/bootscreen/ -- /core/uireference/system/boot/ -tags: -- boot ---- - -![UIRefBootScreen](/images/CORE/System/UIRefBootScreen.png "Boot Screen") - -{{< truetable >}} -| Name | Description | -|------|------| -| Actions | Lets users add boot environments and check their stats/settings, as well as manage and scrub the boot pool. | -| Name | The name of the boot entry as it appears in the boot menu. | -| Active | Indicates which entry boots by default if a boot environment is not active. | -| Created | Indicates the boot environment creation date and time. | -| Space | Shows boot environment size. | -| Keep | Indicates whether or not TrueNAS deletes this boot environment when a [system update]({{< relref "/CORE/UIReference/System/Update.md" >}}) does not have enough space to proceed. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/System/CAs.md b/content/CORE/UIReference/System/CAs.md deleted file mode 100644 index c0899163a2..0000000000 --- a/content/CORE/UIReference/System/CAs.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "CAs" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/cas/" -description: "Describes the Certificate Authorities screen settings and functions." -weight: 155 -tags: -- certificates ---- - -![CAInternalIntermediate](/images/CORE/System/CAInternalIntermediate.png "CA Internal and Intermediate") - -## Identifier and Type - -{{< truetable >}} -| Setting | Description | -|---------|-------------| -| **Name** | Descriptive identifier for this certificate authority. | -| **Type** | Select the CA type from the dropdown list of options. Select **Internal CA** for a certificate authority that functions like a publicly-trusted CA used to sign certificates for an internal network. This CA is not trusted outside the private network. Select **Intermediate CA** for a CA that lives between the root and end-entity certificates. Its main purpose is to define and authorize the types of certificates requested from the root CA. Select **Import CA** for a CA that allows importing an existing CA onto the system. For more information, see [What are Subordinate CAs and Why Would You Want Your Own?](https://www.globalsign.com/en/blog/what-is-an-intermediate-or-subordinate-certificate-authority). | -| **Profiles** | Select predefined certificate extensions from the dropdown list. Options are **Opentvpn Root CA** and **CA**. Choose a profile that best matches your certificate usage scenario. | -{{< /truetable >}} - -## Internal and Intermediate CAs - -{{< include file="/static/includes/CertificateAuthorityIdentifierType.md" >}} - -## Import CAs - -![CAImport](/images/CORE/System/CAImport.png "CA Import") - -{{< include file="/static/includes/CertificateAuthorityImport.md" >}} diff --git a/content/CORE/UIReference/System/Certificates.md b/content/CORE/UIReference/System/Certificates.md deleted file mode 100644 index 4fd600d329..0000000000 --- a/content/CORE/UIReference/System/Certificates.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Certificates" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/certificates/" -description: "Explains the fields located on the Certificates screen in TrueNAS CORE." -weight: 160 -tags: -- certificates ---- - -![CAInternalIntermediate](/images/CORE/System/CAInternalIntermediate.png "CA Internal and Intermediate") - -## Identifier and Type - -{{< truetable >}} -| Name | Description | -|------|-------------| -| Name | Descriptive identifier for this certificate. | -| Type | Internal Certificate is used for internal or local systems. Certificate Signing Request is used to get a CA signature. Import Certificate allows an existing certificate to be imported onto the system. Import Certificate Signing Request allows an existing CSR to be imported onto the system. | -| Profiles | Predefined certificate extensions. Choose a profile that best matches your certificate usage scenario. | -{{< /truetable >}} - -## Internal Certificate and Certificate Signing Request - -{{< include file="/static/includes/CertificatesInternalandCSR.md" >}} - -## Import Certificate and Import Certificate Signing Request - -{{< include file="/static/includes/CertificatesImportCertificateCSR.md" >}} diff --git a/content/CORE/UIReference/System/CloudCredentials.md b/content/CORE/UIReference/System/CloudCredentials.md deleted file mode 100644 index e819a7f506..0000000000 --- a/content/CORE/UIReference/System/CloudCredentials.md +++ /dev/null @@ -1,199 +0,0 @@ ---- -title: "Cloud Credentials" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/cloudcredentials/" -description: "Describes the fields in the Cloud Credentials screen in TrueNAS CORE." -weight: 100 -tags: -- cloud -- credentials ---- - -{{< include file="/static/includes/CloudServiceProvidersCORE.md" >}} - -![SystemCloudCredentialsAddS3](/images/CORE/System/SystemCloudCredentialsAddS3.png "Adding new Cloud Credential: S3") - -## Name and Provider - -{{< truetable >}} -| Name | Description | -|------|------| -| **Name** | Enter a name for the new credential. | -| **Provider** | Third-party Cloud service providers. Choose a provider to configure connection credentials. | -{{< /truetable >}} - -## Authentication - -### Amazon S3 Advanced Options - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Endpoint URL** | [S3 API endpoint URL](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteEndpoints.html). When using AWS, the endpoint field can be empty to use the default endpoint for the region, and available buckets are automatically fetched. Refer to the AWS Documentation for a list of [Simple Storage Service Website Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_website_region_endpoints%20%20target=). | -| **Region** | [AWS resources in a geographic area](https://docs.aws.amazon.com/general/latest/gr/rande-manage.html). Leave empty to automatically detect the correct public region for the bucket. Entering a private region name allows interacting with Amazon buckets created in that region. For example, enter us-gov-east-1 to discover buckets created in the eastern [AWS GovCloud](https://docs.aws.amazon.com/govcloud-us/latest/UserGuide/whatis.html) region. | -| **Disable Endpoint Region** | Select to prevent automatic detection of the bucket region. Select only if your AWS provider does not support regions. | -| **User Signature Version 2** | Select to force using [Signature Version 2](https://docs.aws.amazon.com/general/latest/gr/signature-version-2.html) to sign API requests. Select only if your AWS provider does not support default version 4 signatures. | -{{< /truetable >}} - -### BackBlaze B2 - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Key ID** | Alphanumeric [Backblaze B2](https://www.backblaze.com/b2/cloud-storage.html) Application Key ID. To generate a new application key, log in to the Backblaze account, go to the App Keys page, and add a new application key. Copy the application keyID string to this field. | -| **Application Key** | [Backblaze B2](https://www.backblaze.com/b2/cloud-storage.html) Application Key. To generate a new application key, log in to the Backblaze account, go to the App Keys page, and add a new application key. Copy the applicationKey string to this field. | -{{< /truetable >}} - -### Box - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Access Token** | A User Access Token for [Box](https://developer.box.com/). An [access token](https://developer.box.com/reference/) enables Box to verify a request belongs to an authorized session. Example token: T9cE5asGnuyYCCqIZFoWjFHvNbvVqHjl. | -{{< /truetable >}} - -### DropBox - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Access Token** | Access Token for a Dropbox account. A [token must be generated](https://dropbox.tech/developers/generate-an-access-token-for-your-own-account) by the [Dropbox account](https://www.dropbox.com/) before adding it here. | -{{< /truetable >}} - -### FTP - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Host** | FTP Host to connect to. Example: ftp.example.com. | -| **Port** | FTP Port number. Leave blank to use the default port 21. | -| **Username** | A username on the FTP Host system. This user must already exist on the FTP Host. | -| **Password** | Password for the user account. | -{{< /truetable >}} - -### Google Cloud Storage - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Preview JSON Service Account Key** | Contents of the uploaded Service Account JSON file. | -| **Choose File** | Upload a Google [Service Account credential file](https://rclone.org/googlecloudstorage/#service-account-support). The file is created with the [Google Cloud Platform Console](https://console.cloud.google.com/apis/credentials). | -{{< /truetable >}} - -### Google Drive - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Access Token** | Token created with [Google Drive](https://developers.google.com/drive/api/v3/about-auth). Access Tokens expire periodically and must be refreshed. | -| **Team Drive ID** | Only needed when connecting to a Team Drive. The ID of the top level folder of the Team Drive. | -{{< /truetable >}} - -### HTTP - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **URL** | HTTP host URL. | -{{< /truetable >}} - -### Hubic - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Access Token** | Access Token [generated by a Hubic account](https://api.hubic.com/sandbox/). | -{{< /truetable >}} - -### Mega - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Username** | [MEGA](https://mega.nz/) account username. | -| **Password** | MEGA account password. | -{{< /truetable >}} - -### Microsoft Azure Blob Storage - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Account Name** | [Microsoft Azure](https://docs.microsoft.com/en-us/azure/storage/common/storage-create-storage-account) account name. | -| **Account Key** | Base64 encoded key for Azure Account | -{{< /truetable >}} - -### Microsoft One Drive - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Access Token** | Microsoft Onedrive [Access Token](https://docs.microsoft.com/en-us/onedrive/developer/rest-api/getting-started/authentication). Log in to the Microsoft account to add an access token. | -| **Drives List** | Drives and IDs registered to the Microsoft account. Selecting a drive also fills the Drive ID field. | -| **Drive Account Type** | Type of Microsoft acount. Logging in to a Microsoft account automatically chooses the correct account type. Options: Personal, Business, Document_Library | -| **Drive ID** | Unique drive identifier. Log in to a Microsoft account and choose a drive from the Drives List drop-down to add a valid ID. | -{{< /truetable >}} - -### OpenStack Swift - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **User Name** | Openstack user name for login. This is the OS_USERNAME from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file). | -| **API Key or Password** | Openstack API key or password. This is the OS_PASSWORD from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file). | -| **Authentication URL** | Authentication URL for the server. This is the OS_AUTH_URL from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file). | -| **Auth Version** | AuthVersion - optional - set to (1,2,3) if your auth URL has no version ([rclone documentation](https://rclone.org/swift/#standard-options)). | -| **Authentication Advanced Options** | | -| **Tenant Name** | This is the OS_TENANT_NAME from an [OpenStack credentials file](https://rclone.org/swift/#configuration-from-an-openstack-credentials-file). | -| **Tenant ID** | Tenant ID - optional for v1 auth, this or tenant required otherwise ([rclone documentation](https://rclone.org/swift/#standard-options)). | -| **Auth Token** | Auth Token from alternate authentication - optional ([rclone documentation](https://rclone.org/swift/#standard-options)). | -{{< /truetable >}} - -**Advanced Options** - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Region Name** | Region name - optional ([rclone documentation](https://rclone.org/swift/#standard-options)). | -| **Storage URL** | Storage URL - optional ([rclone documentation](https://rclone.org/swift/#standard-options)). | -| **Endpoint Type** | Endpoint type to choose from the service catalogue. Public is recommended, see the [rclone documentation](https://rclone.org/swift/#standard-options). | -{{< /truetable >}} - -### pCloud - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Access Token** | [pCloud Access Token](https://docs.pcloud.com/methods/intro/authentication.html). These tokens can expire and require extension. | -| **Hostname** | Enter the hostname to connect to. | -{{< /truetable >}} - -### SFTP - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Host** | SSH Host to connect to. | -| **Port** | SSH port number. Leave empty to use the default port 22. | -| **Username** | SSH Username. | -| **Password** | Password for the SSH Username account. | -| **Private Key ID** | Import the private key from an existing SSH keypair or select Generate New to create a new SSH key for this credential. | -{{< /truetable >}} - -### WebDav - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **URL** | URL of the HTTP host to connect to. | -| **WebDav Service** | Name of the WebDAV site, service, or software being used. | -| **Username** | WebDAV account username. | -| **Password** | WebDAV account password. | -{{< /truetable >}} - -### Yandex - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Access Token** | Yandex [Access Token](https://yandex.com/dev/direct/doc/dg-v4/concepts/auth-token.html). | -{{< /truetable >}} diff --git a/content/CORE/UIReference/System/Email.md b/content/CORE/UIReference/System/Email.md deleted file mode 100644 index 2713aa8b2f..0000000000 --- a/content/CORE/UIReference/System/Email.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "Email" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/email/" -description: "Describes the Email screen and settings on TrueNAS CORE." -weight: 50 -tags: -- email ---- - -## General Options - -{{< include file="/static/includes/SystemEmailFields.md" >}} - -## Send Mail Method - -### SMTP - -![System Email SMTP Options](/images/CORE/System/SystemEmailSMTPOptions.png "System Email SMTP Options") - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **Outgoing Mail Server** | Hostname or IP address of SMTP server used for sending email. | -| **Mail Server Port** | SMTP port number. Typically 25/465 (secure SMTP), or 587 (submission). | -| **Security** | Choose an encryption type. Choices are *Plain (No Encryption)*, *SSL (Implicit TLS)*, or *TLS (STARTTLS)*. | -| **SMTP Authentication** | Set when the SMTP server uses authentication credentials. Shows additional credentials options. | -{{< /truetable >}} - -### GMail OAuth - -![SystemEmailGMailOAuth](/images/CORE/System/SystemEmailGMailOAuth.png "GMail OAuth Options") - -{{< truetable >}} -| Name | Description | -|------|-------------| -| **LOG IN TO GMAIL** | Login to Gmail using OAuth. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/System/Failover.md b/content/CORE/UIReference/System/Failover.md deleted file mode 100644 index 2441da4fe1..0000000000 --- a/content/CORE/UIReference/System/Failover.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "Failover (HA)" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/failover/" -description: "Describes the fields in the Failover Configuration screen on TrueNAS CORE." -weight: 178 -tags: -- HA -- failover ---- - -{{< enterprise >}} -This article only applies to licensed TrueNAS Enterprise High availability (HA) systems. -Contact the [iXsystems Sales Team](mailto:sales@ixsystems.com) to inquire about purchasing TrueNAS Enterprise licenses. -{{< /enterprise >}} - -## Failover Configuration - -![System Failover Enterprise](/images/CORE/System/SystemFailoverEnterprise.png "HA Failover Options") - -{{< truetable >}} -| Name | Description | -|------|------| -| **Disable Failover** | Disable automatic failover. | -| **Default TrueNAS Controller** | Make the currently active TrueNAS controller the default when both TrueNAS controllers are online and HA is enabled. To change the default TrueNAS controller, unset this option on the default TrueNAS controller and allow the system to fail over. This briefly interrupts system services. | -| **Network Timeout Before Initiating Failover** | The number of seconds to wait after a network failure before triggering a failover. 0 means a failover occurs immediately or after two seconds when the system is using a link aggregation. | -| **SYNC TO/FROM PEER** | Synchronizes the active and standby TrueNAS controllers. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/System/General.md b/content/CORE/UIReference/System/General.md deleted file mode 100644 index 741349cc19..0000000000 --- a/content/CORE/UIReference/System/General.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "General" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/general/" -description: "Describes the fields for the general system settings for TrueNAS CORE." -weight: 10 -aliases: - - /core/system/general/settings -tags: -- settings ---- - -![System General](/images/CORE/System/SystemGeneral.png "System General") - -{{< include file="/static/includes/SystemGeneralFields.md" >}} diff --git a/content/CORE/UIReference/System/KMIP.md b/content/CORE/UIReference/System/KMIP.md deleted file mode 100644 index 2120fd372f..0000000000 --- a/content/CORE/UIReference/System/KMIP.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "KMIP" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/kmip/" -description: "Describes the fields in the KMIP Key Status screen on TrueNAS CORE Enterprise." -weight: 175 -aliases: - - /core/system/kmip -tags: -- kmip -- enterprise ---- - -{{< enterprise >}} -KMIP is only available for TrueNAS Enterprise licensed systems. -Contact the [iXsystems Sales Team](mailto:sales@ixsystems.com) to inquire about purchasing TrueNAS Enterprise licenses. -{{< /enterprise >}} - -KMIP on TrueNAS Enterprise is used to integrate the system within an existing centralized key management infrastructure and use a single trusted source for creating, using, and destroying SED passwords and ZFS encryption keys. - -![SystemKMIP](/images/CORE/System/SystemKMIP.png "KMIP Options") - -## KMIP Server - -{{< truetable >}} -| Name | Description | -|------|------| -| **Server** | Host name or IP address of the central key server. | -| **Port** | Connection port number on the central key server. | -| **Certificate** | Certificate to use for key server authentication. A valid certificate is required to verify the key server connection. WARNING: for security reasons, please protect the Certificate used for key server authentication. | -| **Certificate Authority** | Certificate Authority (CA) to use for connecting to the key server. A valid CA public certificate is required to authenticate the connection. WARNING: for security reasons, please protect the Certificate Authority used for key server authentication. | -| **Manage SED Passwords** | Self-Encrypting Drive (SED) passwords can be managed with KMIP. Enabling this option allows the key server to manage creating or updating the global SED password, creating or updating individual SED passwords, and retrieving SED passwords when SEDs are unlocked. Disabling this option leaves SED password management with the local system. | -| **Manage ZFS Keys** | Use the KMIP server to manage ZFS encrypted dataset keys. The key server stores, applies, and destroys encryption keys whenever an encrypted dataset is created, when an existing key is modified, an encrypted dataset is unlocked, or an encrypted dataset is removed. Unsetting this option leaves all encryption key management with the local system. | -| **Enabled** | Activate KMIP configuration and begin syncing keys with the KMIP server. | -| **Change Server** | Move existing keys from the current key server to a new key server. To switch to a different key server, key synchronization must be Enabled, then enable this setting, update the key server connection configuration, and click SAVE. | -| **Validate Connection** | Tests the server connection and verifies the chosen Certificate chain. To test, configure the Server and Port values, select a Certificate and Certificate Authority, enable this setting, and click SAVE. | -| **Force Clear** | Cancel any pending Key synchronization. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/System/NTPServers.md b/content/CORE/UIReference/System/NTPServers.md deleted file mode 100644 index 2134395f01..0000000000 --- a/content/CORE/UIReference/System/NTPServers.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "NTP Servers" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/ntpservers/" -description: "Describes the fields for the NTP Server Settings screen on TrueNAS CORE." -weight: 20 -tags: -- ntp ---- - -![SystemNTPServersAdd](/images/CORE/System/SystemNTPServersAdd.png "Adding a new NTP Server") - -{{< include file="/static/includes/SystemNTPServersAddFields.md" >}} diff --git a/content/CORE/UIReference/System/Reporting.md b/content/CORE/UIReference/System/Reporting.md deleted file mode 100644 index d7b1577ad8..0000000000 --- a/content/CORE/UIReference/System/Reporting.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "Reporting" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/reporting/" -description: "Contains information about the Reporting screen on TrueNAS CORE." -weight: 70 -aliases: /core/administration/reporting/ -tags: -- reporting ---- - -TrueNAS has a built in reporting engine that displays helpful graphs and information about the system processes. -TrueNAS uses [Graphite](https://graphiteapp.org/ "Graphite Homepage") for metric gathering and visualizations. - -Configure system reporting on the **System > Reporting** screen. - -![SystemReporting](/images/CORE/System/SystemReporting.png "Reporting Options") - --{{< truetable >}} -| Name | Description | -|------|-------------| -| **Graph Age in Months** | Maximum time (in months) TrueNAS stores a graph. Allowed values are 1-60. Changing this value causes the **Confirm RRD Destroy** dialog to display. Changes do not take effect until TrueNAS destroys the existing reporting database. | -| **Number of Graph Points** | The number of points for each hourly, daily, weekly, monthly, or yearly graph. Allowed values are 1-4096. Changing this value displays the **Confirm RRD Destroy** dialog. Changes do not take effect until TrueNAS destroys the existing reporting database. | -| **Reset to Defaults** | Resets all entered values and settings back to defaults. | -{{< /truetable >}} -{{< hint type=important >}} -Report history is cleared after changing and saving CPU reporting, graph age, or graph points. -{{< /hint >}} - -For information on the **Reporting** screen graphs see [System Reporting]({{< relref "/CORE/UIReference/ReportingGraphs.md" >}}). - -Reporting data is saved and preserved across system upgrades and reboots. -This allows viewing usage trends over time. -This data is frequently written and should not be stored on the boot pool or operating system device. -Reporting data is saved in /var/db/collectd/rrd/. diff --git a/content/CORE/UIReference/System/SSHConnections.md b/content/CORE/UIReference/System/SSHConnections.md deleted file mode 100644 index 4440549d09..0000000000 --- a/content/CORE/UIReference/System/SSHConnections.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "SSH Connections" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/sshconnections/" -description: "Describes the SSH screen fields on TrueNAS CORE." -weight: 110 -tags: -- ssh ---- - -![SystemSSHConnectionsAddSemiAuto](/images/CORE/System/SystemSSHConnectionsAddSemiAuto.png "Semi-Auto Connection") - -{{< include file="/static/includes/SystemSSHConnectionsAddSemiAutoFields.md" >}} diff --git a/content/CORE/UIReference/System/SSHKeypairs.md b/content/CORE/UIReference/System/SSHKeypairs.md deleted file mode 100644 index 0cd3b9f660..0000000000 --- a/content/CORE/UIReference/System/SSHKeypairs.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "SSH Keypairs" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/sshkeypairs/" -description: "Describes the SSH Keypair screen on TrueNAS CORE." -weight: 120 -aliases: - - /core/system/systemssh -tags: -- ssh ---- - -![System SSH Keypairs Add](/images/CORE/System/SystemSSHKeypairsAdd.png "System SSH Keypairs Add") - -{{< truetable >}} -| Name | Description | -|------|------| -| Name | A unique name to identify this keypair. Automatically generated keypairs are named after the object that generated the keypair with " Key" appended to the name. | -| Private Key | See Public key authentication in [SSH/Authentication](https://www.freebsd.org/cgi/man.cgi?query=ssh). | -| Public Key | See Public key authentication in [SSH/Authentication](https://www.freebsd.org/cgi/man.cgi?query=ssh). | -{{< /truetable >}} diff --git a/content/CORE/UIReference/System/Support.md b/content/CORE/UIReference/System/Support.md deleted file mode 100644 index 8398f25316..0000000000 --- a/content/CORE/UIReference/System/Support.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "Support" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/support/" -description: "Describes the Support screen on TrueNAS CORE." -weight: 180 -tags: -- support ---- - -The **Support** screen displays system information. Users may also manage thier Enterprise license and create support tickets. - -## TrueNAS CORE - -![UIBugReport](/images/CORE/System/UIBugReport.png "Writing a Bug Report") - -{{< truetable >}} -| Name | Description | -|------|------| -| Username | Your JIRA username. | -| Password | Your JIRA password. | -| Type | Select Bug when reporting an issue or Feature when requesting new functionality. | -| Category | Category that best describes the bug or feature. | -| Attach Debug | Generates and attaches an overview of the system hardware, build string, and configuration. | -| Subject | A descriptive title for the new issue. | -| Description | A one to three paragraph summary of the issue. | -| Browse... | Attaches screenshots that illustrate the problem. | -{{< /truetable >}} - -## TrueNAS Enterprise - -{{< enterprise >}} -Proactive Support and the Contact Support fields below are only available on TrueNAS Enterprise licensed systems. -Contact the [iXsystems Sales Team](mailto:sales@ixsystems.com) to inquire about purchasing TrueNAS Enterprise licenses. -{{< /enterprise >}} - -### Proactive Support - -![System Support Proactive Enterprise](/images/CORE/System/SystemSupportProactiveEnterprise.png "Proactive Support: Enterprise") - -{{< truetable >}} -| Name | Description | -|------|------| -| Name | Primary/Secondary Contact name. | -| Email | Primary/Secondary Contact email address. | -| CC | Primary/Secondary Contact email address. | -| Phone Number | Primary/Secondary Contact phone number. | -| Enable iXsystems Proactive Support | Set to enable the Enterprise Proactive Support feature. | -{{< /truetable >}} - -### Contact Support - -![SystemSupportContactEnterprise](/images/CORE/System/SystemSupportContactEnterprise.png "Support Contact: Enterprise") - -{{< truetable >}} -| Name | Description | -|------|------| -| Name | Contact name. | -| Email | Contact email address. | -| Phone | Contact phone number. | -| Type | Select Bug when reporting an issue or Feature when requesting new functionality. | -| Environment | Select the appropriate environment. | -| Criticality | Select the appropriate level of criticality. | -| Attach Debug | Generates and attaches an overview of the system hardware, build string, and configuration. | -| Subject | A descriptive title for the new issue. | -| Description | A one to three paragraph summary of the issue. | -| Choose Files | Attaches screenshots that illustrate the problem. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/System/SystemDataset.md b/content/CORE/UIReference/System/SystemDataset.md deleted file mode 100644 index b1b94e05e5..0000000000 --- a/content/CORE/UIReference/System/SystemDataset.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "System Dataset" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/systemdataset/" -description: "Describes the System Dataset screen on TrueNAS CORE." -weight: 60 -tags: -- systemdataset -- datasets ---- - -The system dataset stores debugging core files, encryption keys for encrypted pools, and Samba4 metadata such as the user and group cache and share level permissions. - -![ConfigureSystemDataset](/images/CORE/System/ConfigureSystemDataset.png "Configure System Dataset") - -{{< truetable >}} -| Name | Description | -|------|------| -| System Dataset Pool | Select the pool to contain the system dataset. | -| Syslog | Store system logs on the system dataset. Unset to store system logs in /var/ on the operating system device. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/System/Tunables.md b/content/CORE/UIReference/System/Tunables.md deleted file mode 100644 index 52e69ad6dd..0000000000 --- a/content/CORE/UIReference/System/Tunables.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Tunables" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/tunables/" -description: "Describes the Tunable screen fields on TrueNAS CORE." -weight: 140 -tags: -- tunables ---- - -Tunables manage TrueNAS [sysctls](https://www.freebsd.org/cgi/man.cgi?query=sysctl), loaders, and [rc.conf](https://www.freebsd.org/cgi/man.cgi?query=rc.conf) options. - -![SystemTunablesAdd](/images/CORE/System/SystemTunablesAdd.png "Adding a Tunable") - -{{< include file="/static/includes/SystemTunablesFields.md" >}} diff --git a/content/CORE/UIReference/System/Update.md b/content/CORE/UIReference/System/Update.md deleted file mode 100644 index 5d3f4f9370..0000000000 --- a/content/CORE/UIReference/System/Update.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Update" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/update/" -description: "Describes the fields in the Update screen in TrueNAS CORE." -geekdocCollapseSection: true -weight: 150 -tags: -- update ---- - -![System Update](/images/CORE/System/SystemUpdate.png "System Update") - -{{< truetable >}} -| Name | Description | -|------|------| -| Check for Updates Daily and Download if Available | Check the update server daily for any updates on the chosen train. Automatically download an update if one is available. Click **APPLY PENDING UPDATE** to install the downloaded update. | -| (Refresh) | Check for updates. | -| Operation | Lists operations TrueNAS performs during the update. | -| Name | Operation name and version comparison. | -| Change log | Lists software changes based on [TrueNAS project JIRA tickets](https://ixsystems.atlassian.net/projects/NAS/issues/NAS-104367?filter=allopenissues). | -{{< /truetable >}} diff --git a/content/CORE/UIReference/System/ViewEnclosure.md b/content/CORE/UIReference/System/ViewEnclosure.md deleted file mode 100644 index ec30c4ec47..0000000000 --- a/content/CORE/UIReference/System/ViewEnclosure.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: "View Enclosure" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/viewenclosure/" -description: "Provides information about the View Enclosure screen on TrueNAS CORE." -weight: 45 -tags: -- enclosure ---- - -{{< enterprise >}} -The **View Enclosure** screen only displays on TrueNAS CORE Enterprise systems with compatible hardware. -The UI options to select **System > View Enclosure** is not present on incompatible non-Enterprise systems. -{{< /enterprise >}} - -The **System Information** widget on the main **Dashboard** displays an image of the specific TrueNAS system. Hover the mouse over the image to see the **View Enclosure** label. - -{{< trueimage src="/images/CORE/System/ViewEnclosureWidget.png" alt="View Enclosure Widget" id="View Enclosure Widget" >}} - -Click anywhere on the system image to open the **View Enclosure** screen. - -## View Enclosure Screen - -The **View Enclosure** screen displays an image of the TrueNAS platform. -Additional information about storage pools, drives, and other hardware components is available through clickable elements and buttons. - -### Enclosure Elements - -The top of the **View Enclosure** screen displays options to view information about the system or expansion shelf. -The options vary by TrueNAS platform, whether or not the system has expansion shelves, and if you have an expansion shelf image selected instead of the TrueNAS system. - -{{< trueimage src="/images/CORE/System/ViewEnclosureElements.png" alt="View Enclosure Elements" id="Enclosure Elements" >}} - -All TrueNAS systems include the **Disks** option. TrueNAS systems with expansion shelves include the **Temperature**, **Power Supply**, and **Voltage** options. - -Expansion shelves include the **Disks**, **Cooling**, **Services**, **Power Supply**, **SAS Expander**, **Temperature Sensors**, and **Voltage Sensor** options. -Each option displays a table with readings from the system's internal components taken over time. - -## System Image Screens - -System images display the front view of the server by default. - -If the system model includes a rear view, **REAR** changes the image to the back of the system. **FRONT** switches to the front view of the system chassis. - -**EDIT LABEL** displays for system models other than the Mini. - -{{< trueimage src="/images/CORE/System/ViewEnclosureEditLabel.png" alt="View Enclosure Edit Label" id="Enclosure Edit Label" >}} - -**EDIT LABEL** opens the **Change Enclosure Label** window. Type a name or description for the system and click **SAVE** to apply the label. **Reset to default** restores the default name for the system. - -System image screens include three options to change the information on the screen: -* **SHOW POOLS** that highlights disks in pools on the system image. -* **SHOW STATUS** that shows healthy disks in the system and a status indicator color legend. -* **SHOW EXPANDER STATUS** that shows the status of SAS expanders in the system or expansion shelf (only systems with an expansion shelf). -### Disk Image Screens - -Click on a drive image to display a screen with information for that drive. Disk drive information includes the system pool, status, hardware details, and stats. - -**IDENTIFY DRIVE** on disk detail screens turns on the LED indicator on a physical drive bay in the system server. - -**IDENTIFY DRIVE** helps to identify the physical drive bay corresponding to the CORE identification number for that drive. -Select the drive on the image and then click **IDENTIFY DRIVE**. Go to the location of the system server to locate the drive bay with the LED indication turned on, then check the drive location on the **View Enclosure** screen. - -{{< hint type=note >}} -TrueNAS Mini and R30 systems do not include the **IDENTIFY DRIVE** function. -{{< /hint >}} - -### Mini Enclosure Screen Example - -TrueNAS Mini systems only display the front view of the system hardware. - -{{< trueimage src="/images/CORE/System/ViewEnclosureMiniExample.png" alt="View Enclosure Mini" id="Mini Enclosure" >}} - -Pool information displays at the top of the screen. The drive bay number and disk label display to the left of the image, and the status is to the right. A disk image screen shows details for the drive you click on. - -The **Disks Overview** section displays the system drive hardware and capacity. -The **Drive Temperatures** section displays current readings for each drive in the system. - -{{< trueimage src="/images/CORE/System/ViewEnclosureMiniDisks.png" alt="View Enclosure Mini Disks" id="Mini Enclosure Disks" >}} - -### R20 Enclosure Screen Example - -Larger TrueNAS hardware system images include a front and rear view of the chassis to show all drive bays and installed disk drives. - -{{< trueimage src="/images/CORE/System/ViewEnclosureR20Front.png" alt="View Enclosure R20 Front" id="R20 Front" >}} - -{{< trueimage src="/images/CORE/System/ViewEnclosureR20Rear.png" alt="View Enclosure R20 Rear" id="R20 Rear" >}} - -Click on a drive to display details for that selected drive and to access the **IDENTIFY DRIVE** option. - -{{< trueimage src="/images/CORE/System/ViewEnclosureR20Disks.png" alt="View Enclosure R20 Disks" id="R20 Disks" >}} - -### M40 and Expansion Shelf Enclosure Screen Examples -The screen shows the front view of the system by default. Both the system and expansion shelf images show the locations of installed disks. - -{{< trueimage src="/images/CORE/System/ViewEnclosureM40WithShelf.png" alt="View Enclosure M40 With Shelf" id="M40 with Expansion Shelf" >}} - -The right side of the screen includes smaller images of both the system and expansion shelves connected to it. The selected system has a blue vertical line next to it. - -{{< trueimage src="/images/CORE/System/ViewEnclosureExpansionShelf.png" alt="View Enclosure Expansion Shelf" id="Expansion Shelf" >}} - -The system and expansion shelf image screens include three options to change the information shown on the screen: -* **SHOW POOLS** that highlights disks in pools on the system image. -* **SHOW STATUS** that shows healthy disks in the system and a status indicator color legend. -* **SHOW EXPANDER STATUS** that shows the status of SAS expanders in the system or expansion shelf (only systems with an expansion shelf). - -Click on a drive image in the system or an expansion shelf image to display a drive information screen for that drive. Disk drive information includes the system pool, disk status, hardware details, and stats. - -The expansion shelf image varies based on the type of expansion shelf installed, but the disk information displayed is the same as for disks in other system disks. diff --git a/content/CORE/UIReference/System/_index.md b/content/CORE/UIReference/System/_index.md deleted file mode 100644 index 44e3d9b202..0000000000 --- a/content/CORE/UIReference/System/_index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "System" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/system/" -description: "Reference documentation for the screens within the System menu option." -geekdocCollapseSection: true -weight: 60 -related: false ---- - -The TrueNAS CORE web interface **System** section has numerous features related to configuring the system and integrating it with specific environments or external accounts. - -
- -## System Content - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/UIReference/Tasks/AdvancedScheduler.md b/content/CORE/UIReference/Tasks/AdvancedScheduler.md deleted file mode 100644 index b684fc16f5..0000000000 --- a/content/CORE/UIReference/Tasks/AdvancedScheduler.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Advanced Scheduler" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/tasks/advancedscheduler/" -description: "Describes the fields in the Advanced Scheduler in TrueNAS CORE." -weight: 100 -tags: -- advancedscheduler ---- - -![Tasks Advanced Scheduler](/images/CORE/Tasks/TasksAdvancedScheduler.png "Tasks Advanced Scheduler") - -{{< truetable >}} -| Name | Description | -|------|------| -| **Choose a preset** | Populates the rest of the fields. | -| **Minutes** | Minutes when the task runs. | -| **Hours** | Hours when the task runs. | -| **Days** | Days when the task runs. | -| **Months** | Months when the task runs. | -| **Days of Week** | Days of the week when the task runs. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/Tasks/CloudSyncTasks.md b/content/CORE/UIReference/Tasks/CloudSyncTasks.md deleted file mode 100644 index df285b6928..0000000000 --- a/content/CORE/UIReference/Tasks/CloudSyncTasks.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "Cloud Sync Tasks" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/tasks/cloudsynctasks/" -description: "Describes the Cloud Sync Tasks screen on TrueNAS CORE." -weight: 90 -tags: -- cloud ---- - -TrueNAS can send, receive, or synchronize data with a Cloud Storage provider. - -{{< include file="/static/includes/CloudServiceProvidersCORE.md" >}} - -![TasksCloudSyncAdd](/images/CORE/Tasks/TasksCloudSyncAdd.png "Creating a Cloud Sync Task") - -## Transfer - -{{< truetable >}} -| Name | Description | -|------|------| -| **Description** | Enter a description of the Cloud Sync Task. | -| **Direction** | **PUSH** sends data to cloud storage. **PULL** receives data from cloud storage. Changing the direction resets the **Transfer Mode** to **COPY**. | -| **Transfer Mode** | **SYNC**: Files on the destination are changed to match those on the source. If a file does not exist on the source, it is also deleted from the destination. **COPY**: Files from the source are copied to the destination. If files with the same names are present on the destination, they are overwritten. **MOVE**: After files are copied from the source to the destination, they are deleted from the source. Files with the same names on the destination are overwritten. | -| **Directory/Files** | Select the directories or files to be sent to the cloud for **Push** syncs, or the destination to be written for **Pull** syncs. Be cautious about the destination of **Pull** jobs to avoid overwriting existing files. | -{{< /truetable >}} - -## Remote - -{{< truetable >}} -| Name | Description | -|------|------| -| **Credential** | Select the cloud storage provider credentials from the list of available Cloud Credentials. | -| **Folder** | Enter or select the cloud storage location to use for this task. | -{{< /truetable >}} - -## Control - -{{< truetable >}} -| Name | Description | -|------|------| -| **Schedule** | Select a schedule preset or choose **Custom** to open the advanced scheduler. | -| **Enable** | Enable this Cloud Sync Task. Clear to disable this Cloud Sync Task without deleting it. | -{{< /truetable >}} - -## Advanced Options - -{{< truetable >}} -| Name | Description | -|------|------| -| **Follow Symlinks** | Follow symlinks and copy the items to which they link. | -| **Pre-script** | Script to execute before running sync. | -| **Post-script** | Script to execute after running sync. | -| **Exclude** | List of files and directories to exclude from sync. Separate entries by pressing Enter. See [rclone](https://rclone.org/filtering/) filtering for more details about the `--exclude` option. | -| **Upload Chunk Size** | Files are split into chunks of this size before upload. The number of chunks that can be simultaneously transferred is set by the **Transfers** number. The single largest file being transferred must fit into no more than 10,000 chunks. | -| **Remote Encryption** | Use [rclone crypt](https://rclone.org/crypt/) to manage data encryption during PUSH or PULL transfers: PUSH: Encrypt files before transfer and store the encrypted files on the remote system. Files are encrypted using the *Encryption Password* and *Encryption Salt* values. PULL: Decrypt files that are being stored on the remote system before the transfer. Transferring the encrypted files requires entering the same Encryption Password and Encryption Salt that was used to encrypt the files. Additional details about the encryption algorithm and key derivation are available in the [rclone crypt File formats documentation](https://rclone.org/crypt/#file-formats). | -| **Transfers** | Number of simultaneous file transfers. Enter a number based on the available bandwidth and destination system performance. See [rclone --transfers](https://rclone.org/docs/#transfers-n). | -| **Bandwidth Limit** | A single bandwidth limit or bandwidth limit schedule in rclone format. Separate entries by pressing Enter. Example: *08:00,512 12:00,10MB 13:00,512 18:00,30MB 23:00,off*. Units can be specified with the beginning letter: *b, k (default), M, or G*. See [rclone --bwlimit](https://rclone.org/docs/#bwlimit-bandwidth-spec). | -{{< /truetable >}} - -## Dry Run - -TrueNAS connects to the Cloud Storage Provider and simulates a file transfer without sending or receiving data. diff --git a/content/CORE/UIReference/Tasks/CronJobs.md b/content/CORE/UIReference/Tasks/CronJobs.md deleted file mode 100644 index 6dabd4f8d5..0000000000 --- a/content/CORE/UIReference/Tasks/CronJobs.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Cron Jobs" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/tasks/cronjobs/" -description: "Describes the fields on the Cron Jobs screen on TrueNAS CORE." -weight: 10 -tags: -- cronjobs ---- - -![TasksCronJobsAdd](/images/CORE/Tasks/TasksCronJobsAdd.png "Creating a new Cron Job") - -{{< include file="/static/includes/TasksCronJobsAddFields.md" >}} diff --git a/content/CORE/UIReference/Tasks/InitShutdownScripts.md b/content/CORE/UIReference/Tasks/InitShutdownScripts.md deleted file mode 100644 index df19fd352d..0000000000 --- a/content/CORE/UIReference/Tasks/InitShutdownScripts.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Init/Shutdown Scripts" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/tasks/initshutdownscripts/" -description: "Explains the fields on the Init/Shutdown Script screen on TrueNAS CORE." -weight: 20 -tags: -- initshutdown ---- - -![TasksInitShutdownScriptsAdd](/images/CORE/Tasks/TasksInitShutdownScriptsAdd.png "Creating a new script") - -{{< include file="/static/includes/TasksInitShutdownScriptsAddFields.md" >}} diff --git a/content/CORE/UIReference/Tasks/PeriodicSnapshotTasks.md b/content/CORE/UIReference/Tasks/PeriodicSnapshotTasks.md deleted file mode 100644 index 4dd05c9d07..0000000000 --- a/content/CORE/UIReference/Tasks/PeriodicSnapshotTasks.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Periodic Snapshot Tasks" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/tasks/periodicsnapshottasks/" -description: "Defines the fields in the Periodic Snapshot Tasks Screen on TrueNAS CORE." -weight: 50 -tags: -- snapshots ---- - -![TasksPeriodicSnapshotAdd](/images/CORE/Tasks/TasksPeriodicSnapshotAdd.png "Creating a new Snapshot Task") - -{{< include file="/static/includes/TasksPeriodicSnapshotAddFields.md" >}} diff --git a/content/CORE/UIReference/Tasks/ReplicationTasks.md b/content/CORE/UIReference/Tasks/ReplicationTasks.md deleted file mode 100644 index 7e4dd08281..0000000000 --- a/content/CORE/UIReference/Tasks/ReplicationTasks.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Replication Tasks" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/tasks/replicationtasks/" -description: "Decribes the fields on the Replication Tasks screen for TrueNAS CORE." -geekdocCollapseSection: true -weight: 60 -tags: -- replication ---- - -## Basic Creation - -![TasksReplicationTasksAdd](/images/CORE/Tasks/TasksReplicationTasksAdd.png "Add Replication Task") - -{{< include file="/static/includes/TasksReplicationAddWizardFields.md" >}} - -![TasksReplicationTasksAddLocalSourceRemoteDestWeeklyCustomLife](/images/CORE/Tasks/TasksReplicationTasksAddLocalSourceRemoteDestWeeklyCustomLife.png "Description") - -## Advanced Creation - -![TasksReplicationAddAdvanced](/images/CORE/Tasks/TasksReplicationAddAdvanced.png "Add Replication Task") - -{{< include file="/static/includes/TasksReplicationAddAdvancedFields.md" >}} diff --git a/content/CORE/UIReference/Tasks/ResilverPriority.md b/content/CORE/UIReference/Tasks/ResilverPriority.md deleted file mode 100644 index 1e8ec1deef..0000000000 --- a/content/CORE/UIReference/Tasks/ResilverPriority.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Resilver Priority" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/tasks/resilverpriority/" -description: "Describes the Resilver Priority screen on TrueNAS CORE." -weight: 70 -tags: -- resilver ---- - -![TasksResilverPriority](/images/CORE/Tasks/TasksResilverPriority.png "Scheduling Resilver Priority Times") - -{{< include file="/static/includes/TasksResilverPriorityFields.md" >}} diff --git a/content/CORE/UIReference/Tasks/Rsync.md b/content/CORE/UIReference/Tasks/Rsync.md deleted file mode 100644 index 9e65589dbe..0000000000 --- a/content/CORE/UIReference/Tasks/Rsync.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Rsync Tasks" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/tasks/rsync/" -description: "Provides information about the Rsync Tasks screen on TrueNAS CORE." -weight: 30 -tags: -- rsync ---- - -Remote sync is a utility that copies data across a network. Rsync first copies the initial data. Later copies contain only the data that is different between the source and destination files. This reduces network traffic. Use Rsync to create backups, and to synchronize data across systems. - -## Create a New Rsync Task - -Go to **Tasks > Rsync Tasks**. The Rsync Tasks menu displays. - -![RsyncTaskAdd](/images/CORE/Tasks/RsyncTaskAdd.png "Rsync Task: Add Module") - -Click **ADD**. - -![TasksRsyncTasksAddModeModule](/images/CORE/Tasks/TasksRsyncTasksAddModeModule.png "Rsync Task: Module Mode") - -{{< include file="/static/includes/TasksRsyncAddFields.md" >}} diff --git a/content/CORE/UIReference/Tasks/SMARTTests.md b/content/CORE/UIReference/Tasks/SMARTTests.md deleted file mode 100644 index f243e0e525..0000000000 --- a/content/CORE/UIReference/Tasks/SMARTTests.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "S.M.A.R.T. Tests" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/tasks/smarttests/" -description: "Describes the fields on the S.M.A.R.T. Test screen on TrueNAS CORE." -weight: 40 -tags: -- smart ---- - -![TasksSMARTTestsAdd](/images/CORE/Tasks/TasksSMARTTestsAdd.png "Add recurring S.M.A.R.T. test") - -{{< include file="/static/includes/TasksSMARTAddFields.md" >}} diff --git a/content/CORE/UIReference/Tasks/ScrubTasks.md b/content/CORE/UIReference/Tasks/ScrubTasks.md deleted file mode 100644 index 30a4c9cd2b..0000000000 --- a/content/CORE/UIReference/Tasks/ScrubTasks.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "Scrub Tasks" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/tasks/scrubtasks/" -description: "Describes the fields on the Scrub Task screen on TrueNAS CORE." -weight: 80 -tags: -- scrub ---- - -![TasksScrubTasksAdd](/images/CORE/Tasks/TasksScrubTasksAdd.png "Creating a new Scrub Task") - -{{< include file="/static/includes/TasksScrubTasksAddFields.md" >}} diff --git a/content/CORE/UIReference/Tasks/_index.md b/content/CORE/UIReference/Tasks/_index.md deleted file mode 100644 index e9e3487466..0000000000 --- a/content/CORE/UIReference/Tasks/_index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Tasks" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/tasks/" -description: "Reference documentation of screens within the Tasks menu option." -geekdocCollapseSection: true -weight: 70 -aliases: - - /hub/tasks/ -related: false ---- - -TrueNAS includes an easy-to-use interface for common tasks a sysadmin needs to preform on a NAS on a regular basis. -These can roughly be broken down into three groups: system level, data backup, and ZFS tasks. - -
- -## Tasks Contents - -{{< children depth="2" description="true" >}} - -
diff --git a/content/CORE/UIReference/TopMenu/Alerts.md b/content/CORE/UIReference/TopMenu/Alerts.md deleted file mode 100644 index 8b72149744..0000000000 --- a/content/CORE/UIReference/TopMenu/Alerts.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "Alert Notifications" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/topmenu/alerts/" -description: "Displays system alerts and provides options to dismiss or reopen dismissed alerts on your TrueNAS." -weight: 20 -tags: -- topmenu -- alerts ---- - -The **Alert Notifications** panel displays system alerts. It provides options to dismiss or reopen dismissed alerts on your TrueNAS. - -![AlertsPanel](/images/CORE/Dashboard/AlertsPanel.png "Alerts Panel") - -## Alerts Panel Options - -{{< truetable >}} -| Name | Description | -|------|------| -| **Dismiss** | Dismisses a single alert. | -| **Re-Open** | Re-opens a recently dismissed alert. | -| **Dismiss All Alerts** | Dismisses all alerts. | -| **Re-Open All Alerts** | Displays at the bottom of the panel if you dismiss more than one alert. Click to re-open all dismissed alerts if they are still active. | -{{< /truetable >}} - -## Alert Levels - -{{< truetable >}} -| Level | Icon | -|-------------|------| -| **Notification** | | -| **Warning** | | -| **Critical** | | -| **One-shot Critical** | | -{{< /truetable >}} diff --git a/content/CORE/UIReference/TopMenu/TaskManager.md b/content/CORE/UIReference/TopMenu/TaskManager.md deleted file mode 100644 index d3750f9308..0000000000 --- a/content/CORE/UIReference/TopMenu/TaskManager.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Task Manager" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/topmenu/taskmanager/" -description: "Displays a list of tasks performed by your TrueNAS." -weight: 10 -tags: -- topmenu -- taskmanager ---- - -The **Task Manager** displays a list of tasks performed by the TrueNAS system. It starts with the most recent. Click the assignment to open the **Task Manager**. - -![TaskManager](/images/CORE/Dashboard/TaskManager.png "Task Manager") - -{{< truetable >}} -| Name | Description | -|------------|-------------| -| **Filter** | Search function to locate or filter the list for a particular running task. | -| **View Logs** | Tasks with log file output have a **View Logs** button to show the log files. | -| **State** | Column header for tasks that shows the current condition of the task. Indicates whether the task completed or is still in progress. Click **State** to sort by this column. | -| **Method** | Column header for tasks that indicates both the name of the task and the method used. Click **Method** to sort by this column. | -| **Progress** | Column header for tasks that indicates the progress of the the task. Measured by percentage from start to completion. Click **Progress** to sort by this column. | -| **CLOSE** | Closes the **Task Manager** dialog. Click anywhere off the dialog or use the Esc to close this dialog. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/TopMenu/UIPreferences.md b/content/CORE/UIReference/TopMenu/UIPreferences.md deleted file mode 100644 index d5a32cedbd..0000000000 --- a/content/CORE/UIReference/TopMenu/UIPreferences.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: "Interface Preferences" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/topmenu/uipreferences/" -description: "Displays a list of general preferences for your TrueNAS." -weight: 30 -aliases: /core/administration/uipreferences/ -tags: -- topmenu -- ui ---- - -{{< include file="/static/includes/COREUIPreferencesIntro.md" >}} - -## General Preferences - -{{< truetable >}} -| Name | Description | -|--------|-------------| -| **Choose Theme** | Select a preferred theme from the dropdown list. Prebuilt and custom themes are visible here. | -| **Prefer buttons with icons only** | Select checkbox to preserve screen space. Displays icons and tooltips instead of text labels. | -| **Enable Password Toggle** | Select checkbox to make an eye icon appear next to password fields. Click the icon to reveal the password. | -| **Reset Table Columns to Default** | Select checkbox to reset the display of all table columns as system default. | -| **Retro Logo** | Select checkbox to revert branding back to FreeNAS. | -| **Reset All Preferences to Default** | Select checkbox to reset all user preferences to their default values. Does not reset custom themes. | -| **UPDATE PREFERENCES** | Cick button to apply the current checkbox settings to the web interface. | -{{< /truetable >}} - -## Manage Custom Themes - -{{< truetable >}} -| Name | Description | -|--------|-------------| -| **theme name (variable)** | Use checkbox to select a custom theme if listed. | -| **DELETE SELECTED** | Click button to remove each selected custom theme from the system. | -| **CREATE NEW THEME** | Click button to open the theme editor. | -{{< /truetable >}} - -## Custom Theme Editor - -![Preferences Custom Theme](/images/CORE/Settings/PreferencesCustomTheme.png "Custom UI Theme") - -### Create Theme - -{{< truetable >}} -| Name | Description | -|--------|-------------| -| **Load colors from existing theme** | Select the theme option from the dropdown list. Imports settings into the **Create Theme** and **Preview** tabs. | -| **GENERAL** | Click to display the **GENERAL** tab with the primary options for a new theme. | -| **COLORS** | Click to display the **COLORS** tab with color options for a new theme. | -| **PREVIEW** | Click to display the **PREVIEW** tab. The **PREVIEW** updates to reflect current selections. | -{{< /truetable >}} - -#### GENERAL - -{{< truetable >}} -| Name | Description | -|--------|-------------| -| **Custom Theme Name** | Enter a name to identify the new theme. | -| **Menu Label** | Enter a short name to use in the TrueNAS web interface menus. | -| **Description** | Enter a short description of the new theme. | -| **Choose Primary** | Select a generic color from the dropdown list to use as the primary theme color. Or import a specific color setting. | -| **Choose Accent** | Select a generic color from the dropdown list to use as the accent color for the theme. Or import a specific color setting. | -| **Choose Topbar** | Select a color from the dropdown list to use as the color for the top menu bar in the web interface. | -| **SUBMIT** | Click to save the current selections and create the new theme. | -| **CANCEL** | Click to return to the **Preferences** screen without creating a new theme. | -{{< /truetable >}} - -#### COLORS - -{{< truetable >}} -| Name | Description | -|--------|-------------| -| **Background 1** | Either click on the color swatch or enter a hex value. This value applies to the **bg1** option in the **GENERAL** tab. | -| **Background 2** | Either click on the color swatch or enter a hex value. This value applies to the **bg2** option in the **GENERAL** tab. | -| **Foreground 1** | Either click on the color swatch or enter a hex value. This value applies to the **fg1** option in the **GENERAL** tab. | -| **Foreground 2** | Either click on the color swatch or enter a hex value. This value applies to the **fg2** option in the **GENERAL** tab. | -| **Alt Background 1** | Either click on the color swatch or enter a hex value. This value applies to the **alt-bg1** option in the **GENERAL** tab. | -| **Alt Background 2** | Either click on the color swatch or enter a hex value. This value applies to the **alt-bg2** option in the **GENERAL** tab. | -| **Alt Foreground 1** | Either click on the color swatch or enter a hex value. This value applies to the **alt-fg1** option in the **GENERAL** tab. | -| **Alt Foreground 2** | Either click on the color swatch or enter a hex value. This value applies to the **alt-fg2** option in the **GENERAL** tab. | -| **Yellow** | Either click on the color swatch or enter a hex value. This value applies to the **yellow** option in the **GENERAL** tab. | -| **Orange** | Either click on the color swatch or enter a hex value. This value applies to the **orange** option in the **GENERAL** tab. | -| **Red** | Either click on the color swatch or enter a hex value. This value applies to the **red** option in the **GENERAL** tab. | -| **Magenta** | Either click on the color swatch or enter a hex value. This value applies to the **magenta** option in the **GENERAL** tab. | -| **Violet** | Either click on the color swatch or enter a hex value. This value applies to the **violet** option in the **GENERAL** tab. | -| **Blue** | Either click on the color swatch or enter a hex value. This value applies to the **blue** option in the **GENERAL** tab. | -| **Cyan** | Either click on the color swatch or enter a hex value. This value applies to the **cyan** option in the **GENERAL** tab. | -| **Green** | Either click on the color swatch or enter a hex value. This value applies to the **green** option in the **GENERAL** tab. | -| **SUBMIT** | Click the button to save the current selections and create the new theme. | -| **CANCEL** | Click the button to return to the **Preferences** screen without creating a new theme. | -{{< /truetable >}} - -#### PREVIEW - -{{< truetable >}} -| Name | Description | -|--------|-------------| -| **Global Preview** | Color selections display in the **PREVIEW**. Click the toggle to turn the display of the **PREVIEW** widget on or off. | -{{< /truetable >}} - -### Preview - -{{< truetable >}} -| Name | Description | -|--------|-------------| -| **Buttons** | This tab shows examples of web interface buttons. The buttons display with the current theme settings applied. | -| **Forms** | This tab shows examples of web interface form options. The options display with the current theme settings applied. | -{{< /truetable >}} diff --git a/content/CORE/UIReference/TopMenu/_index.md b/content/CORE/UIReference/TopMenu/_index.md deleted file mode 100644 index 81aa2e24a9..0000000000 --- a/content/CORE/UIReference/TopMenu/_index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Top Menu -redirect: "https://www.truenas.com/docs/core/13.0/uireference/topmenu/" -description: "Reference documentation for the options panel that displays at the top of the TrueNAS UI." -weight: 2 -geekdocCollapseSection: true -tags: -- topmenu -- alerts -- taskmanager -- ui -related: false ---- - -{{< include file="/static/includes/CORETopMenu.md" >}} - -
- -## Top Menu Contents - -{{< children depth="2" sort="Name" description="true" >}} - -
diff --git a/content/CORE/UIReference/UIReferencePrint.md b/content/CORE/UIReference/UIReferencePrint.md deleted file mode 100644 index 7d656496ba..0000000000 --- a/content/CORE/UIReference/UIReferencePrint.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -title: "⎙ Download or Print" -redirect: "https://www.truenas.com/docs/core/13.0/uireference/printview/" -description: "View all CORE UI Reference content as a single page for download or print." -weight: 1 -no_print: "true" ---- - - \ No newline at end of file diff --git a/content/CORE/UIReference/_index.md b/content/CORE/UIReference/_index.md deleted file mode 100644 index a243de951b..0000000000 --- a/content/CORE/UIReference/_index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: UI Reference Guide -redirect: "https://www.truenas.com/docs/core/13.0/uireference/" -description: "This book contains descriptions of the various screens and fields available in the TrueNAS User Interface." -weight: 50 -geekdocCollapseSection: true -cascade: - - _target: - book: "COREUIReference" -related: false ---- - -Welcome to the TrueNAS CORE UI Reference Guide! - -{{< include file="/static/includes/UIReferenceIntro.md" >}} - -
- -## Table of Contents - -{{< children depth="2" description="true" >}} -
diff --git a/content/CORE/_index.md b/content/CORE/_index.md deleted file mode 100644 index ae2baf33a7..0000000000 --- a/content/CORE/_index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "TrueNAS CORE" -redirect: "https://www.truenas.com/docs/core/13.0/" -geekDocHidden: true -geekdocCollapseSection: true -weight: 10 -aliases: -related: false -cascade: - - _target: - volume: "CORE" - - _target: - volume: "Appendices" ---- - - -{{< columns size="small" >}} -

- -

-<---> -**TrueNAS CORE** is free and Open Source and is the successor to the wildly popular FreeNAS. -It runs on virtually any x86_64 system and provides a broad set of features for many users. -Plugin applications like Plex, NextCloud, and Asigra allow the functionality of a system to be customized for many use cases. -{{< /columns >}} - -
- -{{< columns size="small" >}} -

- -

-<---> -**TrueNAS CORE Enterprise** is provided as part of an [iXsystems hardware](/hardware) purchase or extended iXsystems Support Contract. -Systems can have either single or dual controllers to enable High Availability (HA). -It can also be provided with Enterprise-grade support from iXsystems. -{{< /columns >}} - -
- -## Nightly Development Featured Content - -To view documentation for historical or the latest stable TrueNAS CORE major versions, use the **Version** dropdown at the top of this page. - -
-

- Getting Started Guide -
Release Notes -
Community Hardware Guide -
Software Install -

-

- Tutorials -
Networking -
Storage -
Sharing -

-

- UI Reference Guide -
System -
Network -
Storage -

-

- Additional Content -
API Reference -
Security Reports -

-
-
diff --git a/content/Contributing/Documentation/NewArticles/_index.md b/content/Contributing/Documentation/NewArticles/_index.md index b2bf739f96..8e2cf8c902 100644 --- a/content/Contributing/Documentation/NewArticles/_index.md +++ b/content/Contributing/Documentation/NewArticles/_index.md @@ -51,7 +51,7 @@ Be sure to have unique names for each image file. ## Uploading the Article Bundle -Open the [User Recommendations]({{< ref "/CORE/CORETutorials/CommunityGuides/_index.md" >}}) section of the repository. +Open the appropriate repository section for the new content article. [![UploadImages](/images/Contribute/UploadingNewArticleBundle.png "Uploading Images")](/images/Contribute/UploadingNewArticleBundle.png) diff --git a/content/References/ConceptsAndTerms.md b/content/References/ConceptsAndTerms.md index df5088cf49..6ccfda9f22 100644 --- a/content/References/ConceptsAndTerms.md +++ b/content/References/ConceptsAndTerms.md @@ -68,23 +68,23 @@ While TrueNAS is designed for and ever-evolving towards increased user friendlin The main ARC resides in system memory. The L2ARC is 2nd layer ARC assigned to a disk to expand ARC capability. -* [**ZFS Datasets**]({{< relref "CORE/CORETutorials/Storage/Pools/Datasets.md" >}}): similar to a conventional mounted filesystem. +* [**ZFS Datasets**]({{< relref "SCALE/SCALETutorials/Datasets/_index.md" >}}): similar to a conventional mounted filesystem. It appears in casual inspection as "just another folder". However, unlike conventional mounted filesystems, each ZFS dataset has its own set of properties. -* [**ZFS Pools**]({{< relref "CORE/CORETutorials/Storage/Pools/_index.md" >}}): filesystem container that is composed of one or more vdevs. +* [**ZFS Pools**]({{< relref "SCALE/SCALETutorials/Storage/_index.md" >}}): filesystem container that is composed of one or more vdevs. * [**ZFS vdev**]({{< relref "/references/ZFSPrimer.md" >}}): ZFS virtual device. A ZFS pool is made up by one or more vdevs. A vdev can be created using a single disk or many. A vdev has many configurations: single disk, stripe, RAIDz1, RAIDz2, RAIDz3, or mirror. -* [**ZFS zvols**]({{< relref "CORE/CORETutorials/Storage/Pools/Zvols.md" >}}): datasets that represent block devices. +* [**ZFS zvols**]({{< relref "SCALE/SCALETutorials/Datasets/AddManageZvols.md" >}}): datasets that represent block devices. * [**ZIL**](https://www.truenas.com/blog/zfs-zil-and-slog-demystified/) (or ZFS Intent Log): special vdev class. This is also sometimes referred to as a SLOG or Separate Intent Log. -* [**Fusion Pool**]({{< relref "CORE/CORETutorials/Storage/Pools/FusionPool.md" >}}) (or metadata vdev): is a special class of vdev. +* [**Fusion Pool**]({{< relref "SCALE/SCALETutorials/Storage/FusionPoolsScale.md" >}}) (or metadata vdev): is a special class of vdev. This special vdev can store meta data such as file locations and allocation tables. Using a special vdev drastically speeds up random I/O and can cut the average number of spinning-disk I/Os needed to find and access a file by up to half. @@ -95,21 +95,21 @@ While TrueNAS is designed for and ever-evolving towards increased user friendlin As a result, the checksum no longer matches. When ZFS identifies a disk block checksum error on a pool that is mirrored or uses RAIDZ, it replaces the corrupted data with the correct data. -* [**ZFS Snapshots**]({{< relref "CORE/CORETutorials/Storage/Snapshots.md" >}}): read-only copy of a file system or volume. +* [**ZFS Snapshots**]({{< relref "SCALE/SCALETutorials/Datasets/CreatingSnapshots.md" >}}): read-only copy of a file system or volume. When a snapshot of a dataset is made, ZFS records the timestamp of when the snapshot was made. No data is copied and no extra storage is consumed. Only when changes occur in the filesystem and the data in it diverges from the snapshot does the snapshot start using additional storage. -* [**ZFS Scrub**]({{< relref "CORE/CORETutorials/Tasks/CreatingScrubTasks.md" >}}): the process that ZFS uses to verify the data on disk. +* [**ZFS Scrub**]({{< relref "SCALE/SCALETutorials/DataProtection/ScrubTasksSCALE.md" >}}): the process that ZFS uses to verify the data on disk. All of the data is read and checked against the computed checksums to verify that no corruption has occurred. -* [**ZFS Resilver**]({{< relref "CORE/CORETutorials/Tasks/UsingResilverPriority.md" >}}): process to reconstruct data on a disk when that disk has replaced a failed disk. +* [**ZFS Resilver**]({{< relref "SCALE/SCALETutorials/DataProtection/ScrubTasksSCALE.md" >}}): process to reconstruct data on a disk when that disk has replaced a failed disk. -* [**ZFS Replication**]({{< relref "ReplicationTasks.md" >}}): copying a ZFS dataset to another dataset. +* [**ZFS Replication**]({{< relref "SCALE/SCALETutorials/DataProtection/Replication/_index.md" >}}): copying a ZFS dataset to another dataset. The receiving dataset can be on the same machine or on another machine in a remote location. Replication works with snapshots so only the changes to the stored data need to be sent to the receiving dataset. -* [**Cloud Sync**]({{< relref "CORE/CORETutorials/Tasks/CreatingCloudSyncTasks.md" >}}): TrueNAS sending, receiving, or synchronizing data with a Cloud Storage provider like Amazon S3, Google Cloud, or Microsoft Azure. +* [**Cloud Sync**]({{< relref "SCALE/SCALETutorials/DataProtection/CloudSyncTasks/_index.md" >}}): TrueNAS sending, receiving, or synchronizing data with a Cloud Storage provider like Amazon S3, Google Cloud, or Microsoft Azure. ## Networking Terminology diff --git a/content/References/SMB.md b/content/References/SMB.md index 133c762f83..f4d824b088 100644 --- a/content/References/SMB.md +++ b/content/References/SMB.md @@ -29,7 +29,7 @@ Another helpful reference is [Methods For Fine-Tuning Samba Permissions](https:/ {{< include file="/static/includes/SMBShareMSDOSalert.md" >}} -Note: the [SMB1 protocol is disabled by default]({{< relref "/CORE/CORESecurityReports/SMB1Advisory.md" >}}). +Note: the [SMB1 protocol is disabled by default](https://www.truenas.com/docs/core/13.0/coresecurityreports/smb1advisory/). By default, Samba disables NTLMv1 authentication for security. Standard configurations of Windows XP and some configurations of later clients like Windows 7 are not able to connect with NTLMv1 disabled. diff --git a/content/References/ZFSDeduplication.md b/content/References/ZFSDeduplication.md index 7402e7240f..87c895b505 100644 --- a/content/References/ZFSDeduplication.md +++ b/content/References/ZFSDeduplication.md @@ -86,7 +86,7 @@ It is recommended to use SSDs that do not rely on a limited amount of fast cache Most SSDs performance (latency) drops when the onboard cache is fully used and more writes occur. Always review the steady state performance for 4K random mixed read/write. -[Special vdev]({{< relref "CORE/CORETutorials/Storage/Pools/FusionPool.md" >}}) SSDs receive continuous, heavy I/O. +[Special vdev]({{< relref "SCALE/SCALETutorials/Storage/FusionPoolsScale.md" >}}) SSDs receive continuous, heavy I/O. HDDs and many common SSDs are inadequate. As of 2021, some recommended SSDs for deduplicated ZFS include Intel Optane 900p, 905p, P48xx, and better devices. Lower cost solutions are high quality consumer SSDs such as the Samsung EVO and PRO models. @@ -107,8 +107,6 @@ Also, the more duplicated the data, the fewer entries and smaller DDT. Pools suitable for deduplication, with deduplication ratios of 3x or more (data can be reduced to a third or less in size), might only need 1-3 GB of RAM per 1 TB of data. The actual DDT size can be estimated by deduplicating a limited amount of data in a temporary test pool. -Use the [tunable]({{< relref "CORE/UIReference/System/Tunables.md" >}}) **vfs.zfs.arc.meta_min** (*type*=*LOADER*, *value*=*bytes*) to force ZFS to reserve no less than the given amount of RAM for metadata caching. - ### CPU Deduplication consumes extensive CPU resources and it is recommended to use a high-end CPU with 4-6 cores at minimum. @@ -142,7 +140,7 @@ If deduplication is used in an inadequately built system, these symptoms might b * **Cause**: When ZFS has fast special vdev SSDs, sufficient RAM, and is not limited by disk I/O, then hash calculation becomes the next bottleneck. Most of the ZFS CPU consumption is from attempting to keep hashing up to date with disk I/O. When the CPU is overburdened, the console becomes unresponsive and the web UI fails to connect. Other tasks might not run properly because of timeouts. - This is often encountered with [pool scrubs]({{< relref "CORE/CORETutorials/Tasks/CreatingScrubTasks.md" >}}) and it can be necessary to pause the scrub temporarily when other tasks are a priority. + This is often encountered with [pool scrubs]({{< relref "SCALE/SCALETutorials/DataProtection/ScrubTasksSCALE.md" >}}) and it can be necessary to pause the scrub temporarily when other tasks are a priority. * **Diagnose**: An easily seen symptom is that console logins or prompts take several seconds to display. Generally, multiple entries with command kernel {z_rd_int_[NUMBER]} can be seen using the CPU capacity, and the CPU is heavily (98%+) used with almost no idle. * **Solutions**: Changing to a higher performance CPU can help but might have limited benefit. 40 core CPUs have been observed to struggle as much as 4 or 8 core CPUs. diff --git a/content/SCALE/GettingStarted/Migrate/MigrateCOREHAtoSCALEHA.md b/content/SCALE/GettingStarted/Migrate/MigrateCOREHAtoSCALEHA.md index 15aac5ddfe..2af87c31a4 100644 --- a/content/SCALE/GettingStarted/Migrate/MigrateCOREHAtoSCALEHA.md +++ b/content/SCALE/GettingStarted/Migrate/MigrateCOREHAtoSCALEHA.md @@ -1,6 +1,6 @@ --- -title: "Enterprise HA Migrations" -description: "Discusses migrating a TrueNAS High Availability (HA) system from FreeBSD- to Linux-based TrueNAS software." +title: "Enterprise Migrations" +description: "Instructions for TrueNAS Enterprise users to migrate from FreeBSD- to Linux-based TrueNAS software." weight: 25 aliases: tags: @@ -11,6 +11,7 @@ keywords: - enterprise data storage solution - data migration - nas data storage +slug: migrate-enterprise --- **TrueNAS Enterprise customers should consult with iXsystems Support before attempting to migrate.** diff --git a/content/SCALE/GettingStarted/Migrate/MigratingFromCORE.md b/content/SCALE/GettingStarted/Migrate/MigratingFromCORE.md index c05ec0fc8e..705b833cf9 100644 --- a/content/SCALE/GettingStarted/Migrate/MigratingFromCORE.md +++ b/content/SCALE/GettingStarted/Migrate/MigratingFromCORE.md @@ -1,6 +1,6 @@ --- -title: "Migrating TrueNAS" -description: "Provides instructions on migrating from FreeBSD- to Linux-based TrueNAS versions. Migration methods include using an ISO or manual update file." +title: "Community Migrations" +description: "Provides instructions for TrueNAS community users to migrate from FreeBSD- to Linux-based TrueNAS versions. Migration methods include using an ISO or manual update file." weight: 15 aliases: - /scale/gettingstarted/migratingfromcore/ @@ -13,6 +13,7 @@ keywords: - nas data storage - RAIDz - spinning disk +slug: migrate-community --- ## Migration Overview diff --git a/content/SCALE/GettingStarted/Migrate/_index.md b/content/SCALE/GettingStarted/Migrate/_index.md index 6d8d388cca..47fd268abb 100644 --- a/content/SCALE/GettingStarted/Migrate/_index.md +++ b/content/SCALE/GettingStarted/Migrate/_index.md @@ -1,6 +1,6 @@ --- -title: "TrueNAS Migrations" -description: "Instructions for migrating from FreeBSD to Linux-based TrueNAS versions." +title: "Migrating from CORE" +description: "Instructions for migrating from FreeBSD TrueNAS CORE to Linux-based TrueNAS versions." geekdocCollapseSection: true weight: 40 aliases: @@ -20,7 +20,19 @@ keywords: - data migration --- +On March 20, 2024, iXsystems [announced](https://www.truenas.com/blog/truenas-core-13-3-plans/) that the FreeBSD-based TrueNAS CORE platform has entered "sustaining engineering phase within the TrueNAS project." +With this transition, TrueNAS 13.0 and 13.3 continue to receive bug fixes related to stability and security. +New feature development and component improvement continues on Linux-based TrueNAS versions. + +Existing TrueNAS 13.0 and 13.3 users who are comfortable with their TrueNAS system can remain on that major version. +Users looking for new feature development can sidegrade to the Linux-based TrueNAS platform at any time, preserving data and essential NAS functionality. {{< include file="/static/includes/MigrateCOREtoSCALE24_04.md" >}} +
+ +## Contents + +{{< children depth="1" description="true" >}} +
diff --git a/content/SCALE/GettingStarted/SCALEReleaseNotes.md b/content/SCALE/GettingStarted/SCALEReleaseNotes.md index 5be565c490..775a0960c8 100644 --- a/content/SCALE/GettingStarted/SCALEReleaseNotes.md +++ b/content/SCALE/GettingStarted/SCALEReleaseNotes.md @@ -7,6 +7,7 @@ aliases: - /scale/scalenextversion/ - /scale/scale22.12/ - /scale/25.04/gettingstarted/scalereleasenotes/ + - /releasenotes/ weight: 10 related: false --- @@ -15,13 +16,21 @@ related: false {{< hint type="tip" title="25.04 Nightly Development Documentation" >}} This page tracks the latest development roadmap and notes for the future TrueNAS major version 25.04 (Fangtooth). -See the stable [24.04 (Dragonfish)](https://www.truenas.com/docs/scale/24.04/gettingstarted/scalereleasenotes/) or early development [24.10 (Electric Eel)](https://www.truenas.com/docs/scale/24.10/gettingstarted/scalereleasenotes/) release notes for information relating to that version. +See the stable [24.10 (Electric Eel)](https://www.truenas.com/docs/scale/24.10/gettingstarted/scalereleasenotes/) release notes for information relating to that version. {{< /hint >}} ## Features {{< include file="/static/includes/25.04FeatureList.md" >}} +## Obtaining a Release + +{{< include file="/static/includes/EarlyReleaseWarning.md" >}} + +For adventurous users that want to experiment with the latest feature development, 25.04 (Fangtooth) nightly images are available from the [the TrueNAS downloads server](https://download.truenas.com/truenas-scale-fangtooth-nightly/). + +More details are available from [Software Releases]({{< relref "/TrueNASUpgrades/_index.md" >}}). + ## Release Schedule {{< include file="/static/includes/ReleaseScheduleWarning.md" >}} @@ -33,23 +42,6 @@ See the stable [24.04 (Dragonfish)](https://www.truenas.com/docs/scale/24.04/get {{< include file="/static/includes/SoftwareStatusPage.md" >}} {{< /expand >}} -## 25.04 Nightly Development Changelog - -Coming soon - -{{< include file="/static/includes/RESTAPIDeprecationNotice.md" >}} - - -Update the system to the latest maintenance release of the installed major version before attempting to upgrade to a new TrueNAS major version. - -include file="/static/includes/SCALEUpgradePaths.md" +{{< include file="/static/includes/SCALEUpgradePaths.md" >}} -### TrueNAS Migrations + ## Component Versions Click the component version number to see the latest release notes for that component. @@ -96,8 +94,9 @@ Click the component version number to see the latest release notes for that comp {{< truetable >}} | Component | Version | |-----------|-------------| -| Linux Kernel | [_._.__](https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tag/?h=v_._.__) | -| OpenZFS | [_._.__](https://github.com/openzfs/zfs/tree/zfs-_._.__) | +| Linux Kernel | [6.12](https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tag/?h=v6.12) | +| OpenZFS | [2.3.0-2](https://github.com/openzfs/zfs/tree/zfs-2.3.0-rc3) | +| Docker Engine | [27.3.1](https://docs.docker.com/engine/release-notes/27/#2731) | {{< /truetable >}} ### OpenZFS Feature Flags @@ -107,12 +106,21 @@ Any new feature flags introduced since the previous OpenZFS version that was int {{< truetable >}} | Feature Flag | GUID | Notes | |--------------|------|-------| -| | [org.openzfs:raidz_expansion](https://openzfs.github.io/openzfs-docs/man/master/7/zpool-features.7.html#raidz_expansion) | | -| | [com.delphix:redaction_list_spill](https://openzfs.github.io/openzfs-docs/man/master/7/zpool-features.7.html#redaction_list_spill) | | +| fast deduplication | [com.klarasystems:fast_dedup](https://openzfs.github.io/openzfs-docs/man/master/7/zpool-features.7.html#fast_dedup) | This flag is present in 24.10, but is now generally available through the TrueNAS UI. | {{< /truetable >}} For more details on feature flags, see [OpenZFS Feature Flags](https://openzfs.github.io/openzfs-docs/Basic%20Concepts/Feature%20Flags.html) and [OpenZFS zpool-feature.7](https://openzfs.github.io/openzfs-docs/man/7/zpool-features.7.html). +## 25.04 Nightly Development Changelog + +* The TrueNAS REST API is deprecated in TrueNAS 25.04 and replaced by the [TrueNAS websocket client](https://github.com/truenas/api_client). Full removal of the REST API is planned for a future release. +* The default libvirt account UID & GID is changed to a less common value to avoid clashing with user created UID/GIDs. See Upgrade Notes above for more information ([NAS-131695](https://ixsystems.atlassian.net/browse/NAS-131695)). +* Improved API key mechanism with support for user-linked API keys ([NAS-131396](https://ixsystems.atlassian.net/browse/NAS-131396)). + Existing API keys created via the TrueNAS API (not UI or TrueCommand) that specify an allow list with white-listed API methods are revoked upon upgrade because there is no clean way to migrate to the new system. + Legacy API keys from TrueNAS 24.10 or earlier migrate to the root, admin, or truenas_admin account, depending on server configuration + + -TrueCommand is a multi-system management application that helps control and monitor your TrueNAS fleet. -TrueCommand assists in managing TrueNAS systems through REST APIs, WebSocket APIs, and a web user interface. -The TrueCommand web interface provides single sign-on functionality and unified administration of users and TrueNAS systems. - -TrueCommand can monitor an entire fleet of TrueNAS systems and thousands of online storage devices simultaneously. -This includes displaying statistics on storage usage, network activity, active services, and more. -TrueCommand also has the ability to create custom reports about individual systems or a combination of many systems. -{{< /columns >}} - - diff --git a/content/TrueNASUpgrades/_index.md b/content/TrueNASUpgrades/_index.md index 59d4397724..9757a5fe03 100644 --- a/content/TrueNASUpgrades/_index.md +++ b/content/TrueNASUpgrades/_index.md @@ -62,8 +62,6 @@ See the [Documentation Archive](https://www.truenas.com/docs/archive/) for conte {{< include file="/static/includes/SCALEUpgradePaths.md" >}} -{{< include file="/static/includes/COREUpgradePaths.md" >}} - ## Release Schedules **The release names and dates provided here are tentative and can change at any time.** diff --git a/content/TruenasApps/StableApps/InstallNetdataApp.md b/content/TruenasApps/StableApps/InstallNetdataApp.md index cf91ba59cf..0a8aca67c6 100644 --- a/content/TruenasApps/StableApps/InstallNetdataApp.md +++ b/content/TruenasApps/StableApps/InstallNetdataApp.md @@ -16,7 +16,7 @@ keywords: --- The TrueNAS Netdata app provides an easy way to install and access the Netdata infrastructure monitoring solution. -TrueNAS deploys the Netdata app in a Kubernetes container using the Helm package manager. +TrueNAS deploys the Netdata app in a Docker container using Docker Compose. After successfully deploying the app, you can access the Netdata web portal from TrueNAS. The Netdata web portal opens on the local dashboard, and where you can create new dashboards, add plugins, metric databases, physical and virtual systems, containers, and other cloud deployments you want to monitor. The portal also provides access to the Netdata Cloud sign-in screen. @@ -24,119 +24,140 @@ The portal also provides access to the Netdata Cloud sign-in screen. {{< include file="/static/includes/AppsUnversioned.md" >}} ## Before You Begin -The TrueNAS Netdata app does not require advance preparation. +Prepare TrueNAS before installing the app by: -You can allow TrueNAS to automatically create storage volumes for the Netdata app or you can create specific datasets to use for configuration, cache, and library storage and extra storage volumes in the container pod. -If using specific datasets, create these before beginning the app installation. +{{< include file="/static/includes/apps/BeforeYouBeginStableApps.md" >}} +{{< include file="/static/includes/apps/BeforeYouBeginRunAsUser.md" >}} -The administrator account must have sudo permissions enabled. -To verify, go to **Credentials > Local User**. -Click on the administrator user (e.g., admin), then click **Edit**. Scroll down to the sudo permissions. -Select either **Allow all sudo commands** to permit changes after entering a password (not recommended in this instance) or **Allow all sudo commands with not password** to permit changes without requiring a password. -If you upgraded from Angelfish or early releases of Bluefin that do not have an admin user account, see [Creating an Admin User Account]({{< relref "ManageLocalUsersSCALE.md" >}}) for instructions on correctly creating an administrator account with the required permissions. +
{{< trueimage src="/images/SCALE/Apps/NetdataAppDetailsScreen.png" alt="Netdata Information Screen" id="Netdata Information Screen" >}}
-You can create a Netdata account before or after installing and deploying the Netdata app. +{{< include file="/static/includes/apps/BeforeYouBeginAddAppDatasets.md" >}} -## Installing Netdata on TrueNAS -To install the **Netdata** application, go to **Apps**, click on **Discover Apps**, then either scroll down to the **Netdata** app widget or begin typing Netdata in the search field to filter the list to find the Netdata app widget. +

Netdata uses three datasets: config, lib, and cache. +Follow the instruction below in **Creating Datasets for Apps** to correctly set up these datasets.

-{{< trueimage src="/images/SCALE/Apps/NetdataWidget.png" alt="Netdata App Widget" id="Netdata App Widget" >}} +
{{< include file="/static/includes/apps/BeforeYouBeginAddAppDatasetsProcedure.md" >}} +
-Click on the widget to open the **Netdata** application details screen. +* (Optional) Create a Netdata account. + The app install wizard allows you to create a new Netdata account when configuring the app in TrueNAS, or to configure it to use a preexisting account. -{{< trueimage src="/images/SCALE/Apps/NetdataAppDetailsScreen.png" alt="Netdata App Details Screen" id="Netdata App Details Screen" >}} +## Installing Netdata in TrueNAS +{{< hint info >}} +This basic procedure covers the required Netdata app settings. +For optional settings, see [Understanding App Installation Wizard Settings](#understanding-app-installation-wizard-settings). +{{< /hint >}} -Click **Install** to open the **Install Netdata** screen. +{{< include file="static/includes/apps/MultipleAppInstancesAndNaming.md" >}} + +{{< include file="/static/includes/apps/LocateAndOpenInstallWizard.md" >}} {{< trueimage src="/images/SCALE/Apps/InstallNetdataScreen.png" alt="Install Netdata Screen" id="Install Netdata Screen" >}} -Application configuration settings presented in several sections, are explained in [Understanding Netdata Settings](#understanding-netdata-wizard-settings) below. -To find specific fields click in the **Search Input Fields** search field, scroll down to a particular section or click on the section heading on the navigation area in the upper-right corner. +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} -Accept the default values in **Application Name** and **Version**. +The TrueNAS app is configured with all the required environment variables, but if you want to further customize the container, click **Add** to the right of **Additional Environment Variables** for each to enter the variable(s) and values(s). +See [Netdata Configuration](#netdata-configuration-settings) below for more information. -Accept the default settings in **Netdata Configuration** and the default port in **Node Port to use for Netdata UI**. +Accept the default values in **Network Configurations**. The TrueNAS Netdata app uses the default port **20489** to communicate with Netdata and show the Netdata local dashboard. +Accept the default settings in **Advanced DNS Settings**. +See [Network Configuration](#network-configuration-settings) below for more information. -Make no changes in the **Storage** section to allow TrueNAS to create the storage volumes for the app, or to use datasets created for Netdata configuration storage, select **Enable Host Path for Netdata** to show the **Host Path for Netdata Configuration** settings. +Add your **Storage Configuration** settings. +Set **Type** for **Netdata Config Storage** to **Host Path (Path that already exists on the system)**. +Select **Enable ACL**, and then enter or browse to and select the **config** dataset to populate the **Host Path** field. -{{< trueimage src="/images/SCALE/Apps/InstallNetdataStorageEnableHostPath.png" alt="Install Netdata Storage Enable Host Path" id="Install Netdata Storage Enable Host Path" >}} +{{< trueimage src="/images/SCALE/Apps/InstallNetdataStorageConfigACLandACE.png" alt="Add Netdata Config Storage ACL and ACE Settings" id="Add Netdata Config Storage ACL and ACE Settings" >}} -Enter or browse to select the dataset created for Netdata configuration storage to populate the mount path. -If using datasets created for cache and library storage, enable these options, then enter or browse to the datasets for each. +Click **Add** to the right of **ACL Entries** to show the block of permissions settings. +Change **ID Type** to user, enter **0** in **ID**, and set **Access** to full control. -Accept the default settings in **Advanced DNS Settings**. +Next, select **Force Flag**. + +Repeat the above for the **lib** and **cache** storage volumes. -Accept the default values in **Resources Limits** or select **Enable Pod Resource limits** to show resource configuration options for CPU and memory and enter new values to suit your use case. +Accept the defaults in **Resources Configuration**. -Click **Install**. +Click **Install**. A progress dialog displays before switching to the **Installed** applications screen. The system opens the **Installed Applications** screen with the Netdata app in the **Deploying** state. When the installation completes it changes to **Running**. {{< trueimage src="/images/SCALE/Apps/NetdataInstalled.png" alt="Netdata Installed" id="Netdata Installed" >}} +{{< trueimage src="/images/SCALE/Apps/NetdataSignInScreen.png" alt="Nextcloud Sign In Screen" id="Nextcloud Sign In Screen" >}} + Click **Web Portal** on the **Application Info** widget to open the Netdata web interface showing the local dashboard. {{< trueimage src="/images/SCALE/Apps/NetdataWebPortalLocalDashboard.png" alt="Netdata Web Portal Local Dashboard" id="Netdata Web Portal Local Dashboard" >}} -## Understanding Netdata Wizard Settings -The following sections provide more detail explanations of the settings found in each section of the **Install Netdata** screen. +Refer to Netdata user guides and documentation for more information on configuring Netdata dashboards. + +## Understanding App Installation Wizard Settings + +The following section provides more detailed explanations of the settings in each section of the **Install Netdata** wizard. ### Application Name Settings -{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} ### Netdata Configuration Settings -You can accept the defaults in the **Netdata Configuration** settings or enter the settings you want to use. - -Click **Add** to the right of **Netdata image environment** to display the environment variable **Name** and **Value** fields. +Accept defaults in the **Netdata Configuration** settings, or to customize the container deployment click **Add** to the right of **Additional Environment Variables** to show the **Name** and **Value** fields used to enter variables. Netdata does not require using environment variables to deploy the application but you can enter any you want to use to customize your container. {{< trueimage src="/images/SCALE/Apps/InstallNetdataConfigAddEnvironmentVariable.png" alt="Netdata Configuration Add Environment Variable" id="Netdata Configuration Add Environment Variable" >}} +Refer to Netdata user guides and documentation for information on configuring and customizing your app. +Guides include [GitHub Install Netdata with Docker](https://github.com/netdata/netdata/blob/master/packaging/docker/README.md), and [Netdaa Deployment Guides](https://learn.netdata.cloud/docs/deployment-guides/). +Netdata provides assistance through their community forums and [Support site](https://www.netdata.cloud/support/). + +### Network Configuration Settings The TrueNAS Netdata app uses port **20489** to communicate with Netdata and open the web portal. Netdata documentation states it uses **19999** as the default port, but it recommends restricting access to this for security reasons. -Refer to the TrueNAS [default port list](https://www.truenas.com/docs/references/defaultports/) for a list of assigned port numbers. -To change the port numbers, enter a number within the range 9000-65535. -### Netdata Storage Settings -TrueNAS defaults to automatically creating storage volumes for Netdata without enabling the host path options. +{{< include file="/static/includes/apps/InstallWizardDefaultPorts.md" >}} +{{< include file="static/includes/apps/InstallWizardHostNetworkSettings.md" >}} +{{< include file="/static/includes/apps/InstallWizardAdvancedDNSSettings.md" >}} + +### Storage Configuration Settings +TrueNAS provides two options for storage volumes: ixVolumes and host paths. -To create and use datasets for the Netdata configuration, cache, and library storage or extra storage volumes inside the container pod, first create these datasets. -Go to **Datasets** and create the datasets before you begin the app installation process. -See [Add Datasets]({{< relref "DatasetsScale.md" >}}) for more information. -Select **Enable Host Path for Netdata** to show the volume mount path field to add the configuration storage dataset. +Netdata needs three datasets: +* **config** +* **lib** +* **cache** -{{< trueimage src="/images/SCALE/Apps/InstallNetdataStorageEnableHostPath.png" alt="Install Netdata Storage Enable Host Path" id="Install Netdata Storage Enable Host Path" >}} +Create datasets before beginning the app installation process. Set the **Dataset Preset** to **Apps** before saving the datasets. +If you group the required datasets under a parent dataset, for example, a dataset named *netdata*, set the **Dataset Preset** to **Apps** to avoid permissions error messages and issues that can block fully deploying the app. See [Before You Begin](#before-you-begin) for more information on adding these datasets. -Enter or browse to select the dataset and populate the mount path field. -To use datasets created for cache and library storage volumes, first enable each option and then enter or browse to select the datasets tp populate the mount path fields for each. +You can add extra storage volumes at the time of installation or edit the application after it deploys. Stop the app before editing settings. +{{< include file="/static/includes/apps/InstallAppStorageConfig2.md" >}} -If you want to add storage volumes inside the container pod for other storage, click **Add** to the right of **Extra Host Path Volumes** for each storage volume (dataset) you want to add. +#### Setting Dataset ACL Permissions +You can configure ACL permissions for the required dataset in the **Install Netdata** wizard, or from the **Datasets** screen any time after adding the datasets. -{{< trueimage src="/images/SCALE/Apps/InstallNetdataStorageExtraHostPath.png" alt="Install Netdata Storage Add Extra Host Path" id="Install Netdata Storage Add Extra Host Path" >}} +{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}} -You can add extra storage volumes at the time of installation or edit the application after it deploys. Stop the app before editing settings. +{{< expand "Adding ACL Permissions from the Datasets Screen" "v">}} +First select the dataset row, and scroll down to the **Permissions** widget, and then click **Edit** to open the **Edit ACL** screen. +Change the **@owner** and **@group** values from **root** to the administrative user for your TrueNAS system, and click apply for each. +Next, add an ACL entry for the run-as user. +For Netdata, the run-as users is **0** for **root**. Add a user entry for this user. +Save the ACL before leaving the screen. -### Advanced DNS Settings -The default **DNS Configuration** is sufficient for a basic installation. -To specify additional DNS options, click **Add** to the right of **DNS Options** to add the DNS **Option Name** and **Option Value** fields. +See [Setting Up Permissions]({{< relref "PermissionsSCALE.md" >}}) and [Edit ACL Screen]({{< relref "EditACLScreens.md" >}}) for more information. +{{< /expand >}} -{{< trueimage src="/images/SCALE/Apps/InstallNetdataAdvancedDNSOptions.png" alt="Install Netdata Advanced DNS Options" id="Install Netdata Advanced DNS Options" >}} +#### Mounting an SMB Share Storage Volume +TrueNAS **Additional Storage** options include the ability to mount an SMB share inside the container pod. -### Resource Limits Settings -Accept the default values in **Resources Limits** or select **Enable Pod Resource limits** to show CPU and memory resource configuration options. +{{< include file="/static/includes/apps/InstallWizardStorageSMBOption.md" >}} -By default, the application is limited to use no more than four CPU cores and eight gigabytes available memory. -The application might use considerably less system resources. +### Resources Configuration Settings {{< trueimage src="/images/SCALE/Apps/InstallNetdataResourceLimitsEnablePod.png" alt="Install Netdata Resource Limits" id="Install Netdata Resource Limits" >}} -To customize the CPU and memory allocated to the container (pod) Netdata uses, enter new CPU values as a plain integer value followed by the suffix m (milli). -Default is 4000m. - -Accept the default value 8Gi allocated memory or enter a new limit in bytes. -Enter a plain integer followed by the measurement suffix, for example 129M or 123Mi. +{{< include file="/static/includes/apps/InstallWizardResourceConfig.md" >}} ## Using the Netdata Web Portal After deploying the TrueNAS Netdata app click on **Web Portal** to open the Netdata agent local dashboard. diff --git a/content/TruenasApps/StableApps/InstallNextCloudMedia.md b/content/TruenasApps/StableApps/InstallNextCloudMedia.md index e74b57160b..d598ba15fe 100644 --- a/content/TruenasApps/StableApps/InstallNextCloudMedia.md +++ b/content/TruenasApps/StableApps/InstallNextCloudMedia.md @@ -7,6 +7,7 @@ aliases: - /scale/scaletutorials/apps/installnextcloudmedia/ - /scale/scaletutorials/apps/chartapps/installnextcloudmedia/ - /scale/scaletutorials/apps/stableapps/installnextcloudmedia/ + - /scale/scaletutorials/apps/communityapps/installnextcloudmedia/ - /truenasapps/communityapps/installnextcloudmedia/ tags: - apps @@ -18,8 +19,13 @@ keywords: Nextcloud is a drop-in replacement for many popular cloud services, including file sharing, calendar, groupware, and more. One of its more common uses for the home environment is serving as a media backup, and organizing and sharing service. -This procedure demonstrates how to set up Nextcloud on TrueNAS, and configure it to support hosting a wider variety of media file previews, including High Efficiency Image Container (HEIC), MP4, and MOV files. -The instructions in this article apply to TrueNAS 22.10.0 and later. +This procedure demonstrates how to set up Nextcloud on TrueNAS and configure it to support hosting a wider variety of media file previews, including High-Efficiency Image Container (HEIC), MP4, and MOV files. + +TrueNAS offers one deployment option for setting up Nextcloud, a Linux Debian-based TrueNAS version application available in TrueNAS releases 24.10 and later. +The instructions in this article apply to these TrueNAS 24.10 and later releases. + +TrueNAS offered a FreeBSD-based TrueNAS Nextcloud plugin in releases 13.0 and 13, but it is no longer available in TrueNAS 13.0 and is soon to be unavailable in 13.3. Refer to release notes for more information on upcoming and current changes. +For more information on the FreeBSD-based Nextcloud plugin, see [Nextcloud]({{< relref "/content/solutions/integrations/nextcloud.md" >}}). {{< include file="/static/includes/AppsUnversioned.md" >}} @@ -27,59 +33,59 @@ The instructions in this article apply to TrueNAS 22.10.0 and later. Before you install the Nextcloud app: {{< include file="/static/includes/apps/BeforeYouBeginStableApps.md" >}} +{{< include file="/static/includes/apps/BeforeYouBeginRunAsUser.md" >}} -{{< include file="/static/includes/apps/BeforeYouBeginAddAppCertificate.md" >}} +
{{< trueimage src="/images/SCALE/Apps/NextcloudDetailsScreen.png" alt="Nextcloud App Details Screen" id="Nextcloud App Details Screen" >}}
-

Adding a certificate is optional but if you want to use a certificate for this application, either create a new self-signed CA and certificate or import an existing CA and create the certificate for Nextcloud. A certificate is not required to deploy the application.

+{{< include file="/static/includes/apps/BeforeYouBeginAddNewAppUser.md" >}} -* Go to **Datasets** and select the pool or dataset where you want to place the Nextcloud dataset. - For example, */tank/apps/nextcloud* or */tank/nextcloud*. - You can use either an existing pool or [create a new one]({{< relref "CreatePoolWizard.md" >}}). +{{< include file="/static/includes/apps/BeforeYouBeginAddAppDatasets.md" >}} - [Create the three dataset(s)]({{< relref "DatasetsSCALE.md" >}}) before beginning the app installation process. - Nextcloud uses **html** for app data, **data** for user data, and **postgres_data** for the database data storage volume. +
Create the three dataset(s) before beginning the app installation process. + Nextcloud uses html for app data, data for user data, and postgres_data for the database data storage volume. Earlier versions of the Nextcloud app relied on four datasets. If upgrading with an existing deployment of this application the app is migrated to the new configuration. You can organize these datasets under a parent dataset to keep them separated from datasets for other potential applications. - For example, create the *nextcloud* dataset and nest each dataset under it. + For example, create the nextcloud dataset and nest each dataset under it. If you organize the Nextcloud required datasets under a parent dataset you must configure ACL permissions for it. - Use the **Generic** dataset preset when creating the parent dataset! - When you add the **postgres_data** dataset, it must have a **POSIX** ACL. + Use the Generic dataset preset when creating the parent dataset! + When you add the postgres_data dataset, it must have a POSIX ACL.
- {{< expand "Configure Nextcloud Datasets and ACLs" "v" >}} - You must configure the ACLs permissions for two datasets while on the **Datasets** screen: the parent dataset (i.e., the *nextcloud* dataset) and the **postgres_data** dataset. - You can configure ACL permissions for the Nextcloud **html** and **data** datasets when prompted or configure them in the app installation wizard as described in the installation section. +
{{< expand "Configure Nextcloud Datasets and ACLs" "v" >}} + You must configure the ACLs permissions for two datasets while on the >Datasets screen: the parent dataset (i.e., the nextcloud dataset) and the postgres_data dataset. + You can configure ACL permissions for the Nextcloud html and data datasets when prompted or configure them in the app installation wizard as described in the installation section. - To configure the dataset ACL permissions from the **Datasets** screen, either select the **Set ACL for this dataset** option when prompted after adding the dataset or select the dataset row, and then click **Edit** on the **Permissions** widget to open the **Edit ACL** screen. + To configure the dataset ACL permissions from the Datasets screen, either select the Set ACL for this dataset option when prompted after adding the dataset or select the dataset row and then click Edit on the Permissions widget to open the Edit ACL screen. - When adding the parent dataset, after entering the name, select the **Generic** dataset preset. - Select the option to edit the ACL, set the **owner** and **group** to **admin** or the name of your administration user account and click **Apply Owner** and **Apply Group**. - Next add an ACE entries for the **netdata** and **www-data** users and give them full permissions. - Click **Save Access Control List**. + When adding the parent dataset, select the Generic dataset preset after entering the name. + Select the option to edit the ACL, set the owner and group to admin or the name of your administration user account, and click Apply Owner and Apply Group. + Next, add an ACE entry for the netdata and www-dat users and give them full permissions. + Click Save Access Control List. {{< trueimage src="/images/SCALE/Apps/AddNextcloudParentDatasetNetdataUserACL.png" alt="Add Nextcloud Parent Dataset ACL Permissions" id="Add Nextcloud Parent Dataset ACL Permissions" >}} - When adding the **postgres_data** dataset, enter the dataset name and then click **Advanced Options** to show the advanced dataset settings. - Scroll down to the **ACL Type** and select **POSIX** from the dropdown list, and then click **Save**. - Only the **postgres_data** dataset requires the POSIX ACL type setting. + When adding the postgres_data dataset, enter the dataset name and then click Advanced Options to show the advanced dataset settings. + Scroll down to the ACL Type and select POSIX from the dropdown list, and then click Save. + Only the postgres_data dataset requires the POSIX ACL type setting. {{< trueimage src="/images/SCALE/Apps/SetPostgres_dataACLtoPOSIX.png" alt="Set postgres_data Dataset ACL Type" id="Set postgres_data Dataset ACL Type" >}} - Click **Set ACL for this dataset** to open the **Edit ACL** screen. - Set the **owner** and **group** to **netdata** and click **Apply Owner** and **Apply Group**, and then with that ACL entry highlighted, assign full control permissions before you save the ACL. - Click **Save Access Control List**. + Click Set ACL for this dataset to open the Edit ACL screen. + Set the owner and group to netdata and click Apply Owner and Apply Group, and then with that ACL entry highlighted, assign full control permissions before you save the ACL. + Click Save Access Control List. {{< trueimage src="/images/SCALE/Apps/AddPostgres_DataACLPermissions.png" alt="Add Nextcloud postgres_data Dataset ACL Permissions" id="Add Nextcloud postgres_data Dataset ACL Permissions" >}} - {{< /expand >}} + {{< /expand >}}
+{{< include file="/static/includes/apps/BeforeYouBeginAddAppCertificate.md" >}} -{{< include file="/static/includes/apps/BeforeYouBeginAddNewAppUser.md" >}} +

Adding a certificate is optional but if you want to use a certificate for this application, either create a new self-signed CA and certificate or import an existing CA and create the certificate for Nextcloud. A certificate is not required to deploy the application.

* Set up a Nextcloud account. - If you have an existing Nextcloud account, you enter the credentials for that users in the installation wizard. - If do not have an existing Nextcloud account you can create the account from the application install wizard. + If you have an existing Nextcloud account, you enter the credentials for that user in the installation wizard. + If you do not have an existing Nextcloud account, you can create one using the application install wizard. ### Installing the Nextcloud App {{< hint info >}} @@ -88,7 +94,6 @@ For optional settings, see [Understanding App Installation Wizard Settings](#und {{< /hint >}} {{< include file="/static/includes/apps/MultipleAppInstancesAndNaming.md" >}} - {{< include file="/static/includes/apps/LocateAndOpenInstallWizard.md" >}} {{< trueimage src="/images/SCALE/Apps/InstallNextcloudScreen.png" alt="Install Nextcloud Screen" id="Install Nextcloud Screen" >}} @@ -115,9 +120,9 @@ The **Data Directory Path** is pre-populated with the correct path. {{< trueimage src="/images/SCALE/Apps/InstallNextcloudConfig2.png" alt="Enter Host and Other Config Settings" id="Enter Host and Other Config Settings" >}} Enter a password in **Redis Password** to create a new credential or enter the existing password if you already have Redis configured in your Nextcloud account. -Enter a password in **Database Password** to create a new credential for the Nextcloud database or enter the existing password if you already have the Nextcloud account database configured. +Enter a password in **Database Password** to create a new credential for the Nextcloud database or enter the existing password if you already have the Nextcloud account database configured. Nextcloud does not URL encode in some places so do not use the ampersand (&), at (@), hashtag (#), or percent (%) characters in the Redis password. -Accept the remaining defaults in the **Nextcloud Configuration** section, but if setting up a cron job schedule, select **Enabled** under **Cron** to show the settings to allow you to schedule a cron job. +Accept the remaining defaults in the **Nextcloud Configuration** section. However, if you are setting up a cron job schedule, select **Enabled** under **Cron** to show the settings that allow you to schedule a cron job. {{< expand "Nextcloud Cron Jobs" "v" >}} NextCloud cron jobs only run while the app is running. If you stop the app, the cron job(s) do not run until you start the app again. @@ -127,6 +132,7 @@ For more information on formatting and using cron jobs, see [Managing Cron Jobs] The TrueNAS app is configured with all the required environment variables, but if you want to further customize the container, click **Add** to the right of **Additional Environment Variables** for each to enter the variable(s) and values(s). {{< /expand >}} + Enter the network configuration settings. Enter the default port, **30027**, in **WebUI Port**, or enter an available port number of your choice. See [Network Configuration](#network-configuration) below for more information on changing the default port. @@ -134,7 +140,7 @@ This port must match the one used in **Host** above. If you configured a certificate, select it in **Certificate ID**. A certificate is required if you want to select an external port other than the default **30027**. -Enter the storage settings for each of the datasets created for the Nextcloud app. +Enter the storage settings for each dataset you created for the Nextcloud app. {{< expand "Configuring Nextcloud Storage" "v" >}} {{< hint type=info >}} Do not select **DEPRECATED: Old Storage Structure** if you are deploying Nextcloud for the first time as this slows down the installation and is not necessary. @@ -146,12 +152,12 @@ Select **Enable ACL**, and then either enter or browse to and select the **html* {{< trueimage src="/images/SCALE/Apps/InstallNextcloudStorageAppDataACLandACESettings.png" alt="Add Nextcloud Storage for AppData" id="Add Nextcloud Storage for AppData" >}} -Select **Add** to the right of **ACL Entries**, add the **33** user, and give it **FULL_CONTROL Access**. +Select **Add** to the right of **ACL Entries**, add the **33** user ID, and give it **FULL_CONTROL Access**. Select **Force Flag**. Repeat this step for the **Nextcloud User Data Storage** storage volume. After setting **Type** to **Host Path (Path that already exists on the system)** and selecting **Enable ACL**, enter or browse to and select the **data** dataset. -Select **Add** to the right of **ACL Entries** to add the **33** user, and give it **FULL_CONTROL Access**. Select **Force Flag** +Select **Add** to the right of **ACL Entries** to add the **33** user ID, and give it **FULL_CONTROL Access**. Select **Force Flag** {{< trueimage src="/images/SCALE/Apps/InstallNextcloudStorageDataACLandACESettings.png" alt="Add Nextcloud Storage Volumes" id="Add Nextcloud Storage Volumes" >}} @@ -192,8 +198,8 @@ Nextcloud has three APT package options: You must add both the **ffmpeg** and **smbclient** packages to deploy this app. -You can use **ocrmypdf** as well if needed, but you must also select the **Tesseract Language Code** to use. Options are **chi-sim** for Simplified Chinese or **eng** for English. -For more information on tesseract languages to install for OCRmypdf, see [here](https://tesseract-ocr.github.io/tessdoc/Data-Files-in-different-versions.html) for a list of language codes. Typing a wrong language code blocks the container from starting. Only takes effect if ocrmypdf is selected. +You can also use **ocrmypdf** if needed, but you must select the **Tesseract Language Code** to use. Options are **chi-sim** for Simplified Chinese or **eng** for English. +For more information on tesseract languages to install for OCRmypdf, see [here](https://tesseract-ocr.github.io/tessdoc/Data-Files-in-different-versions.html) for a list of language codes. Typing the wrong language code blocks the container from starting. Only takes effect if ocrmypdf is selected. Click **Add** to the right of **APT Packages** for each option you want or need to add. {{< /expand >}} diff --git a/content/TruenasApps/StableApps/MinIOApp/MinIOClustering.md b/content/TruenasApps/StableApps/MinIOApp/MinIOClustering.md index a9581ab6a8..47bd140043 100644 --- a/content/TruenasApps/StableApps/MinIOApp/MinIOClustering.md +++ b/content/TruenasApps/StableApps/MinIOApp/MinIOClustering.md @@ -5,6 +5,7 @@ weight: 20 aliases: - /scale/scaleuireference/apps/minioclustersscale/ - /scale/scaletutorials/apps/minioclustersscale/minioclustering/ + - /scale/scaletutorials/apps/communityapps/minioapp/minioclustering/ - /scale/scaletutorials/apps/communityapps/minioclustersscale/minioclustering/ - /scale/scaletutorials/apps/chartapps/minioapp/minioclustering/ - /scale/scaletutorials/apps/stableapps/minioapp/minioclustering/ diff --git a/content/TruenasApps/StableApps/PlexApp.md b/content/TruenasApps/StableApps/PlexApp.md index 963158545b..7a6c0a66bf 100644 --- a/content/TruenasApps/StableApps/PlexApp.md +++ b/content/TruenasApps/StableApps/PlexApp.md @@ -25,21 +25,21 @@ Before you install the Plex app: After installing the Plex app and logging into Plex through the **Web Portal** button in TrueNAS, if you have not already configured your Plex account media server, Plex shows the configuration screens to set up the media server, add libraries, and customize your Plex account. {{< include file="/static/includes/apps/BeforeYouBeginStableApps.md" >}} +{{< include file="/static/includes/apps/BeforeYouBeginRunAsUser.md" >}} -* Go to **Datasets**, and select the pool or dataset where you want to add the Plex datasets. - For example, */tank/apps/plex* or */tank/plex*. - You can use either an existing pool or [create a new one]({{< relref "CreatePoolWizard.md" >}}) +
{{< trueimage src="/images/SCALE/Apps/PlexDetailsScreen.png" alt="Plex App Details Screen" id="Plex App Details Screen" >}}
- Create the two datasets Plex uses for storage volumes: - * **data** to use as the Plex data directory for database and metadata storage - * **config** for Plex application configuration storage. +{{< include file="/static/includes/apps/BeforeYouBeginAddAppDatasets.md" >}} - You can create a dataset or use a temporary directory option for log data. - Transcode data is not useful or meant for persistent storage, so using a temporary directory is a better option. +
Plex uses for storage volumes: data to use as the Plex data directory for database and metadata storage, and config for Plex application configuration storage. - When creating the above datasets, select the **apps** dataset preset. + You can create a dataset or use a temporary directory option for log data. + Transcode data is not useful or meant for persistent storage, so using a temporary directory is a better option.

+ + {{< include file="/static/includes/apps/BeforeYouBeginAddAppDatasetsProcedure.md" >}} - You can set up the permissions (ACLs) for these datasets after adding them using the **Edit ACL** screen, or wait and use the **Install Plex** wizard ACL settings to add permissions. You can also edit permissions after using either method. + You can set up the permissions (ACLs) for these datasets after adding them using the Edit ACL screen, or wait and use the Install Plex wizard ACL settings to add permissions. + You can also edit permissions after using either method.
### Installing the Plex App {{< hint info >}} @@ -67,28 +67,22 @@ While logged into your Plex account, go to the [Plex **Claim Code** web page](ht Next, either accept the default values shown or enter the IP addresses for local network connections (Ethernet or WiFi routers) you want in your Plex network. See [Setting Up Local Network](#setting-up-local-network) below for more information. -You can add devices and/or additional environment variables, but these are not necessary to deploy the app. -For more information on adding these, see [Adding Devices](#adding-devicess) below. +You can add devices and additional environment variables, but this is not required to deploy the app. +For more information, see [Adding Devices](#adding-devicess) below. -Accept the default values in both **User and Group Configuration** and **Network Configurations**. +Accept the default values in **User and Group Configuration** and **Network Configurations**. (Optional) If you created a new user to administer apps, enter that user ID in the user and group fields. See [User and Group Configuration](#user-and-group-configuration) and [Network Configuration](#network-configuration) for more details. Add your **Storage Configuration** settings. {{< expand "Configuring Plex Storage" "v" >}} -Set **Host Path (Path that already exists on the system)** in **Type** for **Plex Data Storage**. -Select **Enable ACL**, and then either enter or browse to and select the **data** dataset to populate the **Host Path** field. - -{{< trueimage src="/images/SCALE/Apps/InstallPlexStorageConfigDataACLandACE.png" alt="Add Plex Data Storage" id="Add Plex Data Storage" >}} - Select **Add** to the right of **ACL Entries** for each user or group entry you want to add. -For example, add the **568** user and **0**, and give each **FULL_CONTROL Access**. +For example, add the **568** user and **0**, and set the permission level to **FULL_CONTROL Access**. Select **Force Flag**. -Repeat the storage steps above for the **Plex Configuration** and, when using a dataset for logs, for the **Plex Logs** storage volumes. -Create a dataset for log storage to save and easily access log data. -If not, set the storage volume type to either **temporary** or **tmpfs** for both **Logs** and **Transcode** storage. +Repeat the steps above for the **Plex Configuration**. +Repeat the same steps when creating and using a dataset for the **Plex Logs** storage volumes, but if not, set the storage volume type to either **temporary** or **tmpfs** for both **Logs** and **Transcode** storage volumes. {{< /expand >}} Add any labels you want to use to organize your media files. @@ -129,23 +123,23 @@ Accept the default value in **Image** to use the container image for the TrueNAS TrueNAS shows the default IP addresses detected for your system. If these address fields are not shown in the wizard, your network is considered to be on the external network. -Either accept the default values or enter the IP addresses for local network connections (Ethernet or WiFi routers) you want in your Plex local network. +Accept the default values or enter IP addresses for local network connections (Ethernet or WiFi routers) you want to add to your Plex local network. These addresses define how Plex interacts with devices and services on your network and can optimize how your Plex media server communicates with devices in your home. -Specified addresses are considered to be on the local network when enforcing bandwidth restrictions. +Specified addresses are considered on the local network when enforcing bandwidth restrictions. If left blank, only the subnet for the server is considered to be on your local network. When the host network is not enabled, the server subnet is the network for Docker. Therefore, all connections from other clients are considered to be on the external network. If set, all other IP addresses are considered to be external to your local network. #### Adding Devices in the Container -Plex account settings allow you to add and manage devices, such as a USB TV Tunner or other similar hardware, that connect to your media server, both on the local network you define and remotely from external network connections. +Plex account settings allow you to add and manage devices, such as a USB TV tuner or similar hardware, that connect to your media server, both on the local network you define and remotely from external network connections. Adding devices in the TrueNAS Plex app passes devices through to your Plex account. Click **Add** to the right of **Devices** in the **Install Plex** wizard for each device to add. {{< trueimage src="/images/SCALE/Apps/InstallPlexConfigAddDevice.png" alt="Install Plex Add Device" id="Install Plex Add Device" >}} -Enter the name of the device in the **Host Device** and in the **Container Device** fields. For example, device */dev/dvb*. +Enter the device name in **Host Device** and **Container Device**. For example, device */dev/dvb*. #### Adding Environment Variables {{< include file="/static/includes/apps/AppInstallWizardEnvironVariablesSettings.md" >}} @@ -158,10 +152,6 @@ Refer to Plex documentation for more information on [environment variables](http {{< include file="/static/includes/apps/AppInstallWizardUserAndGroupConfig.md" >}} -The run-as user information is found on the Plex app details screen in the **Run-As Content** widget. - -{{< trueimage src="/images/SCALE/Apps/PlexDetailsScreen.png" alt="Plex App Details Screen" id="Plex App Details Screen" >}} - ### Network Configuration The default web port for Plex is **32400**. @@ -171,60 +161,44 @@ The default web port for Plex is **32400**. ### Storage Configuration TrueNAS provides options for data and configuration storage volumes: ixVolumes and host paths. -Logs and transcode data can use these same storage options or you can create directories to hold log and/or transcode data. +Logs and transcode data can use these storage options or you can create directories to hold log and transcode data. Both logs and transcode data are not intended for persistent data storage. -Logs and transcode data can be stored in the **temporary** directory option that creates a Docker volume in the hidden **ix-apps** dataset. +Logs and transcode data can use the **temporary** directory option that creates a Docker volume in the hidden **ix-apps** dataset. Transcode data chunks are streamed to a player and meant to be discarded after use, like notes on a scratchpad. -This makes the **tmpfs** directory option a better choice as it creates a Linux temporary filesystem type in RAM. +This makes the **tmpfs** directory option a better choice for this transcode data as it creates a Linux temporary filesystem type in RAM. Neither directory storage option provides easy access to stored data, so if you want to store and access log data, create a dataset called **logs**. -If opting to use datasets for all Plex storage volumes, create datasets to use with the host path option: +Plex required host path storage volumes: * **data** to use as the Plex data directory for database and metadata storage. * **config** to use as the Plex app configuration storage volume. -* **logs** if you want to save and have easy access to log data. +* **logs** optional if you want to save and have easy access to log data. -If you group these datasets under a parent dataset named *plex*, configure the [ACL permissions]({{< relref "PermissionsSCALE.md" >}}) for this parent dataset and add an ACE entry for the run-as (root or **0**) or assigned user (**568**). +If organizing datasets under a parent dataset named *plex*, configure the [ACL permissions]({{< relref "PermissionsSCALE.md" >}}) for this parent dataset and add an ACE entry for the run-as (root or **0**) or assigned user (**568**). -You can create the ACL permission using the app installation wizard or using the **Add Dataset** and **Edit ACL** screens. +See [Before You Begin](#before-you-begin) for more information on creating app datasets. {{< include file="/static/includes/apps/InstallAppsStorageConfig.md" >}} {{< include file="/static/includes/apps/AppInstallWizardTemporaryAndTmpfsDirectories.md" >}} -You can also create additional storage volumes inside the containers. -Additional storage options include the same options and the option to set up an SMB share inside the container. -See **Mounting an SMB Share** below for details. - -{{< expand "Creating App Datasets" "v" >}} -To create the Plex app datasets, go to **Datasets**, select the dataset you want to use as the parent dataset, then click **Add Dataset** to [add a dataset]({{< relref "DatasetsScale.md" >}}). -In this example, we create the Plex datasets under the parent dataset **plex**. +#### Setting Dataset ACL Permissions +You can configure ACL permissions for the required dataset in the **Install Plex** wizard, or from the **Datasets** screen any time after adding the datasets. -Enter **plex** in **Name**, and select **Apps** as the **Dataset Preset**. -Click **Advanced Options** if you want to make any other setting changes. Click **Save**. -When prompted, select **Return to Pool List** to configure permissions later after adding the other three datasets, or open the ACL editor to edit ACL permissions immediately after adding the dataset. - -Next, select the **plex** dataset, and then click **Add Dataset** to add the first child dataset. -Enter **data** in **Name** and select **Apps** as the **Dataset Preset**. -Click **Advanced Options** if you want to make any other setting changes. Click **Save**. - -Repeat this to add the **config** dataset, and if desired, also create datasets for **logs** if you want to have easy access to and recovery of log files. -Use the option to add a temporary directory on disk or in RAM for transcode data (and logs if not creating a dataset) storage rather than adding datasets. -When finished you should have the **plex** parent dataset with the child datasets under it. Our example paths are: -* */mnt/tank/plex/***data** -* */mnt/tank/plex/***config** -* */mnt/tank/plex/***logs** +{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}} -{{< trueimage src="/images/SCALE/Apps/AddPlexAppDatasets.png" alt="Add Plex Dataset Storage" id="Add Plex Dataset Storage" >}} +{{< expand "Adding ACL Permissions from the Datasets Screen" "v">}} +First, select the dataset row, scroll down to the **Permissions** widget, and then click **Edit** to open the **Edit ACL** screen. +Change the **@owner** and **@group** values from **root** to the administrative user for your TrueNAS system, and click apply for each. +Next, add an ACL entry for the run-as user. +For Plex, the run-as users are **0** for **root** and **568**. Add a user entry for these users. +Save the ACL before leaving the screen. +See [Setting Up Permissions]({{< relref "PermissionsSCALE.md" >}}) and [Edit ACL Screen]({{< relref "EditACLScreens.md" >}}) for more information. {{< /expand >}} -#### ACL and ACE Settings - -{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}} - -#### Mounting an SMB Share +#### Mounting an SMB Share Storage Volume TrueNAS **Additional Storage** options include the ability to mount an SMB share inside the container pod. {{< include file="/static/includes/apps/InstallWizardStorageSMBOption.md" >}} @@ -237,7 +211,7 @@ TrueNAS **Additional Storage** options include the ability to mount an SMB share {{< include file="/static/includes/apps/InstallWizardGPUPassthrough.md" >}} ## Troubleshooting Tips -Before editing Plex app settings, first stop the app, and then edit settings. After saving changes, restart the app. +Before editing Plex app settings, stop the app, and then edit settings. After saving changes, restart the app. Refer to the Plex support website and documentation for assistance with your Plex media server issues. @@ -254,9 +228,11 @@ Search the [TrueNAS forum](https://forums.truenas.com/) for Plex discussion thre ### Cannot Access Libraries or Media Files Check the dataset permissions, and verify the user accessing these files has the correct permissions. -You can edit dataset permissions by using the **Edit** button on the **Permissions** widget on the **Datasets** screen. +You can edit dataset permissions using the **Edit** button on the **Permissions** widget on the **Datasets** screen. Select the dataset, scroll down to the **Permissions** widget, and click **Edit** to open the **Edit ACL** screen. -Check the ACL entries list for the user accessing the files. If not present, click **Add ACL Entry**, select **User**, and then locate the user name on the **User** dropdown list. Assign the level of permissions you want to assign, then save the ACL changes. +Check the ACL entries list for the user accessing the files. +If not present, click **Add ACL Entry**, select **User**, and locate the user name on the **User** dropdown list. +Assign the level of permissions you want to assign, then save the ACL changes. You can also add the user in the Plex app settings. Click on the Plex app row on the **Installed** application table. Stop the app, then click **Edit**. diff --git a/content/_archive/COREReleaseNotes/12.0/12.0RC1.md b/content/_archive/COREReleaseNotes/12.0/12.0RC1.md index 8c8778d202..869bc230cc 100644 --- a/content/_archive/COREReleaseNotes/12.0/12.0RC1.md +++ b/content/_archive/COREReleaseNotes/12.0/12.0RC1.md @@ -30,7 +30,7 @@ Additionally, version 12 includes these notable changes and improvements:
  • TrueCommand Cloud Integration - TrueNAS 12.0 systems can be connected directly to a TrueCommand Cloud account for scaled monitoring and management of your TrueNAS systems - no additional hardware needed! For Early Access to TrueCommand Cloud, go to portal.ixsystems.com and create an iX account, then send an email to truecommand-sales@ixsystems.com to request Early Access to the TrueCommand Cloud Services. Be sure to include the email address that you used to create your iX Account.
  • -The Docs Hub has step-by-step instructions for [configuring TrueCommand Cloud]({{< relref "/TrueCommand/TCGettingStarted/Install/_index.md" >}}). +The Docs Hub has step-by-step instructions for configuring TrueCommand Cloud. These major changes are also paired with numerous other bug fixes and quality-of-life type improvements to the UI and APIs for users. We’ve also revamped our [Documentation](https://www.truenas.com/docs/), focusing more content on how to accomplish specific tasks, reducing the learning curve and time normally spent on deploying TrueNAS in a variety of storage environments. diff --git a/content/_archive/COREReleaseNotes/12.0/12.0Release.md b/content/_archive/COREReleaseNotes/12.0/12.0Release.md index b444cdec15..bb77ad714c 100644 --- a/content/_archive/COREReleaseNotes/12.0/12.0Release.md +++ b/content/_archive/COREReleaseNotes/12.0/12.0Release.md @@ -34,7 +34,7 @@ Additionally, version 12 includes these notable changes and improvements:
  • TrueCommand Cloud Integration - TrueNAS 12.0 systems can be connected directly to a TrueCommand Cloud account for scaled monitoring and management of your TrueNAS systems - no additional hardware needed! For Early Access to TrueCommand Cloud, go to portal.ixsystems.com and create an iX account, then send an email to truecommand-sales@ixsystems.com to request Early Access to the TrueCommand Cloud Services. Be sure to include the email address that you used to create your iX Account.
  • -The Docs Hub has step-by-step instructions for [configuring TrueCommand Cloud]({{< relref "/TrueCommand/TCGettingStarted/Install/_index.md" >}}). +The Docs Hub has step-by-step instructions for configuring TrueCommand Cloud. These major changes are also paired with numerous other bug fixes and quality-of-life type improvements to the UI and APIs for users. We’ve also revamped our [Documentation](https://www.truenas.com/docs/), focusing more content on how to accomplish specific tasks, reducing the learning curve and time normally spent on deploying TrueNAS in a variety of storage environments. diff --git a/content/_archive/COREReleaseNotes/12.0/12.0U5.md b/content/_archive/COREReleaseNotes/12.0/12.0U5.md index 4c9079935c..03feb68a75 100644 --- a/content/_archive/COREReleaseNotes/12.0/12.0U5.md +++ b/content/_archive/COREReleaseNotes/12.0/12.0U5.md @@ -23,7 +23,7 @@ TrueNAS 12.0-U5 was released on August 3, 2021. A [full list of changes and bug TrueNAS 12.0-U5 is compatible with all of the iXsystems platforms from the FreeNAS/TrueNAS Minis, to the power-efficient [X-Series](https://www.truenas.com/x-series/), all the way up to the flagship High Availability (HA) [M-Series](https://www.truenas.com/m-series/). There is also a new [R-Series](https://www.truenas.com/r-series/) product line that can run CORE, Enterprise, and SCALE editions of TrueNAS. All of these can be updated via the web UI and include graphical enclosure management. -For those with FreeNAS installed on your system, we recommend [upgrading]({{< relref "/CORE/UIReference/System/Update.md" >}}) to [FreeNAS 11.3-U5](https://www.freenas.org/download-freenas-release/) first and then upgrading to TrueNAS 12.0-U5 with a single click to retain roll-back options. While it is an easy web update, we do recommend waiting to update your system zpool feature flags until you are finished validating your performance and functionality. +For those with FreeNAS installed on your system, we recommend upgrading to [FreeNAS 11.3-U5](https://www.freenas.org/download-freenas-release/) first and then upgrading to TrueNAS 12.0-U5 with a single click to retain roll-back options. While it is an easy web update, we do recommend waiting to update your system zpool feature flags until you are finished validating your performance and functionality. For those with TrueNAS HA systems and support contracts, we recommend contacting iXsystems support to schedule an upgrade. We will verify your system health, configuration, and support the upgrade process as part of the "white glove" service that comes with any support contract. diff --git a/content/_archive/COREReleaseNotes/12.0/12.0U6.md b/content/_archive/COREReleaseNotes/12.0/12.0U6.md index 26ededf0c5..ab2242cf3d 100644 --- a/content/_archive/COREReleaseNotes/12.0/12.0U6.md +++ b/content/_archive/COREReleaseNotes/12.0/12.0U6.md @@ -26,7 +26,7 @@ TrueNAS 12.0-U5 and U5.1 were the most popular releases of TrueNAS ever. Over 75 In addition to improving TrueNAS 12.0 software, we’re also actively partnering with companies that deliver some significant value-add to TrueNAS users. [Futurex](https://www.futurex.com/) is announcing today that they have integrated their KMIP management servers with the KMIP capability in TrueNAS 12.0 Enterprise. Later this month, there will be a joint announcement with [Nextcloud](https://nextcloud.com/) about collaboration between the TrueNAS and Nextcloud platforms. -For those with FreeNAS installed on your system, we recommend [updating]({{< relref "/CORE/CORETutorials/UpdatingTrueNAS/_index.md" >}}) or [upgrading]({{< relref "/CORE/CORETutorials/UpdatingTrueNAS/_index.md" >}}) to [FreeNAS 11.3-U5](https://download.freenas.org/) first and then upgrading to TrueNAS 12.0-U8 with a single click to retain roll-back options. While it is an easy web update, we do recommend waiting to update your system’s zpool feature flags until you are finished validating your performance and functionality. +For those with FreeNAS installed on your system, we recommend updating or upgrading to [FreeNAS 11.3-U5](https://download.freenas.org/) first and then upgrading to TrueNAS 12.0-U8 with a single click to retain roll-back options. While it is an easy web update, we do recommend waiting to update your system’s zpool feature flags until you are finished validating your performance and functionality. For those with TrueNAS HA systems and support contracts, we recommend contacting iXsystems Support to schedule an upgrade. We will verify your system health, configuration, and support the upgrade process as part of the "white glove" service that comes with any support contract. diff --git a/content/_archive/COREReleaseNotes/12.0/12.0U7.md b/content/_archive/COREReleaseNotes/12.0/12.0U7.md index adac058e65..3a72010cd1 100644 --- a/content/_archive/COREReleaseNotes/12.0/12.0U7.md +++ b/content/_archive/COREReleaseNotes/12.0/12.0U7.md @@ -17,7 +17,7 @@ TrueNAS 12.0-U7 has been released, and includes a number of fixes, nearly a doze * Dashboard fixes for CPU temp reporting * Various M-Series and R-Series webUI improvements -For those with FreeNAS installed on your system, we recommend [updating]({{< relref "/CORE/CORETutorials/UpdatingTrueNAS/_index.md" >}}) or [upgrading]({{< relref "/CORE/CORETutorials/UpdatingTrueNAS/_index.md" >}}) to [FreeNAS 11.3-U5](https://download.freenas.org/) first and then upgrading to TrueNAS 12.0-U8 with a single click to retain roll-back options. While it is an easy web update, we do recommend waiting to update your system’s zpool feature flags until you are finished validating your performance and functionality. +For those with FreeNAS installed on your system, we recommend updating or upgrading to [FreeNAS 11.3-U5](https://download.freenas.org/) first and then upgrading to TrueNAS 12.0-U8 with a single click to retain roll-back options. While it is an easy web update, we do recommend waiting to update your system’s zpool feature flags until you are finished validating your performance and functionality. For those with TrueNAS HA systems and support contracts, we recommend contacting iXsystems Support to schedule an upgrade. We will verify your system health, configuration, and support the upgrade process as part of the "white glove" service that comes with any support contract. diff --git a/content/_archive/COREReleaseNotes/12.0/12.0U8.1.md b/content/_archive/COREReleaseNotes/12.0/12.0U8.1.md index 1828bda800..ca1dc205bc 100644 --- a/content/_archive/COREReleaseNotes/12.0/12.0U8.1.md +++ b/content/_archive/COREReleaseNotes/12.0/12.0U8.1.md @@ -11,7 +11,7 @@ aliases: iXsystems is pleased to announce the general availability of TrueNAS 12.0-U8.1! -For those with FreeNAS installed on your system, we recommend [updating]({{< relref "/CORE/CORETutorials/UpdatingTrueNAS/_index.md" >}}) or [upgrading]({{< relref "/CORE/CORETutorials/UpdatingTrueNAS/_index.md" >}}) to [FreeNAS 11.3-U5](https://download.freenas.org/) first and then upgrading to TrueNAS 12.0-U8 with a single click to retain roll-back options. While it is an easy web update, we do recommend waiting to update your system’s zpool feature flags until you are finished validating your performance and functionality. +For those with FreeNAS installed on your system, we recommend updating or upgrading to [FreeNAS 11.3-U5](https://download.freenas.org/) first and then upgrading to TrueNAS 12.0-U8 with a single click to retain roll-back options. While it is an easy web update, we do recommend waiting to update your system’s zpool feature flags until you are finished validating your performance and functionality. For those with TrueNAS HA systems and support contracts, we recommend contacting iXsystems Support to schedule an upgrade. We will verify your system health, configuration, and support the upgrade process as part of the "white glove" service that comes with any support contract. diff --git a/content/_archive/COREReleaseNotes/12.0/12.0U8.md b/content/_archive/COREReleaseNotes/12.0/12.0U8.md index 554d962373..bc94072fad 100644 --- a/content/_archive/COREReleaseNotes/12.0/12.0U8.md +++ b/content/_archive/COREReleaseNotes/12.0/12.0U8.md @@ -15,7 +15,7 @@ TrueNAS 12.0-U8 has been released, and includes a number of fixes, improvements, * New "Console Port" and "TLS Server URI" input fileds in S3 service configuration form. * Direct link to TrueNAS Upgrades article from Update screen. -For those with FreeNAS installed on your system, we recommend [updating]({{< relref "/CORE/CORETutorials/UpdatingTrueNAS/_index.md" >}}) or [upgrading]({{< relref "/CORE/CORETutorials/UpdatingTrueNAS/_index.md" >}}) to [FreeNAS 11.3-U5](https://download.freenas.org/) first and then upgrading to TrueNAS 12.0-U8 with a single click to retain roll-back options. While it is an easy web update, we do recommend waiting to update your system’s zpool feature flags until you are finished validating your performance and functionality. +For those with FreeNAS installed on your system, we recommend updating or upgrading to [FreeNAS 11.3-U5](https://download.freenas.org/) first and then upgrading to TrueNAS 12.0-U8 with a single click to retain roll-back options. While it is an easy web update, we do recommend waiting to update your system’s zpool feature flags until you are finished validating your performance and functionality. For those with TrueNAS HA systems and support contracts, we recommend contacting iXsystems Support to schedule an upgrade. We will verify your system health, configuration, and support the upgrade process as part of the "white glove" service that comes with any support contract. diff --git a/data/properties/scale-downloads.yaml b/data/properties/scale-downloads.yaml index 80b000064d..3ef30b9e7b 100644 --- a/data/properties/scale-downloads.yaml +++ b/data/properties/scale-downloads.yaml @@ -1,8 +1,8 @@ --- -id: "scale-downloads" -img: "/images/truenas_scale-logo-full-color-rgb.png" +id: "truenas-downloads" +img: "/images/tn-openstorage-logo.png" product: "TrueNAS" -title: "SCALE™ | Enterprise™" +title: "TrueNAS® | Enterprise™" majorVersions: - lifecycle: "Archive" majorVersions: diff --git a/data/properties/scale-releases.yaml b/data/properties/scale-releases.yaml index 525bd1eef1..cc49deef2f 100644 --- a/data/properties/scale-releases.yaml +++ b/data/properties/scale-releases.yaml @@ -1,8 +1,8 @@ --- id: "scale-schedule" -img: "/images/truenas_scale-logo-full-color-rgb.png" +img: "/images/tn-openstorage-logo.png" product: "TrueNAS" -title: "TrueNAS™ | Enterprise™" +title: "TrueNAS® | Enterprise™" majorVersions: - lifecycle: "Previous" name: "TrueNAS 24.04 - Dragonfish" diff --git a/static/custom.css b/static/custom.css index 6d50b86ea3..9d39fcc911 100644 --- a/static/custom.css +++ b/static/custom.css @@ -2031,10 +2031,12 @@ pre.gdoc-mermaid.mermaid.mermaid_sizing { } :root[color-theme='dark'] { --enterprise-title: rgb(52, 58, 64); /* Define --enterprise-title for the dark theme */ + --body-font-color: #f0f3f5; } @media (prefers-color-scheme: dark) { :root { --enterprise-title: rgb(52, 58, 64); /* Define --enterprise-title for devices preferring dark mode */ + --body-font-color: #f0f3f5; } } @media (prefers-color-scheme: light) { diff --git a/static/images/Hardware/ExpansionShelves/ES102BSG.png b/static/images/Hardware/ExpansionShelves/ES102BSG.png index c215b3b155..af014f0a3e 100644 Binary files a/static/images/Hardware/ExpansionShelves/ES102BSG.png and b/static/images/Hardware/ExpansionShelves/ES102BSG.png differ diff --git a/static/images/Hardware/ExpansionShelves/ES102Gen2PUM.png b/static/images/Hardware/ExpansionShelves/ES102Gen2PUM.png index cc3e8bc5ce..7dd3ca94eb 100644 Binary files a/static/images/Hardware/ExpansionShelves/ES102Gen2PUM.png and b/static/images/Hardware/ExpansionShelves/ES102Gen2PUM.png differ diff --git a/static/images/Hardware/ExpansionShelves/ES102Gen2Stencil.png b/static/images/Hardware/ExpansionShelves/ES102Gen2Stencil.png index 31bd75ed2e..3ca9e16c1a 100644 Binary files a/static/images/Hardware/ExpansionShelves/ES102Gen2Stencil.png and b/static/images/Hardware/ExpansionShelves/ES102Gen2Stencil.png differ diff --git a/static/images/Hardware/ExpansionShelves/ES12BSG.png b/static/images/Hardware/ExpansionShelves/ES12BSG.png index ff56879bff..df558588c4 100644 Binary files a/static/images/Hardware/ExpansionShelves/ES12BSG.png and b/static/images/Hardware/ExpansionShelves/ES12BSG.png differ diff --git a/static/images/Hardware/ExpansionShelves/ES24BSG.png b/static/images/Hardware/ExpansionShelves/ES24BSG.png index 990f946427..d3998b95a5 100644 Binary files a/static/images/Hardware/ExpansionShelves/ES24BSG.png and b/static/images/Hardware/ExpansionShelves/ES24BSG.png differ diff --git a/static/images/Hardware/ExpansionShelves/ES24FBSG.png b/static/images/Hardware/ExpansionShelves/ES24FBSG.png index 3147cacab6..bdaa877e68 100644 Binary files a/static/images/Hardware/ExpansionShelves/ES24FBSG.png and b/static/images/Hardware/ExpansionShelves/ES24FBSG.png differ diff --git a/static/images/Hardware/ExpansionShelves/ES24NConnection.png b/static/images/Hardware/ExpansionShelves/ES24NConnection.png index 308b36ea92..36d358c461 100644 Binary files a/static/images/Hardware/ExpansionShelves/ES24NConnection.png and b/static/images/Hardware/ExpansionShelves/ES24NConnection.png differ diff --git a/static/images/Hardware/ExpansionShelves/ES24NPUM.png b/static/images/Hardware/ExpansionShelves/ES24NPUM.png index 820dd7a7d9..f2f6e24b58 100644 Binary files a/static/images/Hardware/ExpansionShelves/ES24NPUM.png and b/static/images/Hardware/ExpansionShelves/ES24NPUM.png differ diff --git a/static/images/Hardware/ExpansionShelves/ES24NStencil.png b/static/images/Hardware/ExpansionShelves/ES24NStencil.png index d80bdf29c6..ef3c9025c8 100644 Binary files a/static/images/Hardware/ExpansionShelves/ES24NStencil.png and b/static/images/Hardware/ExpansionShelves/ES24NStencil.png differ diff --git a/static/images/Hardware/ExpansionShelves/ExpansionShelves.png b/static/images/Hardware/ExpansionShelves/ExpansionShelves.png index f6771e505b..09db841a15 100644 Binary files a/static/images/Hardware/ExpansionShelves/ExpansionShelves.png and b/static/images/Hardware/ExpansionShelves/ExpansionShelves.png differ diff --git a/static/images/Hardware/ExpansionShelves/ExpansionShelvesFront.png b/static/images/Hardware/ExpansionShelves/ExpansionShelvesFront.png index 4d679fca07..515a5fb05e 100644 Binary files a/static/images/Hardware/ExpansionShelves/ExpansionShelvesFront.png and b/static/images/Hardware/ExpansionShelves/ExpansionShelvesFront.png differ diff --git a/static/images/Hardware/ExpansionShelves/ExpansionStencil.png b/static/images/Hardware/ExpansionShelves/ExpansionStencil.png index 20a7b4d98b..37f511cbd5 100644 Binary files a/static/images/Hardware/ExpansionShelves/ExpansionStencil.png and b/static/images/Hardware/ExpansionShelves/ExpansionStencil.png differ diff --git a/static/images/Hardware/ExpansionShelves/SASConnections.png b/static/images/Hardware/ExpansionShelves/SASConnections.png index d24e316a76..c5f2b4cd90 100644 Binary files a/static/images/Hardware/ExpansionShelves/SASConnections.png and b/static/images/Hardware/ExpansionShelves/SASConnections.png differ diff --git a/static/images/Hardware/FSeries/F-Series.png b/static/images/Hardware/FSeries/F-Series.png index e2878addd7..a6aafc943a 100644 Binary files a/static/images/Hardware/FSeries/F-Series.png and b/static/images/Hardware/FSeries/F-Series.png differ diff --git a/static/images/Hardware/FSeries/F-SeriesFrontBez2.png b/static/images/Hardware/FSeries/F-SeriesFrontBez2.png index 93cd831219..0c0df26acc 100644 Binary files a/static/images/Hardware/FSeries/F-SeriesFrontBez2.png and b/static/images/Hardware/FSeries/F-SeriesFrontBez2.png differ diff --git a/static/images/Hardware/FullStencilPack.png b/static/images/Hardware/FullStencilPack.png index 17126df9bd..eced15b52f 100644 Binary files a/static/images/Hardware/FullStencilPack.png and b/static/images/Hardware/FullStencilPack.png differ diff --git a/static/images/Hardware/HSeries/H-Series.png b/static/images/Hardware/HSeries/H-Series.png index f2ce4b9382..46927f7619 100644 Binary files a/static/images/Hardware/HSeries/H-Series.png and b/static/images/Hardware/HSeries/H-Series.png differ diff --git a/static/images/Hardware/HSeries/HSeriesFront.png b/static/images/Hardware/HSeries/HSeriesFront.png index 028dc7257e..b0b160374b 100644 Binary files a/static/images/Hardware/HSeries/HSeriesFront.png and b/static/images/Hardware/HSeries/HSeriesFront.png differ diff --git a/static/images/Hardware/HSeries/HSeriesHANetworking.png b/static/images/Hardware/HSeries/HSeriesHANetworking.png index 1fd4586704..d3291b9d63 100644 Binary files a/static/images/Hardware/HSeries/HSeriesHANetworking.png and b/static/images/Hardware/HSeries/HSeriesHANetworking.png differ diff --git a/static/images/Hardware/HSeries/HSeriesPUM.png b/static/images/Hardware/HSeries/HSeriesPUM.png index 89e96dea20..47a9533366 100644 Binary files a/static/images/Hardware/HSeries/HSeriesPUM.png and b/static/images/Hardware/HSeries/HSeriesPUM.png differ diff --git a/static/images/Hardware/HSeries/HSeriesSOV.png b/static/images/Hardware/HSeries/HSeriesSOV.png index 41cc30b857..b29f22c700 100644 Binary files a/static/images/Hardware/HSeries/HSeriesSOV.png and b/static/images/Hardware/HSeries/HSeriesSOV.png differ diff --git a/static/images/Hardware/HSeries/HSeriesStencil.png b/static/images/Hardware/HSeries/HSeriesStencil.png index e695349009..8c3f1fa751 100644 Binary files a/static/images/Hardware/HSeries/HSeriesStencil.png and b/static/images/Hardware/HSeries/HSeriesStencil.png differ diff --git a/static/images/Hardware/Legacy/Legacy.png b/static/images/Hardware/Legacy/Legacy.png index eca96b52c8..9268c98658 100644 Binary files a/static/images/Hardware/Legacy/Legacy.png and b/static/images/Hardware/Legacy/Legacy.png differ diff --git a/static/images/Hardware/Lock.png b/static/images/Hardware/Lock.png index ac3e8e1f0a..5ba56b9338 100644 Binary files a/static/images/Hardware/Lock.png and b/static/images/Hardware/Lock.png differ diff --git a/static/images/Hardware/MSeries/M-Series.png b/static/images/Hardware/MSeries/M-Series.png index 3fceda0450..a5ef75b180 100644 Binary files a/static/images/Hardware/MSeries/M-Series.png and b/static/images/Hardware/MSeries/M-Series.png differ diff --git a/static/images/Hardware/MSeries/MSeriesFront.png b/static/images/Hardware/MSeries/MSeriesFront.png index 65d814a6f5..ee01e996ad 100644 Binary files a/static/images/Hardware/MSeries/MSeriesFront.png and b/static/images/Hardware/MSeries/MSeriesFront.png differ diff --git a/static/images/Hardware/MSeries/MSeriesHANetworking1.png b/static/images/Hardware/MSeries/MSeriesHANetworking1.png index ccf93be8a8..cd4fe4debd 100644 Binary files a/static/images/Hardware/MSeries/MSeriesHANetworking1.png and b/static/images/Hardware/MSeries/MSeriesHANetworking1.png differ diff --git a/static/images/Hardware/MSeries/MSeriesOOBM.png b/static/images/Hardware/MSeries/MSeriesOOBM.png index 6e984d3dc9..518c604d6e 100644 Binary files a/static/images/Hardware/MSeries/MSeriesOOBM.png and b/static/images/Hardware/MSeries/MSeriesOOBM.png differ diff --git a/static/images/Hardware/MSeries/MSeriesPUM.png b/static/images/Hardware/MSeries/MSeriesPUM.png index fd0cb91271..e114f5369f 100644 Binary files a/static/images/Hardware/MSeries/MSeriesPUM.png and b/static/images/Hardware/MSeries/MSeriesPUM.png differ diff --git a/static/images/Hardware/MSeries/MSeriesSOV.png b/static/images/Hardware/MSeries/MSeriesSOV.png index 8029c62198..1873e6510c 100644 Binary files a/static/images/Hardware/MSeries/MSeriesSOV.png and b/static/images/Hardware/MSeries/MSeriesSOV.png differ diff --git a/static/images/Hardware/MSeries/MSeriesStencil.png b/static/images/Hardware/MSeries/MSeriesStencil.png index 479452293f..17fd9b8f90 100644 Binary files a/static/images/Hardware/MSeries/MSeriesStencil.png and b/static/images/Hardware/MSeries/MSeriesStencil.png differ diff --git a/static/images/Hardware/MSeries/NVDIMMUpdates.png b/static/images/Hardware/MSeries/NVDIMMUpdates.png index 2c94b3c56d..5f3f7312ba 100644 Binary files a/static/images/Hardware/MSeries/NVDIMMUpdates.png and b/static/images/Hardware/MSeries/NVDIMMUpdates.png differ diff --git a/static/images/Hardware/Minis/MiniFamilySoV.png b/static/images/Hardware/Minis/MiniFamilySoV.png index 3f667b25ce..0cc49baba1 100644 Binary files a/static/images/Hardware/Minis/MiniFamilySoV.png and b/static/images/Hardware/Minis/MiniFamilySoV.png differ diff --git a/static/images/Hardware/Minis/MiniFront.png b/static/images/Hardware/Minis/MiniFront.png index 66c3c336f1..8d1e5e4af9 100644 Binary files a/static/images/Hardware/Minis/MiniFront.png and b/static/images/Hardware/Minis/MiniFront.png differ diff --git a/static/images/Hardware/Minis/MiniRBSG.png b/static/images/Hardware/Minis/MiniRBSG.png index 41c080f836..206ea2ebbc 100644 Binary files a/static/images/Hardware/Minis/MiniRBSG.png and b/static/images/Hardware/Minis/MiniRBSG.png differ diff --git a/static/images/Hardware/Minis/MiniRSOV.png b/static/images/Hardware/Minis/MiniRSOV.png index 7c65c5736f..b7739cbe88 100644 Binary files a/static/images/Hardware/Minis/MiniRSOV.png and b/static/images/Hardware/Minis/MiniRSOV.png differ diff --git a/static/images/Hardware/Minis/MiniStencil.png b/static/images/Hardware/Minis/MiniStencil.png index d3d56cfc84..1c178e0490 100644 Binary files a/static/images/Hardware/Minis/MiniStencil.png and b/static/images/Hardware/Minis/MiniStencil.png differ diff --git a/static/images/Hardware/Minis/MiniX+HardwareUpgradesGuide.png b/static/images/Hardware/Minis/MiniX+HardwareUpgradesGuide.png index 99d2646bb3..70870dfa47 100644 Binary files a/static/images/Hardware/Minis/MiniX+HardwareUpgradesGuide.png and b/static/images/Hardware/Minis/MiniX+HardwareUpgradesGuide.png differ diff --git a/static/images/Hardware/Minis/MiniX+XL+OOBM.png b/static/images/Hardware/Minis/MiniX+XL+OOBM.png index ebf35d9abb..775c73a0b9 100644 Binary files a/static/images/Hardware/Minis/MiniX+XL+OOBM.png and b/static/images/Hardware/Minis/MiniX+XL+OOBM.png differ diff --git a/static/images/Hardware/Minis/MiniXHardwareUpgradesGuide.png b/static/images/Hardware/Minis/MiniXHardwareUpgradesGuide.png index 49481bc8ca..3174aa3764 100644 Binary files a/static/images/Hardware/Minis/MiniXHardwareUpgradesGuide.png and b/static/images/Hardware/Minis/MiniXHardwareUpgradesGuide.png differ diff --git a/static/images/Hardware/Minis/MiniXL+HardwareUpgradesGuide.png b/static/images/Hardware/Minis/MiniXL+HardwareUpgradesGuide.png index 1c39092a60..6831a65d12 100644 Binary files a/static/images/Hardware/Minis/MiniXL+HardwareUpgradesGuide.png and b/static/images/Hardware/Minis/MiniXL+HardwareUpgradesGuide.png differ diff --git a/static/images/Hardware/Minis/Minis.png b/static/images/Hardware/Minis/Minis.png index 93d288f03e..605cf1ae6c 100644 Binary files a/static/images/Hardware/Minis/Minis.png and b/static/images/Hardware/Minis/Minis.png differ diff --git a/static/images/Hardware/Notices.png b/static/images/Hardware/Notices.png index d278eac71f..56ab165a92 100644 Binary files a/static/images/Hardware/Notices.png and b/static/images/Hardware/Notices.png differ diff --git a/static/images/Hardware/RSeries/R-Series.png b/static/images/Hardware/RSeries/R-Series.png index ee36870d15..f7a6d558f9 100644 Binary files a/static/images/Hardware/RSeries/R-Series.png and b/static/images/Hardware/RSeries/R-Series.png differ diff --git a/static/images/Hardware/RSeries/R30BSG.png b/static/images/Hardware/RSeries/R30BSG.png index a56dc253a1..cf24772db9 100644 Binary files a/static/images/Hardware/RSeries/R30BSG.png and b/static/images/Hardware/RSeries/R30BSG.png differ diff --git a/static/images/Hardware/RSeries/R50BSG.png b/static/images/Hardware/RSeries/R50BSG.png index a7c3ca0601..ac902aa28f 100644 Binary files a/static/images/Hardware/RSeries/R50BSG.png and b/static/images/Hardware/RSeries/R50BSG.png differ diff --git a/static/images/Hardware/RSeries/RSeriesAll.png b/static/images/Hardware/RSeries/RSeriesAll.png index f5de8d8046..267fc0a1f2 100644 Binary files a/static/images/Hardware/RSeries/RSeriesAll.png and b/static/images/Hardware/RSeries/RSeriesAll.png differ diff --git a/static/images/Hardware/RSeries/RSeriesBSG.png b/static/images/Hardware/RSeries/RSeriesBSG.png index ad4f7a7515..a0e18f6f25 100644 Binary files a/static/images/Hardware/RSeries/RSeriesBSG.png and b/static/images/Hardware/RSeries/RSeriesBSG.png differ diff --git a/static/images/Hardware/RSeries/RSeriesOOBM.png b/static/images/Hardware/RSeries/RSeriesOOBM.png index 6cd63ee595..9e20551d09 100644 Binary files a/static/images/Hardware/RSeries/RSeriesOOBM.png and b/static/images/Hardware/RSeries/RSeriesOOBM.png differ diff --git a/static/images/Hardware/RSeries/RSeriesStencil.png b/static/images/Hardware/RSeries/RSeriesStencil.png index 849e4345eb..9b7f991025 100644 Binary files a/static/images/Hardware/RSeries/RSeriesStencil.png and b/static/images/Hardware/RSeries/RSeriesStencil.png differ diff --git a/static/images/SCALE/Apps/InstallNetdataScreen.png b/static/images/SCALE/Apps/InstallNetdataScreen.png index b1fc5aaa3d..77233059ff 100644 Binary files a/static/images/SCALE/Apps/InstallNetdataScreen.png and b/static/images/SCALE/Apps/InstallNetdataScreen.png differ diff --git a/static/images/SCALE/Apps/InstallNetdataStorageConfigACLandACE.png b/static/images/SCALE/Apps/InstallNetdataStorageConfigACLandACE.png new file mode 100644 index 0000000000..e5848243ca Binary files /dev/null and b/static/images/SCALE/Apps/InstallNetdataStorageConfigACLandACE.png differ diff --git a/static/images/SCALE/Apps/InstallNetdataStorageEnableHostPath.png b/static/images/SCALE/Apps/InstallNetdataStorageEnableHostPath.png deleted file mode 100644 index 3a1bd61209..0000000000 Binary files a/static/images/SCALE/Apps/InstallNetdataStorageEnableHostPath.png and /dev/null differ diff --git a/static/images/SCALE/Apps/NetdataAppDetailsScreen.png b/static/images/SCALE/Apps/NetdataAppDetailsScreen.png index 37ef2d5d2b..acf63a6794 100644 Binary files a/static/images/SCALE/Apps/NetdataAppDetailsScreen.png and b/static/images/SCALE/Apps/NetdataAppDetailsScreen.png differ diff --git a/static/images/SCALE/Apps/NetdataSignInScreen.png b/static/images/SCALE/Apps/NetdataSignInScreen.png index 67ddb5a317..51d191737f 100644 Binary files a/static/images/SCALE/Apps/NetdataSignInScreen.png and b/static/images/SCALE/Apps/NetdataSignInScreen.png differ diff --git a/static/images/SCALE/Apps/NextcloudDetailsScreen.png b/static/images/SCALE/Apps/NextcloudDetailsScreen.png new file mode 100644 index 0000000000..8f75054ef2 Binary files /dev/null and b/static/images/SCALE/Apps/NextcloudDetailsScreen.png differ diff --git a/static/includes/25.04FeatureList.md b/static/includes/25.04FeatureList.md index 390ed4830e..88ae04c81c 100644 --- a/static/includes/25.04FeatureList.md +++ b/static/includes/25.04FeatureList.md @@ -1,21 +1,24 @@ -This page is being updated to follow development changes for TrueNAS 25.04 (Fangtooth). -Check back soon for updates. - - - \ No newline at end of file diff --git a/static/includes/JailsPluginsFirstTime.md b/static/includes/JailsPluginsFirstTime.md index 7efb984aa0..de1344571e 100644 --- a/static/includes/JailsPluginsFirstTime.md +++ b/static/includes/JailsPluginsFirstTime.md @@ -1,11 +1,12 @@ -Going to the **Jails** or **Plugins** screen for the first time prompts you to select a location on the system for storing Jail related data. + +The first time you go to the **Jails** or **Plugins** screen TrueNAS prompts you to select a location on the system for storing jail-related data. ![JailsPluginsStorage](/images/CORE/Jails/JailsPluginsStoragePool.png "Choosing a Storage Pool for Jails and Plugins") By default, this location stores all data related to jails and plugins, including downloaded applications, data managed by the jail or plugin, and any jail snapshots. -* Disconnecting or deleting the pool that stores jail data can result in *permanent data loss!* -* Make sure you back up any critical data or snapshots that are stored in a jail before changing the storage configuration. +Disconnecting or deleting the pool that stores jail data can result in permanent data loss! +Back up all critical data or snapshots stored in a jail before changing the storage configuration. -To change the Jails and Plugins storage location, click , select a new pool, and click **CHOOSE**. \ No newline at end of file +To change the jails and plugins storage location, click , select a new pool, and click **CHOOSE**. \ No newline at end of file diff --git a/static/includes/MigrateCOREtoSCALE24_04.md b/static/includes/MigrateCOREtoSCALE24_04.md index b1c6b5d702..f0cecf8ad9 100644 --- a/static/includes/MigrateCOREtoSCALE24_04.md +++ b/static/includes/MigrateCOREtoSCALE24_04.md @@ -1,6 +1,6 @@ -TrueNAS users wanting to migrate from 13.0-U6 (latest) or 13.3 to TrueNAS 24.10 or later can migrate to 24.04 and earlier using the UI, but must clean install if migrating to later releases. -Attempting to migrate directly to 24.10 or later releases fail and cannot be done. +TrueNAS users wanting to migrate from the latest FreeBSD-based 13.0-U6 or 13.3 CORE release to the Linux-based TrueNAS version 24.10 or later can migrate to 24.04 and earlier using the UI, but must clean install if migrating to later releases. +Attempting to migrate directly to 24.10 or later releases using the UI is not supported. -Download a copy of the iso for the latest maintenance release of 24.10 or earlier, then follow the migration instructions in this Getting Started section of the TrueNAS Documentation Hub to move from the FreeBSD-based version of TrueNAS to the Linux Debian-based version of TrueNAS. +Download a copy of the iso for the latest maintenance release of 24.10 or later, then follow the migration instructions in this Getting Started section of the TrueNAS Documentation Hub to move from the FreeBSD-based to the Linux-based version of TrueNAS. diff --git a/static/includes/RESTAPIDeprecationNotice.md b/static/includes/RESTAPIDeprecationNotice.md index 5da1f839b6..c001efd156 100644 --- a/static/includes/RESTAPIDeprecationNotice.md +++ b/static/includes/RESTAPIDeprecationNotice.md @@ -1,7 +1,7 @@ {{< hint type="info" title="REST API Deprecation Notice" >}} -The TrueNAS REST API is deprecated in TrueNAS 25.04 and replaced by the [TrueNAS API Client](https://github.com/truenas/api_client). +The TrueNAS REST API is deprecated in TrueNAS 25.04 and replaced by the [TrueNAS websocket client](https://github.com/truenas/api_client). Full removal of the REST API is planned for a future release. This new API Client is not the deprecated TrueNAS CLI (midcli). diff --git a/static/includes/SCALEUpgradePaths.md b/static/includes/SCALEUpgradePaths.md index 322ce721ce..b46112d069 100644 --- a/static/includes/SCALEUpgradePaths.md +++ b/static/includes/SCALEUpgradePaths.md @@ -41,6 +41,18 @@ } +The chart below shows recommended paths for upgrading from earlier TrueNAS versions. + +Update the system to the latest maintenance release of the installed major version before attempting to upgrade to a new major version. + +Permitted upgrade methods are: +* **update**: apply an automatic update using the **Update** screen in the TrueNAS UI or install a manual update file. Some upgrade paths do not support these options (see chart). +* **ISO install**: save a current TrueNAS configuration file, perform a fresh install using an .iso file for the target version, and then upload the previously saved configuration. + +Users can skip major versions with a fresh ISO install followed by a configuration file upload. +Carefully review release notes for each skipped major version before upgrading, noting any service deprecations or significant changes that impact the previous configuration. +Consider stopping at major versions with significant impacts to address changes before continuing the upgrade path or be prepared to manually reconfigure incompatibilities on the latest target version. +
    TrueNAS @@ -48,12 +60,16 @@
    {{< mermaid class="mermaid_sizing" >}} flowchart LR - A["22.02.4 (Angelfish)"] -->|update| C - B["13.0-U6.2

    13.3-RELEASE"] -->|ISO install| E - C["22.12.4.2 (Bluefin)"] -->|update| D - D["23.10.2 (Cobia)"] -->|update| E - E["24.04.2.5 (Dragonfish)"] -->|update| H - H["24.10.0.2 (Electric Eel)"] + A["11.3-U5"] -->|update| B["12.0-U8.1"] + B -->|"update

    ISO install"| C["13.0-U6.3

    13.3-U1"] + C -->|ISO install| H + C -->|"(anticipated)"| I + D["22.02.4 (Angelfish)"] -->|update| E + E["22.12.4.2 (Bluefin)"] -->|update| F + F["23.10.2 (Cobia)"] -->|update| G + G["24.04.2.5 (Dragonfish)"] -->|update| H + H["24.10.0.2 (Electric Eel)"] -->|"(anticipated)"| I + I["25.04.0 (Fangtooth)"] {{< /mermaid >}}
    @@ -64,11 +80,14 @@
    {{< mermaid class="mermaid_sizing" >}} flowchart LR - A["13.0-U6.2"] -->|ISO install| D - B["Current 23.10 (Cobia) release"] -->|update| C - C["23.10.2 (Cobia)"] -->|update| D - D["24.04.2.5 (Dragonfish)"] -->|"(anticipated)"| E - E["24.10.0.2 (Electric Eel)"] + A["11.3-U5"] -->|update| B + B["12.0-U8.1"] -->|update| C + C["13.0-U6.3"] -->|"(anticipated)"| F + C["13.0-U6.3"] -->|"(anticipated)"| G + D["23.10.2 (Cobia)"] -->|update| E + E["24.04.2.5 (Dragonfish)"] -->|"(anticipated)"| F + F["24.10.0.2 (Electric Eel)"] -->|"(anticipated)"| G + G["25.04.0 (Fangtooth)"] {{< /mermaid >}}
    diff --git a/static/includes/apps/BeforeYouBeginAddAppDatasets.md b/static/includes/apps/BeforeYouBeginAddAppDatasets.md new file mode 100644 index 0000000000..fe88093c94 --- /dev/null +++ b/static/includes/apps/BeforeYouBeginAddAppDatasets.md @@ -0,0 +1,13 @@ + + +* Create datasets for the storage volumes for the app. + + {{< hint type=warning title="Encrypted Datasets" >}} + Do not create encrypted datasets for apps if not required! + Using an encrypted dataset can result in undesired behaviors after upgrading TrueNAS when pools and datasets are locked. + When datasets for the containers are locked, the container does not mount, and the apps do not start. + To resolve issues, unlock the dataset(s) by entering the passphrase/key to allow datasets to mount and apps to start. + {{< /hint >}} + + Go to **Datasets** and select the pool or dataset where you want to place the dataset(s) for the app. + For example, */tank/apps/appName*. \ No newline at end of file diff --git a/static/includes/apps/BeforeYouBeginAddAppDatasetsProcedure.md b/static/includes/apps/BeforeYouBeginAddAppDatasetsProcedure.md new file mode 100644 index 0000000000..a7a0fb44d1 --- /dev/null +++ b/static/includes/apps/BeforeYouBeginAddAppDatasetsProcedure.md @@ -0,0 +1,25 @@ + + + {{< expand "Creating Datasets for Apps" "v" >}} + When creating datasets for apps follow these steps: + 1. Go to **Datasets**, select the location for the parent dataset if organizing required datasets under a parent dataset, then click **Add Dataset**. + For example, select the root dataset of the pool, and click **Add Dataset** to create a new parent called *apps* or *appName**, where *appName* is the name of the app. + + Do not create the app datasets under the ix-applications or ix-apps dataset. + + 2. Enter the name of the dataset, then select **Apps** as the **Dataset Preset**. + Creating the parent dataset with the preset set to **Generic** causes permissions issues when you try to create the datasets the app requires with the preset set to **Apps**. + + 3. Click **Save**. + Return to dataset creation when prompted rather than configuring ACL permissions. + + You can set up permissions (ACLs) for a dataset after adding it by selecting **Go to ACL Manager** to open the Edit ACL screen, or wait and use the app Install wizard ACL settings to add permissions. + You can also edit permissions after installing the app using either method. + + 4. Select the parent dataset and then click **Create Dataset** to open the **Add Dataset** screen again. + + 5. Enter the name of a dataset required for the app, such as *config*, select **Apps** as the **Dataset Preset**, and then click **Save**. + When prompted, return to creating datasets rather than setting up ACL permissions. + + 6. Repeat for remaining datasets required for the app. + {{< /expand >}} \ No newline at end of file diff --git a/static/includes/apps/BeforeYouBeginAddNewAppUser.md b/static/includes/apps/BeforeYouBeginAddNewAppUser.md index 8079a97763..ea64d7cea0 100644 --- a/static/includes/apps/BeforeYouBeginAddNewAppUser.md +++ b/static/includes/apps/BeforeYouBeginAddNewAppUser.md @@ -1,4 +1,6 @@ -* (Optional) Create a new user account to manage this application. - If creating a new user account to manage this application or using an [administrator]({{< relref "ManageLocalUsersSCALE.md" >}}) account, enable sudo permissions for that account, and add the user to the dataset ACL permissions. \ No newline at end of file +* (Optional) Create a new TrueNAS user account to manage this application. + When creating a new user account to manage this application or using an existing TrueNAS [administrator]({{< relref "ManageLocalUsersSCALE.md" >}}) account, enable sudo permissions for that TrueNAS user account, select **Create New Primary Group**, and add the appropriate group in the **Auxiliary Group** for the type of user you want to create. Make note of the UID for the new user to add in the installation wizard. + + Add the user ID to the dataset ACL permissions when setting up app storage volumes in the Install app wizard. \ No newline at end of file diff --git a/static/includes/apps/BeforeYouBeginRunAsUser.md b/static/includes/apps/BeforeYouBeginRunAsUser.md new file mode 100644 index 0000000000..5f404a3515 --- /dev/null +++ b/static/includes/apps/BeforeYouBeginRunAsUser.md @@ -0,0 +1,6 @@ + + +* Locate the run-as user for the app. + + Take note of the run-as user for the app, shown on the app information screen in the **Run As Content** widget and in the **Application Metadata** widget on the **Installed** applications screen after the app fully deploys. + The run-as user(s) get added to the ACL permissions for each dataset used as a host path storage volume. \ No newline at end of file diff --git a/static/includes/apps/BeforeYouBeginStableApps.md b/static/includes/apps/BeforeYouBeginStableApps.md index 7a074ed2f6..6a016d8adf 100644 --- a/static/includes/apps/BeforeYouBeginStableApps.md +++ b/static/includes/apps/BeforeYouBeginStableApps.md @@ -2,16 +2,10 @@ * Set a pool for applications to use if not already assigned. - Go to **Apps**. If the pool for apps is not already set, do it when prompted. + You can use either an existing pool or [create a new one]({{< relref "CreatePoolWizard.md" >}}). TrueNAS creates the **ix-apps** (hidden) dataset in the pool set as the application pool. This dataset is internally managed, so you cannot use this as the parent when you create required application datasets. - After setting the pool, the **Installed Applications** screen displays **Apps Service Running** on the top screen banner. {{< trueimage src="/images/SCALE/Apps/AppsChooseAPoolForApps.png" alt="Choose A Pool for Apps" id="Choose A Pool for Apps" >}} -* (Optional) Create a new TrueNAS user to serve as the administrator for the app. - - You can use the default user or add a new user. - When you [create a new user]({{< relref "ManageLocalUsersSCALE.md#creating-user-accounts" >}}) select **Create New Primary Group**, and add the appropriate group in the **Auxiliary Group** for the type of user you want to create. Make note of the UID for the new user to add in the installation wizard. - -* Create the required dataset(s). \ No newline at end of file + After setting the pool, the **Installed Applications** screen displays **Apps Service Running** on the top screen banner. diff --git a/static/includes/apps/InstallAppsStorageConfig.md b/static/includes/apps/InstallAppsStorageConfig.md index 5168eb31cd..4e95260d8b 100644 --- a/static/includes/apps/InstallAppsStorageConfig.md +++ b/static/includes/apps/InstallAppsStorageConfig.md @@ -15,8 +15,5 @@ Populating the **Host Path** with the dataset location and then selecting **Enab {{< include file="/static/includes/apps/AppInstallWizardACLConfiguration.md" >}} -When the app requires additional datasets, repeat the host path setting for each required dataset. -When adding additional storage volumes inside the container, click **Add** to the right of **Additional Storage** to show the storage volume fields. - -Click **Add** to show the mount and host path fields for each additional dataset and if creating storage volumes for postgres data and postgres backup. +Repeat the above for each required dataset. {{< /expand >}} \ No newline at end of file diff --git a/static/includes/apps/InstallWizardStorageACLConfig.md b/static/includes/apps/InstallWizardStorageACLConfig.md index d085677433..cb875bafba 100644 --- a/static/includes/apps/InstallWizardStorageACLConfig.md +++ b/static/includes/apps/InstallWizardStorageACLConfig.md @@ -12,24 +12,23 @@ Set **ID Type** to **Entry is for a USER** or **Entry is for a GROUP**. If you configured a group in TrueNAS that you want to give access to instead of a single user, set the ID to the group option and enter the GID for that group. Enter the UID as one of the following: -* The default apps user, which are: +* The default app user: * **568** for apps in all trains if the app can run as any non-root user. * **999** for all postgres storage volumes. * **0** if running as root. * **473** for MinIO app in the stable train. * The run-as-user UID set as a default for the app. - The run-as user shows on the details screen in the **Run As Content** widget, and on the **Installed** application screen after the app is deployed. - You can also refer to the tutorial for the app, or look in the questions.yaml file in the GitHub repository for the application to find this UID/GID. -* The new user UID for a TrueNAS user created to serve as the app administrator. + The run-as user shows on the app details screen in the **Run As Content** widget, and on the **Installed** application screen after the app deploys. + You can refer to the tutorial for the app, or look in the questions.yaml file found in the GitHub repository for the application to find this UID/GID. +* The user ID for the new or existing TrueNAS user added to serve as the administrator for the app. -If the app shows **User and Group Configuration** settings, the default UID shows on the screen. If not, choose the run-as UID. +If the app shows **User and Group Configuration** settings, the default UID shows on the screen. If not, choose the run-as user ID found in the **Run As Content** widget. -All postgres storage volumes use the default user ID **999**, not as the run-as user. +Use the default user ID **999** for all postgres storage volumes, not the run-as user. -If you create a new user to serve as the app administration user, enter the UID for this user in addition to the run-as user ID. -Always add the run-as user with full control permissions except for postgres storage volumes. +If you created a new TrueNAS user to serve as the app administration user, add an entry record and enter the UID for this user in addition to the run-as user ID. -Select the ID type from the dropdown list, enter the UID (or GID if you select the group ID type) for the app administration user, and then set the **Access** permissions level to **FULL CONTROL**. +When adding the ACL entry for the run-as user, default user, and/or optional TrueNAS app administrator user, and postgres user ID, set the **Access** permissions level to **FULL CONTROL**. {{< /expand >}} Select **Force Flag** to apply the ACL even if the path has existing data. This allows you to update the app when an update is available. \ No newline at end of file diff --git a/static/includes/apps/LocateAndOpenInstallWizard.md b/static/includes/apps/LocateAndOpenInstallWizard.md index 4f1ad0d83c..68cb6c1324 100644 --- a/static/includes/apps/LocateAndOpenInstallWizard.md +++ b/static/includes/apps/LocateAndOpenInstallWizard.md @@ -14,8 +14,6 @@ Click **Confirm** then **Agree** to close the dialog and open the application de {{< /expand >}} If not the first time installing apps the dialog does not show, click on the widget to open the app information screen. -{{< trueimage src="/images/SCALE/Apps/MiniIOS3AppInfoScreen.png" alt="Example of an App Information Screen" id="Example of an App Information Screen" >}} - Click **Install** to open the app installation wizard. Application configuration settings are grouped into several sections, each explained below in **Understanding App Installation Wizard Settings**. diff --git a/symlinks.txt b/symlinks.txt new file mode 100644 index 0000000000..5c64e9a3fd --- /dev/null +++ b/symlinks.txt @@ -0,0 +1,8 @@ +/scale/25.04 public/scale/25.04 +/scale/24.10 public/scale/24.10 + +/core/13.3 public/core/13.3 +/core/13.0 public/core/13.0 + +/truecommand/3.0 public/truecommand/3.0 +/truecommand/2.3 public/truecommand/2.3 diff --git a/themes/hugo-geekdoc/layouts/robots.txt b/themes/hugo-geekdoc/layouts/robots.txt index 9298bf6aeb..55331fdbb9 100644 --- a/themes/hugo-geekdoc/layouts/robots.txt +++ b/themes/hugo-geekdoc/layouts/robots.txt @@ -5,5 +5,6 @@ Disallow: /book/* Disallow: /archive/* Disallow: /volume/* Disallow: /includes/* +Disallow: /images/* Sitemap: {{ "sitemap.xml" | absURL }} diff --git a/words-to-ignore.txt b/words-to-ignore.txt index 5f8daa1aa6..3a25ee3081 100644 --- a/words-to-ignore.txt +++ b/words-to-ignore.txt @@ -2147,3 +2147,8 @@ VPN Tailscale tailscale AuthKey +ScrubTasksSCALE +FusionPoolsScale +CloudSyncTasks +CreatingSnapshots +AddManageZvols