KIT-ILIAS-downloader/README.md

64 lines
1.8 KiB
Markdown
Raw Normal View History

2020-04-21 20:41:28 +00:00
# KIT-ILIAS-downloader
Download content from ILIAS. That includes:
2020-04-21 21:03:30 +00:00
* files (latest version)
2020-04-21 20:41:28 +00:00
* Opencast lectures
## Installation
2020-04-24 09:13:31 +00:00
Go to the [releases](../../releases) and get the executable for your operating system. Alternatively compile from source: (to get the latest updates)
2020-04-25 08:38:49 +00:00
```
2020-04-21 20:41:28 +00:00
$ git clone https://github.com/FliegendeWurst/KIT-ILIAS-downloader
...
$ cd KIT-ILIAS-downloader
$ cargo build --release
...
$ cp target/release/KIT-ILIAS-downloader [directory in $PATH]
```
## Usage
2020-04-25 08:38:49 +00:00
Use `-o <directory>` to specify the download directory. Username and password have to be provided every time the program is run.
2020-04-22 12:11:42 +00:00
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.
2020-04-25 08:38:49 +00:00
```
2020-04-21 21:03:30 +00:00
$ KIT-ILIAS-downloader --help
2020-05-11 08:13:57 +00:00
KIT-ILIAS-downloader 0.2.5
2020-04-21 21:03:30 +00:00
USAGE:
2020-04-22 10:21:58 +00:00
KIT-ILIAS-downloader [FLAGS] [OPTIONS] --output <output>
2020-04-21 21:03:30 +00:00
FLAGS:
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)
2020-04-21 21:03:30 +00:00
OPTIONS:
2020-04-22 10:21:58 +00:00
-j, --jobs <jobs> Parallel download jobs [default: 1]
2020-04-21 21:03:30 +00:00
-o, --output <output> Output directory
```
2020-04-21 20:41:28 +00:00
2020-04-25 08:38:49 +00:00
### .iliasignore
.gitignore syntax can be used in a `.iliasignore` file: (located in the download folder)
```ignore
# example 1: only download a single course
2020-04-25 08:38:49 +00:00
/*/
!/InsertCourseHere/
# example 2: only download files related to one tutorial
/Course/Tutorien/*/
!/Course/Tutorien/Tut* 3/
2020-04-25 08:38:49 +00:00
```
2020-05-11 08:13:57 +00:00
## Similar programs
2020-04-21 20:41:28 +00:00
2020-05-11 08:13:57 +00:00
- https://github.com/brantsch/kit-ilias-fuse/
2020-04-25 08:38:49 +00:00
- https://github.com/Garmelon/PFERD/