Skip to content

Commit

Permalink
TOTP: Clarified README and --help
Browse files Browse the repository at this point in the history
  • Loading branch information
Romern committed Jul 6, 2024
1 parent 2302dd8 commit 4c399c7
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,9 @@ options:
storing and retrieving account credentials
--user USER set your RWTH Single Sign-On username
--password PASSWORD set your RWTH Single Sign-On password
--totp TOTP set your RWTH Single Sign-On TOTP provider
--totp TOTP set your RWTH Single Sign-On TOTP provider's serial
number (see
https://idm.rwth-aachen.de/selfservice/MFATokenManager)
--config CONFIG set your configuration file
--cookiefile COOKIEFILE
set the location of a cookie file
Expand Down Expand Up @@ -136,7 +138,7 @@ configuration does:
"only_sync_semester": [], // Only the specified semesters (e.g. ["23ss", "22ws"]) will be synced. `selected_courses` overrides this option.
"user": "", // RWTH SSO username
"password": "", // RWTH SSO password
"totp": "", // RWTH SSO TOTP "Serial Number", format: TOTP0000000A
"totp": "", // RWTH SSO TOTP "Serial Number", format: TOTP0000000A, see https://idm.rwth-aachen.de/selfservice/MFATokenManager
"basedir": "./", // The base directory where all your files will be synced to
"cookie_file": "./session", // The location of the session/cookie file, which can be used instead of a password.
"use_secret_service": false, // Use the Secret Service integration (see README), instead of a password or a cookie file.
Expand Down
2 changes: 1 addition & 1 deletion syncmymoodle/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -1128,7 +1128,7 @@ def main():
"--password", default=None, help="set your RWTH Single Sign-On password"
)
parser.add_argument(
"--totp", default=None, help="set your RWTH Single Sign-On TOTP provider"
"--totp", default=None, help="set your RWTH Single Sign-On TOTP provider's serial number (see https://idm.rwth-aachen.de/selfservice/MFATokenManager)"
)
parser.add_argument("--config", default=None, help="set your configuration file")
parser.add_argument(
Expand Down

0 comments on commit 4c399c7

Please sign in to comment.