Skip to content

Commit 7001f6f

Browse files
authored
Merge pull request #2906 from truenas/PD-1284-Update-Content-on-Toolbar-Settings-Menu
Pd 1284 update content on toolbar settings menu
2 parents ce5ae9b + 85f2ec1 commit 7001f6f

File tree

5 files changed

+37
-19
lines changed

5 files changed

+37
-19
lines changed

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

+19-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Managing Global 2FA (Two-Factor Authentication)"
3-
description: "Provides information on SCALE global two-factor authentication, setting it up, and logging in with it enabled."
3+
description: "Provides information on setting up and managing global two-factor authentication, and logging in with it enabled."
44
weight: 70
55
alias:
66
- /scale/scaletutorials/credentials/2fascale
@@ -16,7 +16,7 @@ keywords:
1616

1717
Global Two-factor authentication (2FA) is great for increasing security.
1818

19-
TrueNAS offers global 2FA to ensure that entities cannot use a compromised administrator root password to access the administrator interface.
19+
TrueNAS offers global 2FA to ensure that entities cannot use a compromised administrator or root password to access the administrator interface.
2020

2121
{{< include file="/static/includes/AdvancedSettingsWarningSCALE.md" >}}
2222

@@ -67,16 +67,26 @@ Before you begin, download Google Authenticator to your mobile device.
6767

6868
TrueNAS takes you to the **Two-Factor Authentication** screen to finish 2FA setup.
6969

70-
{{< trueimage src="/images/SCALE/SystemSettings/2FAScreenEnabled.png" alt="2FAScreenEnabled" id="2FA Screen with Enabled Message" >}}
70+
You can also access the two-factor authentication settings for the currently logged-in user from the **Settings** option on the top toolbar.
71+
Click on the **Settings** icon, then select **Two-Factor Authentication** to open the **User Two-Factor Authentication Actions** screen.
72+
73+
{{< trueimage src="/images/SCALE/SystemSettings/UserTwoFactorAuthenticationActionsScreen.png" alt="User Two-Factor Authentication Actions Screen" id="User Two-Factor Authentication Actions Screen" >}}
74+
75+
Click **Configure 2FA Secret** to view the QR code.
76+
77+
{{< hint type="info">}}
78+
You can configure two-factor authentication and get the QR code for an authenticator app for the logged-in user at any time, but you must configure global two-factor authentication to enable it.
79+
{{< /hint >}}
7180

7281
When using Google Authenticator, set **Interval** to **30** or the authenticator code might not function when logging in.
7382

74-
3. Click **Show QR** and scan the QR code using Google Authenticator.
83+
3. Click **Configure 2FA Secret** to open the **User Two-Factor Authentication Actions** screen where you scan the QR code using Google Authenticator.
84+
To generate a new QR code click **Renew 2FA Secret**.
7585

7686
After scanning the code click **CLOSE** to close the dialog on the **Two-Factor Authentication** screen.
7787

7888
Accounts that are already configured with individual 2FA are not prompted for 2FA login codes until **Global 2FA** is enabled.
79-
When **Global 2FA** is enabled, user accounts that have not configured 2FA settings yet are shown the **Two-Factor Authentication** screen on their next login to configure and enable 2FA authentication for that account.
89+
When **Global 2FA** is enabled, user accounts without 2FA settings configured see the **Two-Factor Authentication** screen on their next login to configure and enable 2FA authentication for that account.
8090

8191
### Disabling or Bypassing 2FA
8292
Go to **System > Advanced**, scroll down to the **Global Two Factor Authentication** widget, and click **Config**. Clear the **Enable Two-Factor Authentication Globally** checkbox and click **Save**.
@@ -85,15 +95,16 @@ Go to **System > Advanced**, scroll down to the **Global Two Factor Authenticati
8595
If you want to enable 2FA again, go to **System > Advanced**, scroll down to the **Global Two Factor Authentication** widget, and click **Config**.
8696

8797
Check **Enable Two Factor Authentication Globally**, then click **Save**.
88-
To change the system-generated **Secret**, go to **Credentials > 2FA** and click **Renew 2FA Secret**.
98+
To change the system-generated **Secret**, click on the **Settings** icon on the top toolbar and select **Two-Factor Authentication**.
99+
Click **Renew 2FA Secret**.
89100

90101
## Using 2FA to Log in to TrueNAS
91-
Enabling 2FA changes the login process for both the TrueNAS web interface and SSH logins.
102+
Enabling 2FA changes the log in process for both the TrueNAS web interface and SSH logins.
92103

93104
### Logging In Using the Web Interface
94105
The login screen adds another field for the randomized authenticator code. If this field is not immediately visible, try refreshing the browser.
95106

96-
Enter the code from the mobile device (without the space) in the login window and use the root username and password.
107+
Enter the code from the mobile device (without the space) in the login window and use the admin username and password.
97108

98109
{{< trueimage src="/images/SCALE/Login/2faSigninSplashScreen.png" alt="2FA Signin Splash Screen" id="2FA Splash Screen" >}}
99110

content/SCALE/SCALEUIReference/Credentials/2FAScreenSCALE.md content/SCALE/SCALEUIReference/TopToolbar/Settings/2FAScreenSCALE.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@ tags:
1313
Two-factor authentication is time-based and requires a correct system time setting.
1414
{{< /hint >}}
1515

16-
The **Two-Factor Authentication** screen has buttons to manage two-factor authentication (2FA) credentials, and it displays a different message depending on if you have 2FA enabled or disabled.
16+
The **Two-Factor Authentication** screen, accessed from the **Settings** menu on the top toolbar, allows managing user-level two-factor authentication (2FA) credentials. It shows a different message if 2FA enabled than when not configured or disabled.
1717

18-
To configure 2FA settings go to the [**Advanced**]({{< relref "AdvancedSettingsScreen.md" >}}) settings screen. For more information, see the [Managing Global 2FA]({{< relref "ManageGlobal2FASCALE.md" >}}) tutorial.
18+
To configure 2FA settings go to the [**Advanced**]({{< relref "AdvancedSettingsScreen.md" >}}) settings screen.
19+
For more information, see the [Managing Global 2FA]({{< relref "ManageGlobal2FASCALE.md" >}}) tutorial.
1920

2021
{{< trueimage src="/images/SCALE/Credentials/2FAScreenDisabled.png" alt="2FAScreenDisabled" id="2FA Screen with Disabled Message" >}}
2122

content/SCALE/SCALEUIReference/TopToolbar/_index.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ The top toolbar icon buttons provide access to the iXsystems website, displays t
3333
| <span class="material-icons">info</span> | Directory Services status | Displays a dialog with the status of Active Directory and LDAP directory servers configured on the system. |
3434
| <span class="material-icons">assignment</span> | Jobs | Displays the Jobs dialog. Click the **History** button to display the **Tasks** screen with a list of **All**, **Active** or **Failed** tasks or processes. |
3535
| <span class="material-icons">notifications</span> | Alerts | Displays a list of system alerts and a dropdown list with the alert options **Alert Settings** and **Email**. |
36-
| <span class="material-icons">account_circle</span> | Settings | Displays a dropdown list of setting options **Change Password**, **Two-Factor Authentication**, **API Keys**, **Guide** and **About**. |
37-
| <span class="material-icons">power_settings_new</span> | Power options | Displays the power related options **Log Out**, **Restart** or **Shut Down**. |
36+
| <span class="material-icons">account_circle</span> | Settings | Displays a dropdown list of setting options **Change Password**, **Two-Factor Authentication**, **API Keys**, **Guide**, **About**, and **Log Out**. |
37+
| <span class="material-icons">power_settings_new</span> | Power options | Displays the power related options **Restart** or **Shut Down**. |
3838
{{< /truetable >}}
3939

4040
### Search UI
@@ -82,9 +82,11 @@ The <span class="material-icons-outlined">info</span> **About** icon button disp
8282

8383
{{< trueimage src="/images/SCALE/Dashboard/AboutWindow.png" alt="About Window" id="About Window" >}}
8484

85+
The <span class="iconify" data-icon="bx:exit">info</span> **Log Out** icon button logs the currently logged in user out of the SCALE UI.
86+
8587
### Power
8688

87-
The **Power** <span class="material-icons">power_settings_new</span> button provides three options that let the user log out of the web UI, restart, or shut down their TrueNAS system.
89+
The **Power** <span class="material-icons">power_settings_new</span> button provides two options that let the user restart or shut down their TrueNAS system.
8890

8991
<div class="noprint">
9092

Loading

static/includes/TopToolbar.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Users can also use the iXsystems home page to access their customer portal and t
4141
{{< /expand >}}
4242

4343
{{< expand "Settings" "v" >}}
44-
The **Settings** <span class="material-icons">account_circle</span> icon opens a dropdown list of options for passwords, API keys, and TrueNAS information.
44+
The **Settings** <span class="material-icons">account_circle</span> icon opens a dropdown list of options to change passwords, set up user two-factor authentication, create and manage API keys, access the TrueNAS API guide, see information on the system, and to logout of the SCALE UI.
4545
{{< expand "Change Password" >}}
4646
{{< include file="/static/includes/ChangeLoggedInUserPassword.md" >}}
4747
{{< /expand >}}
@@ -64,15 +64,19 @@ Click on **About** <span class="iconify" data-icon="ant-design:info-circle-outli
6464

6565
{{< trueimage src="/images/SCALE/Dashboard/TrueNASAboutScreenSCALE.png" alt="About Window" id="About Window" >}}
6666

67+
{{< /expand >}}
68+
69+
{{< expand "Log Out" "v" >}}
70+
**Log Out** logs the current user out of the SCALE UI, but does not power off the system.
71+
The **Read-Only Admin** and **Sharing Admin** roles only have access to the **Log Out** option.
6772
{{< /expand >}}
6873
{{< /expand >}}
6974

7075
{{< expand "Power Options" "v" >}}
7176
Click the **Power** <span class="material-icons">power_settings_new</span> button to open the dropdown list of power options.
72-
Options are **Log Out** which logs you out of the SCALE UI but does not power off the system, **Restart** which logs you out of the SCALE UI and restarts the server, or **Shut Down** which logs you out of the SCALE UI and powers off the system as though you pressed the power button on the physical server.
77+
Options **Restart** which logs you out of the SCALE UI and restarts the server or **Shut Down** which logs you out of the SCALE UI and powers off the system as though you pressed the power button on the physical server.
7378

74-
With the implementation of administrator roles, the power options displayed could be locked based on the level of privileges for the administrator role.
75-
The local administrator has access to all three power options.
76-
The **Read-Only** and **Sharing Manager** admin roles only have access to the **Log Out** option.
77-
The other power options display with a lock icon indicating the function is not permitted.
79+
With the implementation of administrator roles, the power options are locked based on the level of privileges for the administrator role.
80+
The full administrator has access to both power options but readonly and sharing admin roles do not.
81+
The power options that show a lock icon indicate the function is not permitted.
7882
{{< /expand >}}

0 commit comments

Comments
 (0)