From 7797301288392b886a51ce0acd3b7d35e64422fe Mon Sep 17 00:00:00 2001 From: PinieP <59698589+PinieP@users.noreply.github.com> Date: Sat, 2 Nov 2024 15:55:00 +0100 Subject: [PATCH] Update docs and changelog --- CHANGELOG.md | 1 + CONFIG.md | 20 +++++++++++++------- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 12cda26..8024bba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,6 +25,7 @@ ambiguous situations. ### Added - Support for MOB videos in page descriptions - Clickable links in the report to directly open new/modified/not-deleted files +- Support for non KIT shibboleth login ### Changed - Remove videos from description pages diff --git a/CONFIG.md b/CONFIG.md index a52506d..aeb865a 100644 --- a/CONFIG.md +++ b/CONFIG.md @@ -163,12 +163,13 @@ out of the box for the corresponding universities: [ilias-dl]: https://github.com/V3lop5/ilias-downloader/blob/main/configs "ilias-downloader configs" -| University | `base_url` | `client_id` | -|---------------|--------------------------------------|---------------| -| FH Aachen | https://www.ili.fh-aachen.de | elearning | -| Uni Köln | https://www.ilias.uni-koeln.de/ilias | uk | -| Uni Konstanz | https://ilias.uni-konstanz.de | ILIASKONSTANZ | -| Uni Stuttgart | https://ilias3.uni-stuttgart.de | Uni_Stuttgart | +| University | `base_url` | `login_type` | `client_id` | +|---------------|-----------------------------------------|--------------|---------------| +| FH Aachen | https://www.ili.fh-aachen.de | local | elearning | +| Uni Köln | https://www.ilias.uni-koeln.de/ilias | local | uk | +| Uni Konstanz | https://ilias.uni-konstanz.de | local | ILIASKONSTANZ | +| Uni Stuttgart | https://ilias3.uni-stuttgart.de | local | Uni_Stuttgart | +| Uni Tübingen | https://ovidius.uni-tuebingen.de/ilias3 | shibboleth | None | If your university isn't listed, try navigating to your instance's login page. Assuming no custom login service is used, the URL will look something like this: @@ -180,7 +181,10 @@ Assuming no custom login service is used, the URL will look something like this: If the values work, feel free to submit a PR and add them to the table above. - `base_url`: The URL where the ILIAS instance is located. (Required) -- `client_id`: An ID used for authentication. (Required) +- `login_type`: How you authenticate. (Required) + - `local`: Use `client_id` for authentication. + - `shibboleth`: Use shibboleth for authentication. +- `client_id`: An ID used for `local` authentication. - `target`: The ILIAS element to crawl. (Required) - `desktop`: Crawl your personal desktop / dashboard - ``: Crawl the course with the given id @@ -191,6 +195,8 @@ If the values work, feel free to submit a PR and add them to the table above. and duplication warnings if you are a member of an ILIAS group. The `desktop` target is generally preferable. - `auth`: Name of auth section to use for login. (Required) +- `tfa_auth`: Name of auth section to use for two-factor authentication. Only + uses the auth section's password. (Default: Anonymous `tfa` authenticator) - `links`: How to represent external links. (Default: `fancy`) - `ignore`: Don't download links. - `plaintext`: A text file containing only the URL.