From 2ec04f7e30324417bdc75b94c1496121daceb5d4 Mon Sep 17 00:00:00 2001 From: Chris Mulligan Date: Sun, 8 Jun 2025 10:15:17 -0400 Subject: [PATCH] Clarified README about delgated admin Addresses issue #99 by clarifying user account requirements --- README.rst | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index c40c26e..348f6df 100644 --- a/README.rst +++ b/README.rst @@ -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 ==============