KIT-ILIAS-downloader/README.md

97 lines
3.1 KiB
Markdown
Raw Normal View History

2020-04-21 20:41:28 +00:00
# KIT-ILIAS-downloader
Download content from ILIAS. That includes:
2021-04-08 17:10:38 +00:00
* files
* exercise sheets and solutions
2020-04-21 20:41:28 +00:00
* Opencast lectures
2021-04-14 15:24:39 +00:00
* forum posts
2020-04-21 20:41:28 +00:00
## Installation
2021-05-14 13:07:00 +00:00
**Windows/Linux users**: go to the [releases](../../releases) and download the executable for your operating system.
**macOS users**: [Install Rust](https://www.rust-lang.org/tools/install) and compile from source:
2020-04-25 08:38:49 +00:00
```
2021-05-14 13:07:00 +00:00
$ cargo install --all-features --git 'https://github.com/FliegendeWurst/KIT-ILIAS-downloader'
2020-04-21 20:41:28 +00:00
```
## Usage
2021-04-19 09:15:55 +00:00
First, open a terminal. Navigate to the directory that contains the downloaded binary.
2021-04-19 08:54:26 +00:00
2021-04-14 15:24:39 +00:00
Use `-o <directory>` to specify the download directory:
```
$ KIT-ILIAS-downloader -o ./ILIAS
```
2020-04-22 12:11:42 +00:00
2021-04-19 08:54:26 +00:00
By default, only content on your [personal desktop](https://ilias.studium.kit.edu/ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToSelectedItems) 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
2020-05-11 08:13:57 +00:00
2020-04-25 08:38:49 +00:00
```
2020-04-21 21:03:30 +00:00
$ KIT-ILIAS-downloader --help
2021-05-14 13:07:00 +00:00
KIT-ILIAS-downloader 0.2.20
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:
2021-04-19 08:54:26 +00:00
--check-videos Re-check OpenCast lectures (slow)
2021-05-07 07:18:29 +00:00
--content-tree Use content tree (experimental)
2020-04-24 09:13:31 +00:00
-f Re-download already present files
-t, --forum Download forum content
-h, --help Prints help information
2021-04-19 08:54:26 +00:00
--keyring Use the system keyring
2020-04-24 09:13:31 +00:00
-n, --no-videos Do not download Opencast videos
-s, --skip-files Do not download files
-V, --version Prints version information
2021-04-19 08:54:26 +00:00
-v Verbose logging
2020-04-21 21:03:30 +00:00
OPTIONS:
2021-04-19 08:54:26 +00:00
-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
2021-05-07 07:18:29 +00:00
--rate <rate> Requests per minute [default: 8]
2021-04-19 08:54:26 +00:00
--sync-url <sync-url> ILIAS page to download
-U, --username <username> KIT account username
2020-04-21 21:03:30 +00:00
```
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
```
2021-04-19 08:54:26 +00:00
### Credentials
2020-11-09 11:02:44 +00:00
2021-04-19 09:15:55 +00:00
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.
2021-04-19 08:54:26 +00:00
```
$ KIT-ILIAS-downloader -U uabcd --keyring [...]
```
2020-11-09 11:02:44 +00:00
2021-05-01 10:03:31 +00:00
You can also save your username and password in a `.iliaslogin` file: (located in the output folder)
2020-11-09 11:02:44 +00:00
```
username
password
```
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/
2021-05-01 10:02:48 +00:00
- https://github.com/DeOldSax/iliasDownloaderTool