Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Managing the System Configuration"
description: "Provides information on downloading your TrueNAS SCALE configuration to back up system settings, uploading a new configuration file, and resetting back to default settings."
description: "Provides information on downloading your TrueNAS SCALE configuration to back up system settings, uploading a new configuration file, and resetting to default settings."
weight: 15
tags:
- backup
Expand All @@ -13,36 +13,29 @@ keywords:
- hybrid storage
---

TrueNAS SCALE allows users to manage the system configuration by uploading or downloading configurations, or by resetting the system to the default configuration.
TrueNAS SCALE allows users to manage the system configuration by uploading or downloading configurations or by resetting the system to the default configuration.

## System Configuration Options
The **Manage Configuration** option on the **System > General Settings** screen provides three options:

* **Download File** that downloads your system configuration settings to a file on your system.
* **Upload File** that allows you to upload a replacement configuration file.
* **Reset to Defaults** that resets system configuration settings back to factory settings.
* **Reset to Defaults** resets system configuration settings back to factory settings.

### Downloading the File
The **Download File** option downloads your TrueNAS SCALE current configuration to the local machine.

{{< include file="/static/includes/DownloadSystemConfigFileSCALE.md" >}}

### Uploading the File
The **Upload File** option gives users the ability to replace the current system configuration with any previously saved TrueNAS SCALE configuration file.
The **Upload File** option gives users the ability to replace the current system configuration with any previously saved TrueNAS configuration file.

{{< hint type=warning >}}
When migrating from a FreeBSD-based releases to a Linux-based release, the new administration user login credentials (name and password) are deleted and replaced with the FreeBSD-based root user and password in the uploaded configuration file.
Log into the UI with the original root user credentials, then recreate an administration user and password.

To security-harden your system, do not use the **trunas_admin** user or **admin**, choose a unique username and password that cannot be easily guessed.
Disable the root user login password as the final step.
{{< /hint >}}

{{< hint type=warning title="Always Include the Secret Seed!" >}}
If you do not save the secret seed downloading the system config file, various services can break due to missing information.
If you do not save the secret seed by downloading the system config file, various services can break due to missing information.
Without the secret seed, encrypted fields are set to empty values. For example, SMB via local accounts and apps.
Always select the option to save the secret seed when downloading the system config file!
{{< /hint >}}

Uploading a configuration file from a FreeBSD-based release wipes any existing administrative users and replaces them with the original root user and password from the uploaded configuration file.
To secure the system after restoring from a FreeBSD-based TrueNAS config file, log in with the original root user credentials, recreate an administrative account, and finally re-disable the root account password.

### Resetting to Defaults

Expand All @@ -59,14 +52,11 @@ Save the current system configuration with the **Download File** option before r
If you do not save the system configuration before resetting it, you could lose data that was not backed up, and you cannot revert to the previous configuration.

The **Reset to Defaults** option resets the system configuration to factory settings.
After the configuration resets, the system restarts and users must set a new login password.
After the configuration resets, the system restarts, and users must set a new login password.

### Backing Up the Config File
SCALE does not automatically back up the system configuration file to the system dataset.
### Remote Backups of the Config File

Users who want to schedule an automatic backup of the system configuration file should:
TrueCommand provides an easy solution for users who want to schedule an automatic remote backup of the system configuration file:
1. [Set up TrueCommand](https://www.truenas.com/docs/truecommand/tcgettingstarted/install/).
2. [Add their SCALE system](https://www.truenas.com/docs/truecommand/tcgettingstarted/connectingtruenas/).
2. [Add their TrueNAS system](https://www.truenas.com/docs/truecommand/tcgettingstarted/connectingtruenas/).
3. Create and schedule the [configuration file backup](https://www.truenas.com/docs/truecommand/userguide/systemmanagement/truenasconfigmanage/#create-a-config-backup).

Users can manually back up the SCALE config file by downloading and saving the file to a location that is automatically backed up.