Skip to content

Commit

Permalink
Merge branch 'master' into NAS-133538-fromemail-must-be-specified-whe…
Browse files Browse the repository at this point in the history
…n-setting-up-o-auth-for-outlook-mail
  • Loading branch information
tonyriv3 authored Jan 24, 2025
2 parents 67d4d85 + c4764f6 commit 21b7f09
Show file tree
Hide file tree
Showing 37 changed files with 743 additions and 382 deletions.
31 changes: 27 additions & 4 deletions content/SCALE/SCALETutorials/Credentials/ManageLocalUsersSCALE.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ TrueNAS hides all built-in users (except root) by default. Click the toggle **Sh

TrueNAS 24.04 or newer supports administrator privileges for role-based administrator accounts.
Users can create new administrator accounts with limited privileges based on their needs.
Predefined administrator roles are read only, share admin, and the default full access local administrator account.
Predefined administrator roles are read-only, share admin, and the default full access local administrator account.
See [Using Administrator Logins]({{< relref "adminroles.md" >}}) for more information.

{{< include file="/static/includes/AddAdminGroup.md" >}}
Expand Down Expand Up @@ -115,7 +115,7 @@ Do *not* paste the private key.

Always keep a backup of an SSH public key if you are using one.

As of TrueNAS 24.04, the **Shell** setting defaults to **nologin** for read only and sharing administrators, which means they cannot access the **Shell** screen.
As of TrueNAS 24.04, the **Shell** setting defaults to **nologin** for read-only and sharing administrators, which means they cannot access the **Shell** screen.

Select the [shell]({{< relref "LocalUsersScreensSCALE.md" >}}) option for the admin user from the **Shell** dropdown list.
Options are **nologin**, **TrueNAS CLI**, **TrueNAS Console**, **sh**, **bash**, **rbash**, **dash**, **tmux**, and **zsh**.
Expand All @@ -136,12 +136,35 @@ While on the user configuration screen:

Enter the path to the new dataset for home directories in **Home Directory**. For example, change **/var/empty/** to the path to the new dataset */tank/homedirs*.

Next select **Create Home Directory**, and select the level of permissions you want to apply. We recommend leaving the default selections, **Read/Write/Execute** selected for the user home directory.
Next, select **Create Home Directory**, and select the level of permissions you want to apply. We recommend leaving the default selections, **Read/Write/Execute** selected for the user home directory.

Click **Save**. TrueNAS creates the new home directory for the user.
Click **Save**. TrueNAS creates a new home directory for the user.

## Editing User Accounts

To edit an existing user account, go to **Credentials > Users**.
Click anywhere on the user row to expand the user entry, then click **Edit** to open the **Edit User** configuration screen.
See [Local User Screens]({{< relref "LocalUsersScreensScale.md" >}}) for details on all settings.

## Utilizing API Keys Feature

{{< trueimage src="/images/SCALE/Credentials/UsersAPIKeysButton.png" alt="Users API Keys Option" id="Users API Keys Option" >}}

To view API keys that are linked to different user accounts, you can visit **Credentials > Users** and click the **API Keys** button on the right side of the screen.

{{< trueimage src="/images/SCALE/Credentials/UsersAPIKeysMenu.png" alt="Users API Keys Menu" id="Users API Keys Menu" >}}

The **API Keys** selection takes users to the **Users API Keys** page, which provides a table of all API keys linked to user accounts on your TrueNAS. Information in this table includes the **Name**, **Username**, **Local** status, **Revoked** status, **Created Date**, and **Expires** status.

{{< truetable >}}
| Value | Description |
|------------------|-----------------|
| Name | The name given to the API key when it was created. |
| Username | The username of the TrueNAS user associated with the API key. |
| Local | Indication of whether the API key is for a local TrueNAS user account. |
| Revoked | Indication of whether the API key has been revoked and is no longer valid. |
| Created Date | The date and time when the API key was created. |
| Expires | The expiration date of the API key. |
{{< /truetable >}}

You can edit or delete your API keys in the **User API Keys** screen. Click <i class="material-icons" aria-hidden="true" title="Edit">edit</i> **Edit** to open the **Edit API Key** screen. Click <i class="material-icons" aria-hidden="true" title="Delete">delete</i> **Delete** to delete an API key.
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,11 @@ By default built-in users, except for **root**, are hidden until you make them v

{{< trueimage src="/images/SCALE/Credentials/AllUsersScreenSCALE.png" alt="Local User non-Built-in Accounts" id="Local User non-Built-in Accounts" >}}

**Toggle Build-In Users** displays either the **Show Built-In Users** or **Hide Built-in Users** dialogs based on the current **Users** list view.
If hidden, the **Show Built-in Users** dialog opens. Click **Show** to display the list of users.
The **Show Built-in Users** toggle shows or hides built-in users. Enable it to display the list of built-in users.

{{< trueimage src="/images/SCALE/Credentials/AllUsersScreenBuiltInSCALE.png" alt="Local User Built-in Accounts" id="Local User Built-in Accounts" >}}

To hide built-in users, click **Toggle Built-In Users** again to open the **Hide Built-in Users** dialog. Click **Hide** to display only non-built-in users again.
To hide built-in users, disable **Show Built-in Users**.

The **Users** screen shows the pre-defined administrator role assigned to the user.

Expand Down Expand Up @@ -137,3 +136,28 @@ You can set a specific [shell]({{< relref "UseScaleShell.md" >}}) for the user f
| **TrueNAS Console** |Use to open **Shell** in the Console Setup menu. Eliminates the need to enter `menu`. Displays the console setup menu options. This option provides the user with access to the Linux and TrueNAS CLI shells. |
{{< /truetable >}}
{{< /expand >}}

## Utilizing API Keys Feature

{{< trueimage src="/images/SCALE/Credentials/UsersAPIKeysButton.png" alt="Users API Keys Option" id="Users API Keys Option" >}}

To view API keys that are linked to different user accounts, visit **Credentials > Users** and click the **API Keys** button on the right side of the screen.

{{< trueimage src="/images/SCALE/Credentials/UsersAPIKeysMenu.png" alt="Users API Keys Menu" id="Users API Keys Menu" >}}

The **API Keys** selection takes users to the **Users API Keys** page, which provides a table of all API keys linked to user accounts on your TrueNAS.

{{< truetable >}}
| Value | Description |
|------------------|-----------------|
| Name | The name given to the API key when it was created. |
| Username | The username of the TrueNAS user associated with the API key. |
| Local | Indication of whether the API key is for a local TrueNAS user account. |
| Revoked | Indication of whether the API key has been revoked and is no longer valid. |
| Created Date | The date and time when the API key was created. |
| Expires | The expiration date of the API key. |
{{< /truetable >}}

* Click <i class="material-icons" aria-hidden="true" title="Edit">edit</i> **Edit** to edit an API key
* Click <i class="material-icons" aria-hidden="true" title="Delete">delete</i> **Delete** to delete an API key

Loading

0 comments on commit 21b7f09

Please sign in to comment.