mirror of https://github.com/FliegendeWurst/KIT-ILIAS-downloader.git synced 2024-08-28 04:04:18 +00:00

Downloader for https://ilias.studium.kit.edu/

Go to file

FliegendeWurst 92f93117dd Update CHANGELOG.md		2021-06-14 16:24:47 +02:00
.github/workflows	CI: remove useless stage	2021-05-28 15:33:31 +02:00
src	Add doctype and base href to forum post HTML	2021-06-11 15:20:47 +02:00
.gitignore	Initial commit	2020-04-21 22:41:28 +02:00
build.sh	build script: require up to date lock file	2021-06-04 10:13:33 +02:00
Cargo.lock	Version 0.2.23	2021-06-14 16:06:21 +02:00
Cargo.toml	Version 0.2.23	2021-06-14 16:06:21 +02:00
CHANGELOG.md	Update CHANGELOG.md	2021-06-14 16:24:47 +02:00
LICENSE	Update dependencies and license	2021-05-28 13:21:49 +02:00
README.md	Version 0.2.23	2021-06-14 16:06:21 +02:00
rustfmt.toml	Split downloading logic into modules	2021-06-02 11:13:13 +02:00
shell.nix	Basic shell.nix	2021-05-13 13:29:18 +02:00

README.md

KIT-ILIAS-downloader

Download content from ILIAS. That includes:

files
exercise sheets and solutions
Opencast lectures
forum posts

Installation

Windows/Linux users: go to the releases and download the executable for your operating system.
macOS users: Install Rust and compile from source:

$ cargo install --all-features --git 'https://github.com/FliegendeWurst/KIT-ILIAS-downloader' --branch stable

Usage

First, open a terminal. Navigate to the directory that contains the downloaded binary.

Then execute the program (use -o <directory> to specify the download directory):

$ KIT-ILIAS-downloader -o ./ILIAS

By default, only content on your personal desktop will be downloaded.
Use the --sync-url option to download a specific page and its sub-pages: (the URL should be copied from an ILIAS link, not the browser URL bar)

$ KIT-ILIAS-downloader -o ./ILIAS/WS2021-HM1 --sync-url 'https://ilias.studium.kit.edu/ilias.php?ref_id=1276968&cmdClass=ilrepositorygui&cmdNode=uk&baseClass=ilRepositoryGUI'

Options

$ KIT-ILIAS-downloader --help
KIT-ILIAS-downloader 0.2.23

USAGE:
    KIT-ILIAS-downloader [FLAGS] [OPTIONS] --output <output>

FLAGS:
        --check-videos    Re-check OpenCast lectures (slow)
        --content-tree    Use content tree (experimental)
    -f                    Re-download already present files
    -t, --forum           Download forum content
    -h, --help            Prints help information
        --keep-session    Attempt to re-use session cookies
        --keyring         Use the system keyring
    -n, --no-videos       Do not download Opencast videos
    -s, --skip-files      Do not download files
    -V, --version         Prints version information
    -v                    Verbose logging

OPTIONS:
    -j, --jobs <jobs>            Parallel download jobs [default: 1]
    -o, --output <output>        Output directory
    -P, --password <password>    KIT account password
    -p, --proxy <proxy>          Proxy, e.g. socks5h://127.0.0.1:1080
        --rate <rate>            Requests per minute [default: 8]
        --sync-url <sync-url>    ILIAS page to download
    -U, --username <username>    KIT account username

.iliasignore

.gitignore syntax can be used in a .iliasignore file: (located in the output folder)

# example 1: only download a single course
/*/
!/InsertCourseHere/
# example 2: only download files related to one tutorial
/Course/Tutorien/*/
!/Course/Tutorien/Tut* 3/

Credentials

You can use the --user and --keyring options to get/store the password using the system password store.
If you use Linux, you'll have to compile from source to be able to use this option.

$ KIT-ILIAS-downloader -U uabcd --keyring [...]

You can also save your username and password in a .iliaslogin file: (located in the output folder)

username
password