Skip to content

Clarified README about delgated admin #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 8, 2025
Merged

Clarified README about delgated admin #101

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,21 @@ Usage Example
pprint(qnap.get_volumes())
pprint(qnap.get_bandwidth())

**Note:** The user you connect with must be in the admin group. It doesn't necessarily
need to be THE "administrator" account, but you do need to use some account in the
administrators group. MFA must also be disabled for that user for this library to work.
Account
=======
The account you connect with must have system monitoring permissions. The simplest
option is to put it in the admin group; it doesn't necessarily
need to be THE "administrator" account, but you can use some account in the
administrators group.

Alternatively you can configure a normal account and enable Delegated Administration
in control panel, and activate "System Monitoring."

Once the account is created, and/or you upgrade to a newer of like QTS 5,
blso be sure to log into your NAS and complete any agreements, warnings, wizards, etc.
that may prevent this library from using the QNAP API.

MFA/2FA must also be disabled for that user for this library to work.

Device Support
==============
Expand Down
Loading