Project

General

Profile

Bug #74991

Docs for "Microsoft Account" checkbox in user configuration are misleading / could be clearer

Added by Sean McBride over 2 years ago. Updated over 2 years ago.

Status:
Closed
Priority:
No priority
Assignee:
Aaron St. John
Category:
Documentation
Target version:
Severity:
New
Reason for Closing:
Reason for Blocked:
Needs QA:
Yes
Needs Doc:
No
Needs Merging:
Yes
Needs Automation:
No
Support Suite Ticket:
n/a
Hardware Configuration:
ChangeLog Required:
No

Description

The docs here:
https://www.ixsystems.com/documentation/freenas/11.2/accounts.html#users

In "Table 5.2.1 User Account Configuration" there's a row:

Microsoft Account / checkbox / Set if the user is connecting from a Windows 8 or higher system

This is a bit misleading. It implies that that checkbox must be set if the user uses Win8+. But as best as I can tell from the forums, it's only necessary if you use Microsoft's 'cloud' accounts as apposed to local computer accounts. The UI's help text is a bit more elaborated, but could be clarified too.

History

#1 Updated by Dru Lavigne over 2 years ago

  • Assignee changed from Release Council to Warren Block
  • Target version changed from Backlog to 11.2-U3

#2 Updated by Warren Block over 2 years ago

  • Assignee changed from Warren Block to Aaron St. John

#3 Updated by Dru Lavigne over 2 years ago

  • Target version changed from 11.2-U3 to 11.2-U4

#4 Updated by Aaron St. John over 2 years ago

  • Status changed from Unscreened to In Progress
  • Needs Doc changed from Yes to No

I've spoke with Andrew. Here is what he said:

"

#
# SMB.CONF(5)           The configuration file for the Samba suite
#
<%
    """ 
    The username map is required for proper support of microsoft accounts
    that are also email addresses. See SMB.CONF(5) for more details.
    """ 
    users = middleware.call_sync('user.query', [
        ('microsoft_account', '=', True),
        ('email', '!=', None),
        ('email', '!=', ''),
    ])

%>

% if users:
% for user in users:
    ${user['username']} = ${user['email']}
% endfor
% endif

It creates a mapping between the user's configured email address and the username. So if the username is 'bob' and email address is , the user can authenticate by passing bob or as the username.

When a person uses a cloud account for logging into their PC, their local PC username will be something like , and this will be the first thing that windows attempts to use when authenticating to an SMB server.
So this is a convenience feature to allow users to auto-magically log into their SMB server without having to store separate credentials if their cloud account credentials are identical to the ones on the FreeNAS server."

He also mentioned that the setting does not just pertain to using a Microsoft cloud service. It does in fact need to be checked when connecting from a Windows machine as well (SMB share).

I've updated the guide: master PR: https://github.com/freenas/freenas-docs/pull/791
angulargui PR: https://github.com/freenas/freenas-docs/pull/792
11.2-angular PR: https://github.com/freenas/freenas-docs/pull/793
11.2-legacy PR: https://github.com/freenas/freenas-docs/pull/795

#5 Updated by Jaron Parsons over 2 years ago

  • Status changed from In Progress to Closed

Also available in: Atom PDF