KIT-ILIAS-downloader/README.md

# KIT-ILIAS-downloader

Download content from ILIAS. That includes:

* files
* exercise sheets and solutions
* Opencast lectures
* forum posts

## Installation

Go to the [releases](../../releases) and get the executable for your operating system. Or compile from source:
```
$ git clone https://github.com/FliegendeWurst/KIT-ILIAS-downloader
$ cd KIT-ILIAS-downloader
$ cargo install --path .
```

## Usage

Use `-o <directory>` to specify the download directory:

```
$ KIT-ILIAS-downloader -o ./ILIAS
```

Only content on your [personal desktop](https://ilias.studium.kit.edu/ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToSelectedItems) will be downloaded.

```
$ KIT-ILIAS-downloader --help
KIT-ILIAS-downloader 0.2.14

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

FLAGS:
        --content-tree    Use content tree (slow but thorough)
    -f                    Re-download already present files
    -t, --forum           Download forum content
    -h, --help            Prints help information
    -n, --no-videos       Do not download Opencast videos
    -s, --skip-files      Do not download files
    -V, --version         Prints version information
    -v                    Verbose logging (print objects downloaded)

OPTIONS:
    -j, --jobs <jobs>        Parallel download jobs [default: 1]
    -o, --output <output>    Output directory
    -p, --proxy <proxy>      Proxy, e.g. socks5h://127.0.0.1:1080 [default: ""]
```

### .iliasignore

.gitignore syntax can be used in a `.iliasignore` file: (located in the download folder)
```ignore
# example 1: only download a single course
/*/
!/InsertCourseHere/
# example 2: only download files related to one tutorial
/Course/Tutorien/*/
!/Course/Tutorien/Tut* 3/
```

### .iliaslogin

If you don't want to enter your credentials every time you run the program, you can instead save your username and password in a file (`.iliaslogin`):

```
username
password
```

## Similar programs

- https://github.com/brantsch/kit-ilias-fuse/
- https://github.com/Garmelon/PFERD/
Initial commit 2020-04-21 20:41:28 +00:00			`# KIT-ILIAS-downloader`

			`Download content from ILIAS. That includes:`

Simplify installation instructions 2021-04-08 17:10:38 +00:00			`* files`
			`* exercise sheets and solutions`
Initial commit 2020-04-21 20:41:28 +00:00			`* Opencast lectures`
Correct statement in readme 2021-04-14 15:24:39 +00:00			`* forum posts`
Initial commit 2020-04-21 20:41:28 +00:00
			`## Installation`

Correct statement in readme 2021-04-14 15:24:39 +00:00			`Go to the [releases](../../releases) and get the executable for your operating system. Or compile from source:`
Update readme: .iliasignore usage 2020-04-25 08:38:49 +00:00			```
Initial commit 2020-04-21 20:41:28 +00:00			`$ git clone https://github.com/FliegendeWurst/KIT-ILIAS-downloader`
			`$ cd KIT-ILIAS-downloader`
Simplify installation instructions 2021-04-08 17:10:38 +00:00			`$ cargo install --path .`
Initial commit 2020-04-21 20:41:28 +00:00			```

			`## Usage`

Correct statement in readme 2021-04-14 15:24:39 +00:00			Use `-o <directory>` to specify the download directory:

			```
			`$ KIT-ILIAS-downloader -o ./ILIAS`
			```
Update readme: usage + credits 2020-04-22 12:11:42 +00:00
Improve readme 2020-05-11 08:13:57 +00:00			`Only content on your [personal desktop](https://ilias.studium.kit.edu/ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToSelectedItems) will be downloaded.`

Update readme: .iliasignore usage 2020-04-25 08:38:49 +00:00			```
Parse command-line arguments 2020-04-21 21:03:30 +00:00			`$ KIT-ILIAS-downloader --help`
Simplify installation instructions 2021-04-08 17:10:38 +00:00			`KIT-ILIAS-downloader 0.2.14`
Parse command-line arguments 2020-04-21 21:03:30 +00:00
			`USAGE:`
Version 0.2 2020-04-22 10:21:58 +00:00			`KIT-ILIAS-downloader [FLAGS] [OPTIONS] --output <output>`
Parse command-line arguments 2020-04-21 21:03:30 +00:00
			`FLAGS:`
Version 0.2.2 2020-04-24 09:13:31 +00:00			`--content-tree Use content tree (slow but thorough)`
			`-f Re-download already present files`
			`-t, --forum Download forum content`
			`-h, --help Prints help information`
			`-n, --no-videos Do not download Opencast videos`
			`-s, --skip-files Do not download files`
			`-V, --version Prints version information`
			`-v Verbose logging (print objects downloaded)`
Parse command-line arguments 2020-04-21 21:03:30 +00:00
			`OPTIONS:`
Version 0.2 2020-04-22 10:21:58 +00:00			`-j, --jobs <jobs> Parallel download jobs [default: 1]`
Parse command-line arguments 2020-04-21 21:03:30 +00:00			`-o, --output <output> Output directory`
socks5h ensures, that DNS requests are also proxied 2021-04-14 10:00:44 +00:00			`-p, --proxy <proxy> Proxy, e.g. socks5h://127.0.0.1:1080 [default: ""]`
Parse command-line arguments 2020-04-21 21:03:30 +00:00			```
Initial commit 2020-04-21 20:41:28 +00:00
Update readme: .iliasignore usage 2020-04-25 08:38:49 +00:00			`### .iliasignore`

			.gitignore syntax can be used in a `.iliasignore` file: (located in the download folder)
			```ignore
Add example: only download one tutorial folder 2020-05-11 13:58:09 +00:00			`# example 1: only download a single course`
Update readme: .iliasignore usage 2020-04-25 08:38:49 +00:00			`/*/`
Add example: only download one tutorial folder 2020-05-11 13:58:09 +00:00			`!/InsertCourseHere/`
			`# example 2: only download files related to one tutorial`
			`/Course/Tutorien/*/`
			`!/Course/Tutorien/Tut* 3/`
Update readme: .iliasignore usage 2020-04-25 08:38:49 +00:00			```

Update readme 2020-11-09 11:02:44 +00:00			`### .iliaslogin`

			If you don't want to enter your credentials every time you run the program, you can instead save your username and password in a file (`.iliaslogin`):

			```
			`username`
			`password`
			```

Improve readme 2020-05-11 08:13:57 +00:00			`## Similar programs`
Initial commit 2020-04-21 20:41:28 +00:00
Improve readme 2020-05-11 08:13:57 +00:00			`- https://github.com/brantsch/kit-ilias-fuse/`
Update readme: .iliasignore usage 2020-04-25 08:38:49 +00:00			`- https://github.com/Garmelon/PFERD/`