mirrors/pferd
1
0
Fork 0
mirror of https://github.com/Garmelon/PFERD.git synced 2025-07-12 14:12:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document course overview downloading in config.md

Browse Source
This commit is contained in:
I-Al-Istannen
2024-07-31 22:02:43 +02:00
parent c897d9e2f5
commit 19beb8f07b
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CONFIG.md
View File

@ -182,10 +182,14 @@ 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) - `client_id`: An ID used for authentication. (Required)
- `target`: The ILIAS element to crawl. (Required) - `target`: The ILIAS element to crawl. (Required)
- `desktop`: Crawl your personal desktop - `desktop`: Crawl your personal desktop / dashboard
- `<course id>`: Crawl the course with the given id - `<course id>`: Crawl the course with the given id
- `<url>`: Crawl a given element by URL (preferably the permanent URL linked - `<url>`: Crawl a given element by URL (preferably the permanent URL linked
at the bottom of its ILIAS page) at the bottom of its ILIAS page).
This also supports the "My Courses" overview page to download *all*
courses. Note that this might produce confusing local directory layouts
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) - `auth`: Name of auth section to use for login. (Required)
- `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.