Skip to content

Commit

Permalink
Merge branch 'master' into PD-1617-Create-Asigra-Tutoral-Update-Solut…
Browse files Browse the repository at this point in the history
…ions-Article
  • Loading branch information
linzi-ix authored Jan 3, 2025
2 parents cd68d54 + 7cb2f45 commit 8a88992
Show file tree
Hide file tree
Showing 57 changed files with 2,125 additions and 98 deletions.
16 changes: 16 additions & 0 deletions content/Hardware/LegacyHardware/MiniSeries/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,22 @@ The end-of-support date for TrueNAS Mini E systems is November 7, 2025.
* <a href="https://www.truenas.com/docs/files/MiniEHUG.pdf" download>Mini E Hardware Upgrades Guide</a>: Instructions for replacing or adding components inside a TrueNAS Mini E system.
* <a href="https://www.truenas.com/docs/files/MiniEOOBM.pdf" download>Mini E Out-of-Band Management</a>: Instructions for configuring the BIOS in a TrueNAS Mini E system.

#### TrueNAS Mini X

The TrueNAS Mini X was designated end-of-life (EOL) by iXsystems on December 31, 2024.
The end-of-support date for TrueNAS Mini X systems is October 10, 2029.

* <a href="https://www.truenas.com/docs/files/TrueNAS%20Mini%20X%20EOL.pdf" download>TrueNAS Mini X EOL December 2024</a>: Official iXsystems EoL for the TrueNAS Mini X system.
* <a href="https://www.truenas.com/docs/files/MiniFamily3.7.pdf" download>NAS Mini Basic Setup Guide v.3.7</a>: Setup Guide for TrueNAS Mini Products, including some that are now end of life.
* <a href="https://www.truenas.com/docs/files/MiniXHardwareUpgradesGuide1.0.pdf" download>Mini X Hardware Upgrades Guide</a>: Instructions for replacing or adding components inside a TrueNAS Mini X system.
* <a href="https://www.truenas.com/docs/files/MiniXOOBM1.3.pdf" download>Mini X Out-of-Band Management</a>: Instructions for configuring the BIOS in a TrueNAS Mini X system.

#### TrueNAS Mini XL+

* <a href="https://www.truenas.com/docs/files/MiniFamily3.7.pdf" download>NAS Mini Basic Setup Guide v.3.7</a>: Setup Guide for TrueNAS Mini Products, including some that are now end of life.
* <a href="https://www.truenas.com/docs/files/MiniXL+HardwareUpgradesGuide1.2.pdf" download>Mini XL+ Hardware Upgrades Guide</a>: Instructions for replacing or adding components inside a TrueNAS Mini XL+ system.
* <a href="https://www.truenas.com/docs/files/MiniX+XL+OOBM1.2.pdf" download>Mini XL+ Out-of-Band Management</a>: Instructions for configuring the BIOS in a TrueNAS Mini XL+ system.

### FreeNAS Minis (Gen 2)

The FreeNAS Mini and Mini XL (Gen 2) were designated end-of-life (EOL) by iXsystems on February 25, 2020.
Expand Down
23 changes: 6 additions & 17 deletions content/Hardware/MiniFamily.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: "TrueNAS Mini"
description: "Professional-grade office ZFS NAS storage solution with up to 250TB fusion or 90TB all-flash capacity. Suited for small/home office, file sharing, VMs, and plugins."
weight: 50
geekdocFlatSection: true
aliases:
- /hardware/mini/
- /hardware/mini/minibsg/
description: "Professional-grade office ZFS NAS storage solution with up to 250TB fusion or 90TB all-flash capacity. Suited for small/home office, file sharing, VMs, and plugins."
- /images/Hardware/MiniFamilyFront.png
keyword:
- scalable storage systems
- data storage system
Expand All @@ -23,31 +24,19 @@ Visit the [Mini Family product page](https://www.truenas.com/truenas-mini/) for
## Resources

<div class="docs-sections">
{{< imagecard image="/images/Hardware/Minis/MiniFamilyBSG.png" title="Basic Setup Guide" link="https://www.truenas.com/docs/files/MiniFamily3.7.pdf"
{{< imagecard image="/images/Hardware/Minis/MiniX+BSG.png" title="Mini X+ Basic Setup Guide" link="https://www.truenas.com/docs/files/MiniX+BSG25011.pdf"
descr="Deployment guide for 3rd Generation TrueNAS Mini Systems." >}}

{{< imagecard image="/images/Hardware/Minis/MiniRBSG.png" title="Mini R Basic Setup Guide" link="https://www.truenas.com/docs/files/MiniRBSG1.1.pdf"
descr="Deployment guide for TrueNAS Mini R Systems." >}}

{{< imagecard image="/images/Hardware/Minis/MiniNetworkPortIDs.png" title="Network Port IDs" link="https://www.truenas.com/docs/files/MiniNetworkPortIDs.pdf"
{{< imagecard image="/images/Hardware/Minis/MiniNetworkPortIDs.png" title="Network Port IDs" link="https://www.truenas.com/docs/files/MiniNetworkPortID25011.pdf"
descr="TrueNAS identifications list of TrueNAS Mini systems network ports." >}}

{{< imagecard image="/images/Hardware/Minis/MiniXOOBM1.3.png" title="Mini X Out-of-Band Management" link="https://www.truenas.com/docs/files/MiniXOOBM1.3.pdf"
descr="BIOS configuration instructions for TrueNAS Mini X systems." >}}

{{< imagecard image="/images/Hardware/Minis/MiniX+XL+OOBM.png" title="Mini X+ and XL+ Out-of-Band Management" link="https://www.truenas.com/docs/files/MiniX+XL+OOBM1.2.pdf"
{{< imagecard image="/images/Hardware/Minis/MiniX+OOBM.png" title="Mini X+ Out-of-Band Management" link="https://www.truenas.com/docs/files/MiniX+OOBM25011.pdf"
descr="BIOS configuration instructions for TrueNAS Mini X+ and XL+ systems." >}}

{{< imagecard image="/images/Hardware/Minis/MiniXHardwareUpgradesGuide.png" title="Mini X Hardware Upgrades" link="https://www.truenas.com/docs/files/MiniXHardwareUpgradesGuide1.0.pdf"
descr="Hardware Upgrade Guide for TrueNAS Mini X." >}}

{{< imagecard image="/images/Hardware/Minis/MiniX+HardwareUpgradesGuide.png" title="Mini X+ Hardware Upgrades" link="https://www.truenas.com/docs/files/MiniX+HardwareUpgradesGuide1.2.pdf"
descr="Hardware Upgrade Guide for TrueNAS Mini X+." >}}

{{< imagecard image="/images/Hardware/Minis/MiniXL+HardwareUpgradesGuide.png" title="Mini XL+ Hardware Upgrades" link="https://www.truenas.com/docs/files/MiniXL+HardwareUpgradesGuide1.2.pdf"
descr="Hardware Upgrade Guide for TrueNAS Mini X+." >}}

{{< imagecard image="/images/Hardware/Minis/MiniFamilySoV.png" title="Mini Family Statement of Volatility" link="https://www.truenas.com/docs/files/MiniFamilySoV1.0.pdf"
{{< imagecard image="/images/Hardware/Minis/MiniX+SOV.png" title="Mini X+ Statement of Volatility" link="https://www.truenas.com/docs/files/MiniX+SOV25011.pdf"
descr="iXsystems official Statement of Volatility for Mini systems." >}}

{{< imagecard image="/images/Hardware/Minis/MiniRSOV.png" title="Mini R Statement of Volatility" link="https://www.truenas.com/docs/files/MiniRSOV.pdf"
Expand Down
2 changes: 2 additions & 0 deletions content/Hardware/Notices/EndOfLifeAnnouncements.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ weight: 30

<div class="docs-sections">

{{< imagecard image="/images/Hardware/Notices.png" title="TrueNAS Mini X EOL December 2024" link="https://www.truenas.com/docs/files/TrueNAS%20Mini%20X%20EOL.pdf" descr="Official iXsystems EoL for TrueNAS Mini X systems." >}}

{{< imagecard image="/images/Hardware/Notices.png" title="TrueNAS X-Series EOL March 2024" link="https://www.truenas.com/docs/files/XSeriesEOL.pdf" descr="Official iXsystems EoL for TrueNAS X-Series systems." >}}

{{< imagecard image="/images/Hardware/Notices.png" title="TrueNAS Mini E+ EOL February 2024" link="https://www.truenas.com/docs/files/TrueNASMiniE+EOL.pdf" descr="Official iXsystems EoL for TrueNAS Mini E+ systems." >}}
Expand Down
3 changes: 2 additions & 1 deletion content/Hardware/RSeries.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
---
title: "R-Series"
description: "High rack-density, Enterprise-grade, fusion or all-flash, performance NAS storage. Suited for workgroup projects, file sharing, backups, plugins, and Kubernetes."
geekdocFlatSection: true
weight: 30
aliases:
- /hardware/rseries/rseriesbsg/
- /hardware/rseries/rseriesoobm/
- /hardware/rseries/rseriessov/
description: "High rack-density, Enterprise-grade, fusion or all-flash, performance NAS storage. Suited for workgroup projects, file sharing, backups, plugins, and Kubernetes."
- /images/Hardware/R40R50Front.png
keyword:
- enterprise storage solution
- scalable storage systems
Expand Down
1 change: 1 addition & 0 deletions content/Hardware/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ geekdocCollapseSection: true
weight: 40
aliases:
- /hardware/stencils/
- /images/Hardware/TrueNASStencilsPreview.png
cascade:
- _target:
related: false
Expand Down
2 changes: 1 addition & 1 deletion content/References/ConceptsAndTerms.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Concepts and Terminology"
description: "Provides a glossary of terms and definitions used in TrueNAS and general network attach storage (NAS) software."
description: "Provides a glossary of terms and definitions used in TrueNAS and general network attached storage (NAS) software."
weight: 10
---

Expand Down
1 change: 1 addition & 0 deletions content/SCALE/GettingStarted/Configure/FirstTimeLogin.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Describes the web interface, logging in to the TrueNAS web interfa
weight: 20
aliases:
- /scale/gettingstarted/firsttimelogin/
- /images/SCALE/Dashboard/DashboardMainScreenSCALE.png
tags:
- dashboard
keywords:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Provides information on using the Console Setup menu after install
weight: 20
aliases:
- /scale/gettingstarted/post-installconfiguration/
- /images/SCALE/22.12/ConsoleSetupMenuSCALE.png
tags:
- install
- network
Expand Down
1 change: 1 addition & 0 deletions content/SCALE/GettingStarted/Install/InstallingSCALE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Provides the TrueNAS iso file installation instructions for physic
weight: 15
aliases:
- /scale/gettingstarted/installingscale/
- /images/SCALE/Install/SCALEInstallPartitionScreen.png
tags:
- install
- update
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "Enterprise Migrations"
description: "Instructions for TrueNAS Enterprise users to migrate from FreeBSD- to Linux-based TrueNAS software."
weight: 25
aliases:
- /scale/gettingstarted/migrate/migratecorehatoscaleha/
tags:
- migrate
- install
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Joining an AD domain also configures the Privileged Access Manager (PAM) to let
Users can configure AD services on Windows or Unix-like operating systems using [Samba version 4](https://wiki.samba.org/index.php/Setting_up_Samba_as_an_Active_Directory_Domain_Controller#Provisioning_a_Samba_Active_Directory).

### Preparing to Configure AD in TrueNAS
Before configuring Active Directory (AD) in TrueNAs:
Before configuring Active Directory (AD) in TrueNAS:

You need to know the hostname assigned to the TrueNAS system. The default value is **truenas**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
title: "Managing Users"
description: "Provides instructions on adding and managing administrator and user accounts."
weight: 10
aliases: /scale/scaleuireference/credentials/localusers/
aliases:
- /scale/scaleuireference/credentials/localusers/
- /images/CORE/13.0/AddUserNamedCORE.png
tags:
- users
- accounts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ geekdocCollapseSection: true
aliases:
- /scale/scaletutorials/dataprotection/cloudsynctasks/addcloudsynctasks/
- /scale/scaleclireference/task/cloudsync/
- /images/CORE/12.0/TasksCloudSyncAdd.png
weight: 20
tags:
- cloud
Expand Down
24 changes: 14 additions & 10 deletions content/SCALE/SCALETutorials/DataProtection/TrueCloudTasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ This article provides instructions on configuring a TrueCloud backup task using
{{< hint type=important >}}
To take advantage of the lower-cost benefits of the TrueCloud backup service, you must create your Storj iX account using the link provided on the **Add Cloud Credentials** screen.

You must also create and authorize the storage buckets on Storj for use by TrueNAS.
You must also create and authorize the storage buckets on Storj for TrueNAS to useS.

iXsystems is not responsible for any charges incurred using a third-party vendor with the TrueCloud backup feature.
iXsystems is not responsible for charges incurred using a third-party vendor with the TrueCloud backup feature.
{{< /hint >}}

## TrueCloud Backup Task Requirements

You must have all system storage (pool and datasets or zvols) configured and ready to receive or send data.
You must configure all system storage (pool and datasets or zvols) and have then ready to receive or send data.

## Creating a TrueCloud Backup Task

Expand Down Expand Up @@ -63,19 +63,19 @@ To add the TrueCloud backup task, go to **Data Protection > TrueCloud Backup Tas

1. Click **Add** to open the **Add TrueCloud Backup Task** screen.

{{< trueimage src="/images/SCALE/DataProtection/AddTrueCloudTask.png" alt="Add TrueCloud Backup Task" id="Add TrueCloud Backup Task" >}}
{{< trueimage src="/images/SCALE/DataProtection/AddTrueCloudTaskBasicOptions.png" alt="Add TrueCloud Backup Task" id="Add TrueCloud Backup Task" >}}

2. Enter or browse to select the local **Source Path** to the directories or files you want sent to the cloud for backup.
Click the arrow to the left of the name to expand it, then click on the name to select it.

3. Select the Storj credential on the **Credentials** dropdown list.
You can select **Add New** to create the Storj credential if you skipped the instructions above.

4. Select the the Storj bucket to use from the **Bucket** dropdown list.
4. Select the Storj bucket to use from the **Bucket** dropdown list.

If you have not previously created a TrueNAS compatible Storj bucket, select **Add New** and follow the procedure in [Creating a TrueNAS Storj Bucket](#creating-a-truenas-storj-bucket).

Click the arrow icon for the **Folder** field to expand the dropdown list and select the desired folder in the Storj bucket or enter a folder path.
Click the arrow icon for the **Folder** field to expand the dropdown list and select the desired folder in the Storj bucket, or enter a folder path.
Enter `/name`, where *name* is a folder that does not exist, to create a new folder in the Storj bucket.

5. Enter a name for the task under **Task Settings**.
Expand All @@ -101,18 +101,22 @@ The task status changes to **SUCCESS** when complete.

**Advanced Options** and **Advanced Remote Options** contain additional settings for advanced users.

To take a snapshot before transferring data to Storj, select **Take Snapshot**.
{{< trueimage src="/images/SCALE/DataProtection/AddTrueCloudTaskAdvancedOptions.png" alt="Add TrueCloud Backup Task Advanced Options" id="Add TrueCloud Backup Task Advanced Options" >}}

<!-- <to be re-added at a later date> To take a snapshot before transferring data to Storj, select **Take Snapshot**.
This option is not available for datasets with child datasets.
-->

Advanced users can write scripts that run immediately before or after the TrueCloud backup task.
Enter environment variables in either the **Pre-script** or **Post-script** fields.
The **Post-script** field only runs when the TrueCloud backup task succeeds.
See [TrueCloud Backup Tasks Screens]({{< relref "truecloudbackuptasksscreen.md #advanced-options-settings" >}}) for information on available environment variables.

Use **Exclude** to enter a list of files and directories to exclude from sync.
Separate entries by pressing <kbd>Enter</kbd>.
Press <kbd>Enter</kbd> to separate entries.
See [TrueCloud Backup Tasks Screens]({{< relref "truecloudbackuptasksscreen.md #advanced-options-settings" >}}) for syntax examples.

Use **Transfers** and **Bandwidth Limit** to prevent excess resource consumption and set a bandwidth availability schedule.
Use **Transfer Settings** to prevent excess resource consumption by setting the pack size and read concurrency.

## Managing TrueCloud Tasks

Expand Down Expand Up @@ -147,4 +151,4 @@ A **Delete Snapshot** dialog opens.

{{< trueimage src="/images/SCALE/DataProtection/TrueCloudDeleteSnapshot.png" alt="Delete Snapshot" id="Delete Snapshot" >}}

Click **Confirm** and then **Delete** to start the job.
Click **Confirm** and then **Delete** to start the job.
1 change: 1 addition & 0 deletions content/SCALE/SCALETutorials/Datasets/DatasetsSCALE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ aliases:
- /scale/scaletutorials/storage/pools/datasetsscale/
- /scale/scaletutorials/storage/datasets/datasetsscale/
- /_includes/storagecompressionlevelsscale/
- /images/CORE/13.0/StoragePoolsAddDataset2.png
tags:
- datasets
- storage
Expand Down
1 change: 1 addition & 0 deletions content/SCALE/SCALETutorials/Storage/ManagePoolsScale.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: "Provides instructions on managing storage pools, VDEVs, and disks
weight: 40
aliases:
- /scale/scaletutorials/storage/pools/managepoolsscale/
- /images/CORE/13.0/StorageAllPoolsDataset.png
tags:
- pools
- storage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ geekdocCollapseSection: true
weight: 30
aliases:
- /scale/scaletutorials/systemsettings/advanced/advancedsettings/
- /_includes/createdebugcore/
tags:
- settings
- replication
Expand Down
2 changes: 0 additions & 2 deletions content/SCALE/SCALETutorials/Virtualization/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,6 @@ If you have not yet added a virtual machine to your system, click **Add Virtual

{{< trueimage src="/images/SCALE/Virtualization/AddVMGPU.png" alt="GPU Screen" id="GPU Screen" >}}

The **VirtIO** network interface requires a guest OS that supports VirtIO para-virtualized network drivers.

{{< hint type="note" title="Supported GPUs" >}}
iXsystems does not have a list of approved GPUs at this time but TrueNAS does support various GPU from Nvidia, Intel, and AMD.
As of 24.10, TrueNAS does not automatically install NVIDIA drivers. Instead, users must manually install drivers from the UI. For detailed instructions, see (https://www.truenas.com/docs/truenasapps/#installing-nvidia-drivers).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ weight: 25
aliases:
- /scale/scaleuireference/apps/launchdockerimagescreens/
- /scale/scaletutorials/apps/docker/
- /images/SCALE/22.12/LaunchDockerImageAddStorage.png
- /images/SCALE/22.12/LaunchDockerImageAddContainerEntrypoints.png
tags:
- customapp
---
Expand Down
1 change: 1 addition & 0 deletions content/SCALE/SCALEUIReference/Apps/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ aliases:
- /scale/scaleclireference/app/clicontainer/
- /scale/scaleclireference/app/clidocker/
- /scale/scaleclireference/app/clikubernetes/
- /images/SCALE/AppsCatalog.png
tags:
- apps
related: false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: "Provides information on the Cloud Credentials screens and settings
weight: 10
aliases:
- /scale/scaleclireference/task/cloudsync/clicredential/
- /images/CORE/12.0/SystemCloudCredentialsOAuthLogin.png
- /images/CORE/12.0/CloudCredentialsAddCredentials.png
tags:
- cloud
- credentials
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ aliases:
- /scale/credentials/directoryservices/idmapscale/
- /scale/credentials/directoryservices/kerberosscale/
- /scale/scaleclireference/directory-service/
- /images/CORE/12.0/DirectoryServicesNIS.png
tags:
- kerberos
- activedirectory
Expand Down
Loading

0 comments on commit 8a88992

Please sign in to comment.