mirrors/pferd
1
0
Fork 0
mirror of https://github.com/Garmelon/PFERD.git synced 2023-12-21 10:23:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

add documentation for default config section

Browse Source 
Thanks for pointing this out ;)
https://github.com/Garmelon/PFERD/pull/78#discussion_r1146558742

Co-authored-by: Joscha <joscha@plugh.de>
This commit is contained in:
Philipp Fruck 2023-03-24 17:16:03 +01:00
parent 62f1cf30c0
commit cb0e9127ea
No known key found for this signature in database
GPG Key ID: 9B7D2672DB7F47AD
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -161,18 +161,19 @@ $ pferd ilias-web --base-url https://ilias.my-university.example --client-id My_
To use a config file for the given instance, just extend the example above as follows: To use a config file for the given instance, just extend the example above as follows:
```ini ```ini
[auth:ilias] [DEFAULT]
... # same as described above
[crawl:ExampleCourse]
type = ilias-web
auth = auth:ilias
target = 1337420
# instance related settings
base_url = https://ilias.my-university.example base_url = https://ilias.my-university.example
client_id = My_University client_id = My_University
[auth:ilias]
...
[crawl:foo]
...
``` ```
Note that `base_url` and `client_id` can also be specified on a per-crawler level.
## Example configuration ## Example configuration
Inspired by [this ILIAS downloader](https://github.com/V3lop5/ilias-downloader/blob/main/configs), the following configurations should work out of the box for the corresponding universities: Inspired by [this ILIAS downloader](https://github.com/V3lop5/ilias-downloader/blob/main/configs), the following configurations should work out of the box for the corresponding universities: