Garmelon/PFERD
1
0
Fork 0
mirror of https://github.com/Garmelon/PFERD.git synced 2026-04-12 23:45:05 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docs and changelog

Browse source
This commit is contained in:
PinieP 2024-11-02 15:55:00 +01:00 • committed by I-Al-Istannen
parent 38cd1888c2
commit 7797301288
2 changed files with 14 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -25,6 +25,7 @@ ambiguous situations.
### Added ### Added
- Support for MOB videos in page descriptions - Support for MOB videos in page descriptions
- Clickable links in the report to directly open new/modified/not-deleted files - Clickable links in the report to directly open new/modified/not-deleted files
- Support for non KIT shibboleth login
### Changed ### Changed
- Remove videos from description pages - Remove videos from description pages

20
CONFIG.md
View file

@ -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" [ilias-dl]: https://github.com/V3lop5/ilias-downloader/blob/main/configs "ilias-downloader configs"
| University | `base_url` | `client_id` | | University | `base_url` | `login_type` | `client_id` |
|---------------|--------------------------------------|---------------| |---------------|-----------------------------------------|--------------|---------------|
| FH Aachen | https://www.ili.fh-aachen.de | elearning | | FH Aachen | https://www.ili.fh-aachen.de | local | elearning |
| Uni Köln | https://www.ilias.uni-koeln.de/ilias | uk | | Uni Köln | https://www.ilias.uni-koeln.de/ilias | local | uk |
| Uni Konstanz | https://ilias.uni-konstanz.de | ILIASKONSTANZ | | Uni Konstanz | https://ilias.uni-konstanz.de | local | ILIASKONSTANZ |
| Uni Stuttgart | https://ilias3.uni-stuttgart.de | Uni_Stuttgart | | 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. 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: 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. 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) - `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) - `target`: The ILIAS element to crawl. (Required)
- `desktop`: Crawl your personal desktop / dashboard - `desktop`: Crawl your personal desktop / dashboard
- `<course id>`: Crawl the course with the given id - `<course id>`: 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 and duplication warnings if you are a member of an ILIAS group. The
`desktop` target is generally preferable. `desktop` target is generally preferable.
- `auth`: Name of auth section to use for login. (Required) - `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`) - `links`: How to represent external links. (Default: `fancy`)
- `ignore`: Don't download links. - `ignore`: Don't download links.
- `plaintext`: A text file containing only the URL. - `plaintext`: A text file containing only the URL.