Skip to content

Commit

Permalink
[docs] update configuration.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
mikf committed Jan 2, 2025
1 parent 428eb53 commit 2dd2c71
Showing 1 changed file with 96 additions and 72 deletions.
168 changes: 96 additions & 72 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -383,16 +383,32 @@ Type
|Duration|_
Default
* ``"0.5-1.5"``
``ao3``, ``civitai``,
``[Danbooru]``, ``[E621]``, ``[foolfuuka]:search``, ``itaku``,
``ao3``,
``civitai``,
``[Danbooru]``,
``[E621]``,
``[foolfuuka]:search``,
``itaku``,
``koharu``,
``newgrounds``, ``[philomena]``, ``pixiv:novel``, ``plurk``,
``poipiku`` , ``pornpics``, ``scrolller``, ``soundgasm``,
``urlgalleries``, ``vk``, ``zerochan``
``newgrounds``,
``[philomena]``,
``pixiv:novel``,
``plurk``,
``poipiku`` ,
``pornpics``,
``scrolller``,
``soundgasm``,
``urlgalleries``,
``vk``,
``zerochan``
* ``"1.0-2.0"``
``flickr``, ``weibo``, ``[wikimedia]``
``flickr``,
``weibo``,
``[wikimedia]``
* ``"2.0-4.0"``
``behance``, ``imagefap``, ``[Nijie]``
``behance``,
``imagefap``,
``[Nijie]``
* ``"3.0-6.0"``
``bilibili``,
``exhentai``,
Expand Down Expand Up @@ -636,16 +652,15 @@ extractor.*.user-agent
Type
``string``
Default
``"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:128.0) Gecko/20100101 Firefox/128.0"``
* ``"gallery-dl/VERSION"``: ``[Danbooru]``, ``mangadex``
* ``"gallery-dl/VERSION (by mikf)"``: ``[E621]``
* ``"Patreon/72.2.28 (Android; Android 14; Scale/2.10)"``: ``patreon``
* ``"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:LATEST) Gecko/20100101 Firefox/LATEST"``: otherwise
Description
User-Agent header value to be used for HTTP requests.

Setting this value to ``"browser"`` will try to automatically detect
and use the User-Agent used by the system's default browser.

Note: This option has no effect on
`pixiv`, `e621`, `mangadex`, and `patreon`
extractors, as these need specific values to function correctly.
and use the ``User-Agent`` header of the system's default browser.


extractor.*.browser
Expand Down Expand Up @@ -719,7 +734,7 @@ Example
Description
List of TLS/SSL cipher suites in
`OpenSSL cipher list format <https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT>`__
`OpenSSL cipher list format <https://docs.openssl.org/master/man1/openssl-ciphers/#cipher-list-format>`__
to be passed to
`ssl.SSLContext.set_ciphers() <https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_ciphers>`__

Expand Down Expand Up @@ -1822,8 +1837,8 @@ Description
uses the same domain as a given input URL.


extractor.danbooru.external
---------------------------
extractor.[Danbooru].external
-----------------------------
Type
``bool``
Default
Expand All @@ -1833,8 +1848,8 @@ Description
follow the ``source`` and download from there if possible.


extractor.danbooru.ugoira
-------------------------
extractor.[Danbooru].ugoira
---------------------------
Type
``bool``
Default
Expand Down Expand Up @@ -1885,45 +1900,6 @@ Description
batch. The value cannot be less than 1.


extractor.derpibooru.api-key
----------------------------
Type
``string``
Default
``null``
Description
Your `Derpibooru API Key <https://derpibooru.org/registrations/edit>`__,
to use your account's browsing settings and filters.


extractor.derpibooru.filter
---------------------------
Type
``integer``
Default
``56027`` (`Everything <https://derpibooru.org/filters/56027>`_ filter)
Description
The content filter ID to use.

Setting an explicit filter ID overrides any default filters and can be used
to access 18+ content without `API Key <extractor.derpibooru.api-key_>`_.

See `Filters <https://derpibooru.org/filters>`_ for details.


extractor.derpibooru.svg
------------------------
Type
``bool``
Default
``true``
Description
Download SVG versions of images when available.

Try to download the ``view_url`` version of these posts
when this option is disabled.


extractor.deviantart.auto-watch
-------------------------------
Type
Expand Down Expand Up @@ -3490,16 +3466,61 @@ Description

Possible formats:

* ``original``
* ``default``
* ``default_small``
* ``default_blurred``
* ``default_blurred_small``
* ``thumbnail``
* ``thumbnail_large``
* ``thumbnail_small``
* ``url``
* ``download_url``
* ``download_url`` (``"a":1,"p":1``)
* ``url`` (``"w":620``)
* ``original`` (``"q":100,"webp":0``)
* ``default`` (``"w":620``)
* ``default_small`` (``"w":360``)
* ``default_blurred`` (``"w":620``)
* ``default_blurred_small`` (``"w":360``)
* ``thumbnail`` (``"h":360,"w":360``)
* ``thumbnail_large`` (``"h":1080,"w":1080``)
* ``thumbnail_small`` (``"h":100,"w":100``)


extractor.[philomena].api-key
-----------------------------
Type
``string``
Default
``null``
Description
Your account's API Key,
to use your personal browsing settings and filters.


extractor.[philomena].filter
----------------------------
Type
``integer``
Default
:``derpibooru``:
``56027`` (`Everything <https://derpibooru.org/filters/56027>`__ filter)
:``ponybooru``:
``3`` (`Nah. <https://ponybooru.org/filters/3>`__ filter)
:otherwise:
``2``

Description
The content filter ID to use.

Setting an explicit filter ID overrides any default filters and can be used
to access 18+ content without `API Key <extractor.[philomena].api-key_>`_.

See `Filters <https://derpibooru.org/filters>`_ for details.


extractor.[philomena].svg
-------------------------
Type
``bool``
Default
``true``
Description
Download SVG versions of images when available.

Try to download the ``view_url`` version of these posts
when this option is disabled.


extractor.pillowfort.external
Expand Down Expand Up @@ -5304,7 +5325,7 @@ Default
``"file_url"``
Example
* ``"preview_url"``
* ``["sample_url", "preview_url", "file_url"}``
* ``["sample_url", "preview_url", "file_url"]``
Description
Alternate field name to retrieve download URLs from.

Expand Down Expand Up @@ -6006,10 +6027,13 @@ Default
.. code:: json
{
"Pictures": ["jpg", "jpeg", "png", "gif", "bmp", "svg", "webp"],
"Video" : ["flv", "ogv", "avi", "mp4", "mpg", "mpeg", "3gp", "mkv", "webm", "vob", "wmv"],
"Music" : ["mp3", "aac", "flac", "ogg", "wma", "m4a", "wav"],
"Archives": ["zip", "rar", "7z", "tar", "gz", "bz2"]
"Pictures" : ["jpg", "jpeg", "png", "gif", "bmp", "svg", "webp",
"avif", "heic", "heif", "ico", "psd"],
"Video" : ["flv", "ogv", "avi", "mp4", "mpg", "mpeg", "3gp", "mkv",
"webm", "vob", "wmv", "m4v", "mov"],
"Music" : ["mp3", "aac", "flac", "ogg", "wma", "m4a", "wav"],
"Archives" : ["zip", "rar", "7z", "tar", "gz", "bz2"],
"Documents": ["txt", "pdf"]
}
Description
Expand Down

0 comments on commit 2dd2c71

Please sign in to comment.