Mirrors/gallery-dl
1
0
Fork 0
mirror of https://github.com/mikf/gallery-dl.git synced 2024-11-25 12:12:34 +01:00
Code Issues Releases Wiki Activity
2b1f875ef4
gallery-dl/docs/configuration.rst
Mike Fährmann 7d1a95ada6
implement 'path-metadata' option (#2734)
2022-07-30 12:31:45 +02:00

4146 lines
97 KiB
ReStructuredText
Raw Blame History

Configuration
#############
| Configuration files for *gallery-dl* use a JSON-based file format.
| For a (more or less) complete example with options set to their default values,
see `gallery-dl.conf <gallery-dl.conf>`__.
| For a configuration file example with more involved settings and options,
see `gallery-dl-example.conf <gallery-dl-example.conf>`__.
|
This file lists all available configuration options and their descriptions.
Contents
========
1) `Extractor Options`_
2) `Extractor-specific Options`_
3) `Downloader Options`_
4) `Output Options`_
5) `Postprocessor Options`_
6) `Miscellaneous Options`_
7) `API Tokens & IDs`_
Extractor Options
=================
Each extractor is identified by its ``category`` and ``subcategory``.
The ``category`` is the lowercase site name without any spaces or special
characters, which is usually just the module name
(``pixiv``, ``danbooru``, ...).
The ``subcategory`` is a lowercase word describing the general functionality
of that extractor (``user``, ``favorite``, ``manga``, ...).
Each one of the following options can be specified on multiple levels of the
configuration tree:
================== =======
Base level: ``extractor.<option-name>``
Category level: ``extractor.<category>.<option-name>``
Subcategory level: ``extractor.<category>.<subcategory>.<option-name>``
================== =======
A value in a "deeper" level hereby overrides a value of the same name on a
lower level. Setting the ``extractor.pixiv.filename`` value, for example, lets
you specify a general filename pattern for all the different pixiv extractors.
Using the ``extractor.pixiv.user.filename`` value lets you override this
general pattern specifically for ``PixivUserExtractor`` instances.
The ``category`` and ``subcategory`` of all extractors are included in the
output of ``gallery-dl --list-extractors``. For a specific URL these values
can also be determined by using the ``-K``/``--list-keywords`` command-line
option (see the example below).
extractor.*.filename
--------------------
Type
``string`` or ``object``
Example
* .. code:: json
"{manga}_c{chapter}_{page:>03}.{extension}"
* .. code:: json
{
"extension == 'mp4'": "{id}_video.{extension}",
"'nature' in title" : "{id}_{title}.{extension}",
"" : "{id}_default.{extension}"
}
Description
A `format string`_ to build filenames for downloaded files with.
If this is an ``object``, it must contain Python expressions mapping to the
filename format strings to use.
These expressions are evaluated in the order as specified in Python 3.6+
and in an undetermined order in Python 3.4 and 3.5.
The available replacement keys depend on the extractor used. A list
of keys for a specific one can be acquired by calling *gallery-dl*
with the ``-K``/``--list-keywords`` command-line option.
For example:
.. code::
$ gallery-dl -K http://seiga.nicovideo.jp/seiga/im5977527
Keywords for directory names:
-----------------------------
category
seiga
subcategory
image
Keywords for filenames:
-----------------------
category
seiga
extension
None
image-id
5977527
subcategory
image
Note: Even if the value of the ``extension`` key is missing or
``None``, it will be filled in later when the file download is
starting. This key is therefore always available to provide
a valid filename extension.
extractor.*.directory
---------------------
Type
``list`` of ``strings`` or ``object``
Example
* .. code:: json
["{category}", "{manga}", "c{chapter} - {title}"]
* .. code:: json
{
"'nature' in content": ["Nature Pictures"],
"retweet_id != 0" : ["{category}", "{user[name]}", "Retweets"],
"" : ["{category}", "{user[name]}"]
}
Description
A list of `format strings`_ to build target directory paths with.
If this is an ``object``, it must contain Python expressions mapping to the
list of format strings to use.
Each individual string in such a list represents a single path
segment, which will be joined together and appended to the
base-directory_ to form the complete target directory path.
extractor.*.base-directory
--------------------------
Type
|Path|_
Default
``"./gallery-dl/"``
Description
Directory path used as base for all download destinations.
extractor.*.parent-directory
----------------------------
Type
``bool``
Default
``false``
Description
Use an extractor's current target directory as
`base-directory <extractor.*.base-directory_>`__
for any spawned child extractors.
extractor.*.parent-metadata
---------------------------
Type
``bool`` or ``string``
Default
``false``
Description
If ``true``, overwrite any metadata provided by a child extractor
with its parent's.
| If this is a ``string``, add a parent's metadata to its children's
to a field named after said string.
| For example with ``"parent-metadata": "_p_"``:
.. code:: json
{
"id": "child-id",
"_p_": {"id": "parent-id"}
}
extractor.*.parent-skip
-----------------------
Type
``bool``
Default
``false``
Description
Share number of skipped downloads between parent and child extractors.
extractor.*.path-restrict
-------------------------
Type
``string`` or ``object``
Default
``"auto"``
Example
* ``"/!? (){}"``
* ``{" ": "_", "/": "-", "|": "-", ":": "-", "*": "+"}``
Description
| A string of characters to be replaced with the value of
`path-replace <extractor.*.path-replace_>`__
| or an object mapping invalid/unwanted characters to their replacements
| for generated path segment names.
Special values:
* ``"auto"``: Use characters from ``"unix"`` or ``"windows"``
depending on the local operating system
* ``"unix"``: ``"/"``
* ``"windows"``: ``"\\\\|/<>:\"?*"``
* ``"ascii"``: ``"^0-9A-Za-z_."``
Note: In a string with 2 or more characters, ``[]^-\`` need to be
escaped with backslashes, e.g. ``"\\[\\]"``
extractor.*.path-replace
------------------------
Type
``string``
Default
``"_"``
Description
The replacement character(s) for
`path-restrict <extractor.*.path-restrict_>`__
extractor.*.path-remove
-----------------------
Type
``string``
Default
``"\u0000-\u001f\u007f"`` (ASCII control characters)
Description
Set of characters to remove from generated path names.
Note: In a string with 2 or more characters, ``[]^-\`` need to be
escaped with backslashes, e.g. ``"\\[\\]"``
extractor.*.path-strip
----------------------
Type
``string``
Default
``"auto"``
Description
Set of characters to remove from the end of generated path segment names
using `str.rstrip() <https://docs.python.org/3/library/stdtypes.html#str.rstrip>`_
Special values:
* ``"auto"``: Use characters from ``"unix"`` or ``"windows"``
depending on the local operating system
* ``"unix"``: ``""``
* ``"windows"``: ``". "``
extractor.*.extension-map
-------------------------
Type
``object``
Default
.. code:: json
{
"jpeg": "jpg",
"jpe" : "jpg",
"jfif": "jpg",
"jif" : "jpg",
"jfi" : "jpg"
}
Description
A JSON ``object`` mapping filename extensions to their replacements.
extractor.*.skip
----------------
Type
``bool`` or ``string``
Default
``true``
Description
Controls the behavior when downloading files that have been
downloaded before, i.e. a file with the same filename already
exists or its ID is in a `download archive <extractor.*.archive_>`__.
* ``true``: Skip downloads
* ``false``: Overwrite already existing files
* ``"abort"``: Stop the current extractor run
* ``"abort:N"``: Skip downloads and stop the current extractor run
after ``N`` consecutive skips
* ``"terminate"``: Stop the current extractor run, including parent extractors
* ``"terminate:N"``: Skip downloads and stop the current extractor run,
including parent extractors, after ``N`` consecutive skips
* ``"exit"``: Exit the program altogether
* ``"exit:N"``: Skip downloads and exit the program
after ``N`` consecutive skips
* ``"enumerate"``: Add an enumeration index to the beginning of the
filename extension (``file.1.ext``, ``file.2.ext``, etc.)
extractor.*.sleep
-----------------
Type
|Duration|_
Default
``0``
Description
Number of seconds to sleep before each download.
extractor.*.sleep-extractor
---------------------------
Type
|Duration|_
Default
``0``
Description
Number of seconds to sleep before handling an input URL,
i.e. before starting a new extractor.
extractor.*.sleep-request
-------------------------
Type
|Duration|_
Default
``0``
Description
Minimal time interval in seconds between each HTTP request
during data extraction.
extractor.*.username & .password
--------------------------------
Type
``string``
Default
``null``
Description
The username and password to use when attempting to log in to
another site.
Specifying a username and password is required for
* ``nijie``
and optional for
* ``aryion``
* ``danbooru`` (*)
* ``e621`` (*)
* ``exhentai``
* ``idolcomplex``
* ``imgbb``
* ``inkbunny``
* ``instagram``
* ``kemonoparty``
* ``mangadex``
* ``mangoxo``
* ``pillowfort``
* ``sankaku``
* ``seisoparty``
* ``subscribestar``
* ``tapas``
* ``tsumino``
* ``twitter``
* ``zerochan``
These values can also be specified via the
``-u/--username`` and ``-p/--password`` command-line options or
by using a |.netrc|_ file. (see Authentication_)
(*) The password value for ``danbooru`` and ``e621`` should be
the API key found in your user profile, not the actual account password.
extractor.*.netrc
-----------------
Type
``bool``
Default
``false``
Description
Enable the use of |.netrc|_ authentication data.
extractor.*.cookies
-------------------
Type
|Path|_ or ``object`` or ``list``
Default
``null``
Description
Source to read additional cookies from. This can be
* The |Path|_ to a Mozilla/Netscape format cookies.txt file
.. code:: json
"~/.local/share/cookies-instagram-com.txt"
* An ``object`` specifying cookies as name-value pairs
.. code:: json
{
"cookie-name": "cookie-value",
"sessionid" : "14313336321%3AsabDFvuASDnlpb%3A31",
"isAdult" : "1"
}
* A ``list`` with up to 3 entries specifying a browser profile.
* The first entry is the browser name
* The optional second entry is a profile name or an absolute path to a profile directory
* The optional third entry is the keyring to retrieve passwords for decrypting cookies from
.. code:: json
["firefox"]
["chromium", "Private", "kwallet"]
extractor.*.cookies-update
--------------------------
Type
``bool``
Default
``true``
Description
If `extractor.*.cookies`_ specifies the |Path|_ to a cookies.txt
file and it can be opened and parsed without errors,
update its contents with cookies received during data extraction.
extractor.*.proxy
-----------------
Type
``string`` or ``object``
Default
``null``
Description
Proxy (or proxies) to be used for remote connections.
* If this is a ``string``, it is the proxy URL for all
outgoing requests.
* If this is an ``object``, it is a scheme-to-proxy mapping to
specify different proxy URLs for each scheme.
It is also possible to set a proxy for a specific host by using
``scheme://host`` as key.
See `Requests' proxy documentation`_ for more details.
Example:
.. code:: json
{
"http" : "http://10.10.1.10:3128",
"https": "http://10.10.1.10:1080",
"http://10.20.1.128": "http://10.10.1.10:5323"
}
Note: All proxy URLs should include a scheme,
otherwise ``http://`` is assumed.
extractor.*.source-address
--------------------------
Type
* ``string``
* ``list`` with 1 ``string`` and 1 ``integer`` as elements
Example
* ``"192.168.178.20"``
* ``["192.168.178.20", 8080]``
Description
Client-side IP address to bind to.
| Can be either a simple ``string`` with just the local IP address
| or a ``list`` with IP and explicit port number as elements.
extractor.*.user-agent
----------------------
Type
``string``
Default
``"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101 Firefox/102.0"``
Description
User-Agent header value to be used for HTTP requests.
Note: This option has no effect on `pixiv` extractors,
as these need specific values to function correctly.
extractor.*.browser
-------------------
Type
``string``
Default
``"firefox"`` for ``patreon``, ``null`` everywhere else
Example
* ``"chrome:macos"``
Description
Try to emulate a real browser (``firefox`` or ``chrome``)
by using their default HTTP headers and TLS ciphers for HTTP requests.
Optionally, the operating system used in the ``User-Agent`` header can be
specified after a ``:`` (``windows``, ``linux``, or ``macos``).
Note: ``requests`` and ``urllib3`` only support HTTP/1.1, while a real
browser would use HTTP/2.
extractor.*.keywords
--------------------
Type
``object``
Example
``{"type": "Pixel Art", "type_id": 123}``
Description
Additional key-value pairs to be added to each metadata dictionary.
extractor.*.keywords-default
----------------------------
Type
any
Default
``"None"``
Description
Default value used for missing or undefined keyword names in
`format strings`_.
extractor.*.url-metadata
------------------------
Type
``string``
Default
``null``
Description
Insert a file's download URL into its metadata dictionary as the given name.
For example, setting this option to ``"gdl_file_url"`` will cause a new
metadata field with name ``gdl_file_url`` to appear, which contains the
current file's download URL.
This can then be used in `filenames <extractor.*.filename_>`_,
with a ``metadata`` post processor, etc.
extractor.*.path-metadata
-------------------------
Type
``string``
Default
``null``
Description
Insert a reference to the current `PathFormat <https://github.com/mikf/gallery-dl/blob/v1.22.4/gallery_dl/path.py#L20>`__
data structure into metadata dictionaries as the given name.
For example, setting this option to ``"gdl_path"`` would make it possible
to access the current file's filename as ``"[gdl_path.filename}"``.
extractor.*.category-transfer
-----------------------------
Type
``bool``
Default
Extractor-specific
Description
Transfer an extractor's (sub)category values to all child
extractors spawned by it, to let them inherit their parent's
config options.
extractor.*.blacklist & .whitelist
----------------------------------
Type
``list`` of ``strings``
Default
``["oauth", "recursive", "test"]`` + current extractor category
Example
``["imgur", "gfycat:user", "*:image"]``
Description
A list of extractor identifiers to ignore (or allow)
when spawning child extractors for unknown URLs,
e.g. from ``reddit`` or ``plurk``.
Each identifier can be
* A category or basecategory name (``"imgur"``, ``"mastodon"``)
* | A (base)category-subcategory pair, where both names are separated by a colon (``"gfycat:user"``).
| Both names can be a `*` or left empty, matching all possible names (``"*:image"``, ``":user"``).
Note: Any ``blacklist`` setting will automatically include
``"oauth"``, ``"recursive"``, and ``"test"``.
extractor.*.archive
-------------------
Type
|Path|_
Default
``null``
Example
``"$HOME/.archives/{category}.sqlite3"``
Description
File to store IDs of downloaded files in. Downloads of files
already recorded in this archive file will be
`skipped <extractor.*.skip_>`__.
The resulting archive file is not a plain text file but an SQLite3
database, as either lookup operations are significantly faster or
memory requirements are significantly lower when the
amount of stored IDs gets reasonably large.
Note: Archive files that do not already exist get generated automatically.
Note: Archive paths support regular `format string`_ replacements,
but be aware that using external inputs for building local paths
may pose a security risk.
extractor.*.archive-format
--------------------------
Type
``string``
Example
``"{id}_{offset}"``
Description
An alternative `format string`_ to build archive IDs with.
extractor.*.archive-prefix
--------------------------
Type
``string``
Default
``"{category}"``
Description
Prefix for archive IDs.
extractor.*.postprocessors
--------------------------
Type
``list`` of |Postprocessor Configuration|_ objects
Example
.. code:: json
[
{
"name": "zip" ,
"compression": "store"
},
{
"name": "exec",
"command": ["/home/foobar/script", "{category}", "{image_id}"]
}
]
Description
A list of `post processors <Postprocessor Configuration_>`__
to be applied to each downloaded file in the specified order.
| Unlike other options, a |postprocessors|_ setting at a deeper level
does not override any |postprocessors|_ setting at a lower level.
| Instead, all post processors from all applicable |postprocessors|_
settings get combined into a single list.
For example
* an ``mtime`` post processor at ``extractor.postprocessors``,
* a ``zip`` post processor at ``extractor.pixiv.postprocessors``,
* and using ``--exec``
will run all three post processors - ``mtime``, ``zip``, ``exec`` -
for each downloaded ``pixiv`` file.
extractor.*.retries
-------------------
Type
``integer``
Default
``4``
Description
Maximum number of times a failed HTTP request is retried before
giving up, or ``-1`` for infinite retries.
extractor.*.timeout
-------------------
Type
``float``
Default
``30.0``
Description
Amount of time (in seconds) to wait for a successful connection
and response from a remote server.
This value gets internally used as the |timeout|_ parameter for the
|requests.request()|_ method.
extractor.*.verify
------------------
Type
``bool`` or ``string``
Default
``true``
Description
Controls whether to verify SSL/TLS certificates for HTTPS requests.
If this is a ``string``, it must be the path to a CA bundle to use
instead of the default certificates.
This value gets internally used as the |verify|_ parameter for the
|requests.request()|_ method.
extractor.*.download
--------------------
Type
``bool``
Default
``true``
Description
Controls whether to download media files.
Setting this to ``false`` won't download any files, but all other
functions (`postprocessors`_, `download archive`_, etc.)
will be executed as normal.
extractor.*.fallback
--------------------
Type
``bool``
Default
``true``
Description
Use fallback download URLs when a download fails.
extractor.*.image-range
-----------------------
Type
``string``
Example
* ``"10-20"``
* ``"-5, 10, 30-50, 100-"``
Description
Index-range(s) specifying which images to download.
Note: The index of the first image is ``1``.
extractor.*.chapter-range
-------------------------
Type
``string``
Description
Like `image-range <extractor.*.image-range_>`__,
but applies to delegated URLs like manga-chapters, etc.
extractor.*.image-filter
------------------------
Type
``string``
Example
* ``"width >= 1200 and width/height > 1.2"``
* ``"re.search(r'foo(bar)+', description)"``
Description
Python expression controlling which files to download.
| Files for which the expression evaluates to ``False`` are ignored.
| Available keys are the filename-specific ones listed by ``-K`` or ``-j``.
extractor.*.chapter-filter
--------------------------
Type
``string``
Example
* ``"lang == 'en'"``
* ``"language == 'French' and 10 <= chapter < 20"``
Description
Like `image-filter <extractor.*.image-filter_>`__,
but applies to delegated URLs like manga-chapters, etc.
extractor.*.image-unique
------------------------
Type
``bool``
Default
``false``
Description
Ignore image URLs that have been encountered before during the
current extractor run.
extractor.*.chapter-unique
--------------------------
Type
``bool``
Default
``false``
Description
Like `image-unique <extractor.*.image-unique_>`__,
but applies to delegated URLs like manga-chapters, etc.
extractor.*.date-format
-----------------------
Type
``string``
Default
``"%Y-%m-%dT%H:%M:%S"``
Description
Format string used to parse ``string`` values of
`date-min` and `date-max`.
See |strptime|_ for a list of formatting directives.
Extractor-specific Options
==========================
extractor.artstation.external
-----------------------------
Type
``bool``
Default
``false``
Description
Try to follow external URLs of embedded players.
extractor.aryion.recursive
--------------------------
Type
``bool``
Default
``true``
Description
Controls the post extraction strategy.
* ``true``: Start on users' main gallery pages and recursively
descend into subfolders
* ``false``: Get posts from "Latest Updates" pages
extractor.bbc.width
-------------------
Type
``int``
Default
``1920``
Description
Specifies the requested image width.
This value must be divisble by 16 and gets rounded down otherwise.
The maximum possible value appears to be ``1920``.
extractor.blogger.videos
------------------------
Type
``bool``
Default
``true``
Description
Download embedded videos hosted on https://www.blogger.com/
extractor.cyberdrop.domain
--------------------------
Type
``string``
Default
``"auto"``
Example
``"cyberdrop.to"``
Description
Specifies the domain used by ``cyberdrop`` regardless of input URL.
Setting this option to ``"auto"``
uses the same domain as a given input URL.
extractor.danbooru.external
---------------------------
Type
``bool``
Default
``false``
Description
For unavailable or restricted posts,
follow the ``source`` and download from there if possible.
extractor.danbooru.metadata
---------------------------
Type
``bool``
Default
``false``
Description
Extract additional metadata (notes, artist commentary, parent, children)
Note: This requires 1 additional HTTP request for each post.
extractor.danbooru.ugoira
-------------------------
Type
``bool``
Default
``false``
Description
Controls the download target for Ugoira posts.
* ``true``: Original ZIP archives
* ``false``: Converted video files
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.deviantart.auto-watch
-------------------------------
Type
``bool``
Default
``false``
Description
Automatically watch users when encountering "Watchers-Only Deviations"
(requires a `refresh-token <extractor.deviantart.refresh-token_>`_).
extractor.deviantart.auto-unwatch
---------------------------------
Type
``bool``
Default
``false``
Description
After watching a user through `auto-watch <extractor.deviantart.auto-watch_>`_,
unwatch that user at the end of the current extractor run.
extractor.deviantart.comments
-----------------------------
Type
``bool``
Default
``false``
Description
Extract ``comments`` metadata.
extractor.deviantart.extra
--------------------------
Type
``bool``
Default
``false``
Description
Download extra Sta.sh resources from
description texts and journals.
Note: Enabling this option also enables deviantart.metadata_.
extractor.deviantart.flat
-------------------------
Type
``bool``
Default
``true``
Description
Select the directory structure created by the Gallery- and
Favorite-Extractors.
* ``true``: Use a flat directory structure.
* ``false``: Collect a list of all gallery-folders or
favorites-collections and transfer any further work to other
extractors (``folder`` or ``collection``), which will then
create individual subdirectories for each of them.
Note: Going through all gallery folders will not be able to
fetch deviations which aren't in any folder.
extractor.deviantart.folders
----------------------------
Type
``bool``
Default
``false``
Description
Provide a ``folders`` metadata field that contains the names of all
folders a deviation is present in.
Note: Gathering this information requires a lot of API calls.
Use with caution.
extractor.deviantart.include
----------------------------
Type
``string`` or ``list`` of ``strings``
Default
``"gallery"``
Example
``"favorite,journal,scraps"`` or ``["favorite", "journal", "scraps"]``
Description
A (comma-separated) list of subcategories to include
when processing a user profile.
Possible values are
``"gallery"``, ``"scraps"``, ``"journal"``, ``"favorite"``.
You can use ``"all"`` instead of listing all values separately.
extractor.deviantart.journals
-----------------------------
Type
``string``
Default
``"html"``
Description
Selects the output format of journal entries.
* ``"html"``: HTML with (roughly) the same layout as on DeviantArt.
* ``"text"``: Plain text with image references and HTML tags removed.
* ``"none"``: Don't download journals.
extractor.deviantart.mature
---------------------------
Type
``bool``
Default
``true``
Description
Enable mature content.
This option simply sets the |mature_content|_ parameter for API
calls to either ``"true"`` or ``"false"`` and does not do any other
form of content filtering.
extractor.deviantart.metadata
-----------------------------
Type
``bool``
Default
``false``
Description
Request extended metadata for deviation objects to additionally provide
``description``, ``tags``, ``license`` and ``is_watching`` fields.
extractor.deviantart.original
-----------------------------
Type
``bool`` or ``string``
Default
``true``
Description
Download original files if available.
Setting this option to ``"images"`` only downloads original
files if they are images and falls back to preview versions for
everything else (archives, etc.).
extractor.deviantart.pagination
-------------------------------
Type
``string``
Default
``"api"``
Description
Controls when to stop paginating over API results.
* ``"api"``: Trust the API and stop when ``has_more`` is ``false``.
* ``"manual"``: Disregard ``has_more`` and only stop when a batch of results is empty.
extractor.deviantart.refresh-token
----------------------------------
Type
``string``
Default
``null``
Description
The ``refresh-token`` value you get from
`linking your DeviantArt account to gallery-dl <OAuth_>`__.
Using a ``refresh-token`` allows you to access private or otherwise
not publicly available deviations.
Note: The ``refresh-token`` becomes invalid
`after 3 months <https://www.deviantart.com/developers/authentication#refresh>`__
or whenever your `cache file <cache.file_>`__ is deleted or cleared.
extractor.deviantart.wait-min
-----------------------------
Type
``integer``
Default
``0``
Description
Minimum wait time in seconds before API requests.
extractor.exhentai.domain
-------------------------
Type
``string``
Default
``"auto"``
Description
* ``"auto"``: Use ``e-hentai.org`` or ``exhentai.org``
depending on the input URL
* ``"e-hentai.org"``: Use ``e-hentai.org`` for all URLs
* ``"exhentai.org"``: Use ``exhentai.org`` for all URLs
extractor.exhentai.limits
-------------------------
Type
``integer``
Default
``null``
Description
Sets a custom image download limit and
stops extraction when it gets exceeded.
extractor.exhentai.metadata
---------------------------
Type
``bool``
Default
``false``
Description
Load extended gallery metadata from the
`API <https://ehwiki.org/wiki/API#Gallery_Metadata>`_.
Adds ``archiver_key``, ``posted``, and ``torrents``.
Makes ``date`` and ``filesize`` more precise.
extractor.exhentai.original
---------------------------
Type
``bool``
Default
``true``
Description
Download full-sized original images if available.
extractor.exhentai.source
-------------------------
Type
``string``
Default
``"gallery"``
Description
Selects an alternative source to download files from.
* ``"hitomi"``: Download the corresponding gallery from ``hitomi.la``
extractor.fanbox.embeds
-----------------------
Type
``bool`` or ``string``
Default
``true``
Description
Control behavior on embedded content from external sites.
* ``true``: Extract embed URLs and download them if supported
(videos are not downloaded).
* ``"ytdl"``: Like ``true``, but let `youtube-dl`_ handle video
extraction and download for YouTube, Vimeo and SoundCloud embeds.
* ``false``: Ignore embeds.
extractor.flickr.access-token & .access-token-secret
----------------------------------------------------
Type
``string``
Default
``null``
Description
The ``access_token`` and ``access_token_secret`` values you get
from `linking your Flickr account to gallery-dl <OAuth_>`__.
extractor.flickr.videos
-----------------------
Type
``bool``
Default
``true``
Description
Extract and download videos.
extractor.flickr.size-max
--------------------------
Type
``integer`` or ``string``
Default
``null``
Description
Sets the maximum allowed size for downloaded images.
* If this is an ``integer``, it specifies the maximum image dimension
(width and height) in pixels.
* If this is a ``string``, it should be one of Flickr's format specifiers
(``"Original"``, ``"Large"``, ... or ``"o"``, ``"k"``, ``"h"``,
``"l"``, ...) to use as an upper limit.
extractor.furaffinity.descriptions
----------------------------------
Type
``string``
Default
``"text"``
Description
Controls the format of ``description`` metadata fields.
* ``"text"``: Plain text with HTML tags removed
* ``"html"``: Raw HTML content
extractor.furaffinity.external
------------------------------
Type
``bool``
Default
``false``
Description
Follow external URLs linked in descriptions.
extractor.furaffinity.include
-----------------------------
Type
``string`` or ``list`` of ``strings``
Default
``"gallery"``
Example
``"scraps,favorite"`` or ``["scraps", "favorite"]``
Description
A (comma-separated) list of subcategories to include
when processing a user profile.
Possible values are
``"gallery"``, ``"scraps"``, ``"favorite"``.
You can use ``"all"`` instead of listing all values separately.
extractor.furaffinity.layout
----------------------------
Type
``string``
Default
``"auto"``
Description
Selects which site layout to expect when parsing posts.
* ``"auto"``: Automatically differentiate between ``"old"`` and ``"new"``
* ``"old"``: Expect the *old* site layout
* ``"new"``: Expect the *new* site layout
extractor.gelbooru.api-key & .user-id
-------------------------------------
Type
``string``
Default
``null``
Description
Values from the API Access Credentials section found at the bottom of your
`Account Options <https://gelbooru.com/index.php?page=account&s=options>`__
page.
extractor.generic.enabled
-------------------------
Type
``bool``
Default
``false``
Description
Match **all** URLs not otherwise supported by gallery-dl,
even ones without a ``generic:`` prefix.
extractor.gfycat.format
-----------------------
Type
* ``list`` of ``strings``
* ``string``
Default
``["mp4", "webm", "mobile", "gif"]``
Description
List of names of the preferred animation format, which can be
``"mp4"``, ``"webm"``, ``"mobile"``, ``"gif"``, or ``"webp"``.
If a selected format is not available, the next one in the list will be
tried until an available format is found.
If the format is given as ``string``, it will be extended with
``["mp4", "webm", "mobile", "gif"]``. Use a list with one element to
restrict it to only one possible format.
extractor.gofile.api-token
--------------------------
Type
``string``
Default
``null``
Description
API token value found at the bottom of your `profile page <https://gofile.io/myProfile>`__.
If not set, a temporary guest token will be used.
extractor.gofile.website-token
------------------------------
Type
``string``
Default
``"12345"``
Description
API token value used during API requests.
A not up-to-date value will result in ``401 Unauthorized`` errors.
Setting this value to ``null`` will do an extra HTTP request to fetch
the current value used by gofile.
extractor.gofile.recursive
--------------------------
Type
``bool``
Default
``false``
Description
Recursively download files from subfolders.
extractor.hentaifoundry.include
-------------------------------
Type
``string`` or ``list`` of ``strings``
Default
``"pictures"``
Example
``"scraps,stories"`` or ``["scraps", "stories"]``
Description
A (comma-separated) list of subcategories to include
when processing a user profile.
Possible values are
``"pictures"``, ``"scraps"``, ``"stories"``, ``"favorite"``.
You can use ``"all"`` instead of listing all values separately.
extractor.hitomi.format
-----------------------
Type
``string``
Default
``"webp"``
Description
Selects which image format to download.
Available formats are ``"webp"`` and ``"avif"``.
``"original"`` will try to download the original ``jpg`` or ``png`` versions,
but is most likely going to fail with ``403 Forbidden`` errors.
extractor.imgur.mp4
-------------------
Type
``bool`` or ``string``
Default
``true``
Description
Controls whether to choose the GIF or MP4 version of an animation.
* ``true``: Follow Imgur's advice and choose MP4 if the
``prefer_video`` flag in an image's metadata is set.
* ``false``: Always choose GIF.
* ``"always"``: Always choose MP4.
extractor.inkbunny.orderby
--------------------------
Type
``string``
Default
``"create_datetime"``
Description
Value of the ``orderby`` parameter for submission searches.
(See `API#Search <https://wiki.inkbunny.net/wiki/API#Search>`__
for details)
extractor.instagram.include
---------------------------
Type
``string`` or ``list`` of ``strings``
Default
``"posts"``
Example
``"stories,highlights,posts"`` or ``["stories", "highlights", "posts"]``
Description
A (comma-separated) list of subcategories to include
when processing a user profile.
Possible values are
``"posts"``, ``"reels"``, ``"channel"``, ``"tagged"``,
``"stories"``, ``"highlights"``.
You can use ``"all"`` instead of listing all values separately.
extractor.instagram.previews
----------------------------
Type
``bool``
Default
``false``
Description
Download video previews.
extractor.instagram.videos
--------------------------
Type
``bool``
Default
``true``
Description
Download video files.
extractor.itaku.videos
----------------------
Type
``bool``
Default
``true``
Description
Download video files.
extractor.kemonoparty.comments
------------------------------
Type
``bool``
Default
``false``
Description
Extract ``comments`` metadata.
extractor.kemonoparty.duplicates
--------------------------------
Type
``bool``
Default
``false``
Description
Controls how to handle duplicate files in a post.
* ``true``: Download duplicates
* ``false``: Ignore duplicates
extractor.kemonoparty.dms
-------------------------
Type
``bool``
Default
``false``
Description
Extract a user's direct messages as ``dms`` metadata.
extractor.kemonoparty.files
---------------------------
Type
``list`` of ``strings``
Default
``["attachments", "file", "inline"]``
Description
Determines the type and order of files to be downloaded.
Available types are ``file``, ``attachments``, and ``inline``.
extractor.kemonoparty.max-posts
-------------------------------
Type
``integer``
Default
``null``
Description
Limit the number of posts to download.
extractor.kemonoparty.metadata
------------------------------
Type
``bool``
Default
``false``
Description
Extract ``username`` metadata
extractor.khinsider.format
--------------------------
Type
``string``
Default
``"mp3"``
Description
The name of the preferred file format to download.
Use ``"all"`` to download all available formats,
or a (comma-separated) list to select multiple formats.
If the selected format is not available,
the first in the list gets chosen (usually `mp3`).
extractor.lolisafe.domain
-------------------------
Type
``string``
Default
``"auto"``
Description
Specifies the domain used by a ``lolisafe`` extractor
regardless of input URL.
Setting this option to ``"auto"``
uses the same domain as a given input URL.
extractor.luscious.gif
----------------------
Type
``bool``
Default
``false``
Description
Format in which to download animated images.
Use ``true`` to download animated images as gifs and ``false``
to download as mp4 videos.
extractor.mangadex.api-server
-----------------------------
Type
``string``
Default
``"https://api.mangadex.org"``
Description
The server to use for API requests.
extractor.mangadex.api-parameters
---------------------------------
Type
``object``
Example
``{"order[updatedAt]": "desc"}``
Description
Additional query parameters to send when fetching manga chapters.
(See `/manga/{id}/feed <https://api.mangadex.org/docs.html#operation/get-manga-id-feed>`_
and `/user/follows/manga/feed <https://api.mangadex.org/docs.html#operation/get-user-follows-manga-feed>`_)
extractor.mangadex.lang
-----------------------
Type
``string``
Example
``"en"``
Description
`ISO 639-1 <https://en.wikipedia.org/wiki/ISO_639-1>`_ language code
to filter chapters by.
extractor.mangadex.ratings
--------------------------
Type
``list`` of ``strings``
Default
``["safe", "suggestive", "erotica", "pornographic"]``
Description
List of acceptable content ratings for returned chapters.
extractor.mastodon.reblogs
--------------------------
Type
``bool``
Default
``false``
Description
Fetch media from reblogged posts.
extractor.mastodon.replies
--------------------------
Type
``bool``
Default
``true``
Description
Fetch media from replies to other posts.
extractor.mastodon.text-posts
-----------------------------
Type
``bool``
Default
``false``
Description
Also emit metadata for text-only posts without media content.
extractor.newgrounds.flash
--------------------------
Type
``bool``
Default
``true``
Description
Download original Adobe Flash animations instead of pre-rendered videos.
extractor.newgrounds.format
---------------------------
Type
``string``
Default
``"original"``
Example
``"720p"``
Description
Selects the preferred format for video downloads.
If the selected format is not available,
the next smaller one gets chosen.
extractor.newgrounds.include
----------------------------
Type
``string`` or ``list`` of ``strings``
Default
``"art"``
Example
``"movies,audio"`` or ``["movies", "audio"]``
Description
A (comma-separated) list of subcategories to include
when processing a user profile.
Possible values are
``"art"``, ``"audio"``, ``"movies"``.
You can use ``"all"`` instead of listing all values separately.
extractor.nijie.include
-----------------------
Type
``string`` or ``list`` of ``strings``
Default
``"illustration,doujin"``
Description
A (comma-separated) list of subcategories to include
when processing a user profile.
Possible values are
``"illustration"``, ``"doujin"``, ``"favorite"``, ``"nuita"``.
You can use ``"all"`` instead of listing all values separately.
extractor.oauth.browser
-----------------------
Type
``bool``
Default
``true``
Description
Controls how a user is directed to an OAuth authorization page.
* ``true``: Use Python's |webbrowser.open()|_ method to automatically
open the URL in the user's default browser.
* ``false``: Ask the user to copy & paste an URL from the terminal.
extractor.oauth.cache
---------------------
Type
``bool``
Default
``true``
Description
Store tokens received during OAuth authorizations
in `cache <cache.file_>`__.
extractor.oauth.port
--------------------
Type
``integer``
Default
``6414``
Description
Port number to listen on during OAuth authorization.
Note: All redirects will go to http://localhost:6414/, regardless
of the port specified here. You'll have to manually adjust the
port number in your browser's address bar when using a different
port than the default.
extractor.paheal.metadata
-------------------------
Type
``bool``
Default
``false``
Description
Extract additional metadata (``source``, ``uploader``)
Note: This requires 1 additional HTTP request per post.
extractor.patreon.files
-----------------------
Type
``list`` of ``strings``
Default
``["images", "image_large", "attachments", "postfile", "content"]``
Description
Determines the type and order of files to be downloaded.
Available types are
``postfile``, ``images``, ``image_large``, ``attachments``, and ``content``.
extractor.photobucket.subalbums
-------------------------------
Type
``bool``
Default
``true``
Description
Download subalbums.
extractor.pillowfort.external
-----------------------------
Type
``bool``
Default
``false``
Description
Follow links to external sites, e.g. Twitter,
extractor.pillowfort.inline
---------------------------
Type
``bool``
Default
``true``
Description
Extract inline images.
extractor.pillowfort.reblogs
----------------------------
Type
``bool``
Default
``false``
Description
Extract media from reblogged posts.
extractor.pinterest.sections
----------------------------
Type
``bool``
Default
``true``
Description
Include pins from board sections.
extractor.pinterest.videos
--------------------------
Type
``bool``
Default
``true``
Description
Download from video pins.
extractor.pixiv.include
-----------------------
Type
* ``string``
* ``list`` of ``strings``
Default
``"artworks"``
Example
* ``"avatar,background,artworks"``
* ``["avatar", "background", "artworks"]``
Description
A (comma-separated) list of subcategories to include
when processing a user profile.
Possible values are
``"artworks"``, ``"avatar"``, ``"background"``, ``"favorite"``.
It is possible to use ``"all"`` instead of listing all values separately.
extractor.pixiv.artworks.metadata
---------------------------------
Type
``bool``
Default
``false``
Description
Fetch extended ``user`` metadata.
extractor.pixiv.work.related
----------------------------
Type
``bool``
Default
``false``
Description
Also download related artworks.
extractor.pixiv.tags
--------------------
Type
``string``
Default
``"japanese"``
Description
Controls the ``tags`` metadata field.
* `"japanese"`: List of Japanese tags
* `"translated"`: List of translated tags
* `"original"`: Unmodified list with both Japanese and translated tags
extractor.pixiv.ugoira
----------------------
Type
``bool``
Default
``true``
Description
Download Pixiv's Ugoira animations or ignore them.
These animations come as a ``.zip`` file containing all
animation frames in JPEG format.
Use an `ugoira` post processor to convert them
to watchable videos. (Example__)
.. __: https://github.com/mikf/gallery-dl/blob/v1.12.3/docs/gallery-dl-example.conf#L9-L14
extractor.pixiv.max-posts
-------------------------
Type
``integer``
Default
``0``
Description
When downloading galleries, this sets the maximum number of posts to get.
A value of ``0`` means no limit.
extractor.plurk.comments
------------------------
Type
``bool``
Default
``false``
Description
Also search Plurk comments for URLs.
extractor.reactor.gif
---------------------
Type
``bool``
Default
``false``
Description
Format in which to download animated images.
Use ``true`` to download animated images as gifs and ``false``
to download as mp4 videos.
extractor.readcomiconline.captcha
---------------------------------
Type
``string``
Default
``"stop"``
Description
Controls how to handle redirects to CAPTCHA pages.
* ``"stop``: Stop the current extractor run.
* ``"wait``: Ask the user to solve the CAPTCHA and wait.
extractor.readcomiconline.quality
---------------------------------
Type
``string``
Default
``"auto"``
Description
Sets the ``quality`` query parameter of issue pages. (``"lq"`` or ``"hq"``)
``"auto"`` uses the quality parameter of the input URL
or ``"hq"`` if not present.
extractor.reddit.comments
-------------------------
Type
``integer``
Default
``0``
Description
The value of the ``limit`` parameter when loading
a submission and its comments.
This number (roughly) specifies the total amount of comments
being retrieved with the first API call.
Reddit's internal default and maximum values for this parameter
appear to be 200 and 500 respectively.
The value ``0`` ignores all comments and significantly reduces the
time required when scanning a subreddit.
extractor.reddit.morecomments
-----------------------------
Type
``bool``
Default
``false``
Description
Retrieve additional comments by resolving the ``more`` comment
stubs in the base comment tree.
This requires 1 additional API call for every 100 extra comments.
extractor.reddit.date-min & .date-max
-------------------------------------
Type
|Date|_
Default
``0`` and ``253402210800`` (timestamp of |datetime.max|_)
Description
Ignore all submissions posted before/after this date.
extractor.reddit.id-min & .id-max
---------------------------------
Type
``string``
Example
``"6kmzv2"``
Description
Ignore all submissions posted before/after the submission with this ID.
extractor.reddit.recursion
--------------------------
Type
``integer``
Default
``0``
Description
Reddit extractors can recursively visit other submissions
linked to in the initial set of submissions.
This value sets the maximum recursion depth.
Special values:
* ``0``: Recursion is disabled
* ``-1``: Infinite recursion (don't do this)
extractor.reddit.refresh-token
------------------------------
Type
``string``
Default
``null``
Description
The ``refresh-token`` value you get from
`linking your Reddit account to gallery-dl <OAuth_>`__.
Using a ``refresh-token`` allows you to access private or otherwise
not publicly available subreddits, given that your account is
authorized to do so,
but requests to the reddit API are going to be rate limited
at 600 requests every 10 minutes/600 seconds.
extractor.reddit.videos
-----------------------
Type
``bool`` or ``string``
Default
``true``
Description
Control video download behavior.
* ``true``: Download videos and use `youtube-dl`_ to handle
HLS and DASH manifests
* ``"ytdl"``: Download videos and let `youtube-dl`_ handle all of
video extraction and download
* ``false``: Ignore videos
extractor.redgifs.format
------------------------
Type
* ``list`` of ``strings``
* ``string``
Default
``["hd", "sd", "gif"]``
Description
List of names of the preferred animation format, which can be
``"hd"``, ``"sd"``, `"gif"``, `"vthumbnail"``, `"thumbnail"``, or ``"poster"``.
If a selected format is not available, the next one in the list will be
tried until an available format is found.
If the format is given as ``string``, it will be extended with
``["hd", "sd", "gif"]``. Use a list with one element to
restrict it to only one possible format.
extractor.sankakucomplex.embeds
-------------------------------
Type
``bool``
Default
``false``
Description
Download video embeds from external sites.
extractor.sankakucomplex.videos
-------------------------------
Type
``bool``
Default
``true``
Description
Download videos.
extractor.skeb.article
----------------------
Type
``bool``
Default
``false``
Description
Download article images.
extractor.skeb.sent-requests
----------------------------
Type
``bool``
Default
``false``
Description
Download sent requests.
extractor.skeb.thumbnails
-------------------------
Type
``bool``
Default
``false``
Description
Download thumbnails.
extractor.smugmug.videos
------------------------
Type
``bool``
Default
``true``
Description
Download video files.
extractor.tumblr.avatar
-----------------------
Type
``bool``
Default
``false``
Description
Download blog avatars.
extractor.tumblr.date-min & .date-max
-------------------------------------
Type
|Date|_
Default
``0`` and ``null``
Description
Ignore all posts published before/after this date.
extractor.tumblr.external
-------------------------
Type
``bool``
Default
``false``
Description
Follow external URLs (e.g. from "Link" posts) and try to extract
images from them.
extractor.tumblr.inline
-----------------------
Type
``bool``
Default
``true``
Description
Search posts for inline images and videos.
extractor.tumblr.reblogs
------------------------
Type
``bool`` or ``string``
Default
``true``
Description
* ``true``: Extract media from reblogged posts
* ``false``: Skip reblogged posts
* ``"same-blog"``: Skip reblogged posts unless the original post
is from the same blog
extractor.tumblr.posts
----------------------
Type
``string`` or ``list`` of ``strings``
Default
``"all"``
Example
``"video,audio,link"`` or ``["video", "audio", "link"]``
Description
A (comma-separated) list of post types to extract images, etc. from.
Possible types are ``text``, ``quote``, ``link``, ``answer``,
``video``, ``audio``, ``photo``, ``chat``.
You can use ``"all"`` instead of listing all types separately.
extractor.twibooru.api-key
--------------------------
Type
``string``
Default
``null``
Description
Your `Twibooru API Key <https://twibooru.org/users/edit>`__,
to use your account's browsing settings and filters.
extractor.twibooru.filter
-------------------------
Type
``integer``
Default
``2`` (`Everything <https://twibooru.org/filters/2>`__ 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.twibooru.api-key_>`__.
See `Filters <https://twibooru.org/filters>`__ for details.
extractor.twitter.cards
-----------------------
Type
``bool`` or ``string``
Default
``false``
Description
Controls how to handle `Twitter Cards <https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/abouts-cards>`__.
* ``false``: Ignore cards
* ``true``: Download image content from supported cards
* ``"ytdl"``: Additionally download video content from unsupported cards using `youtube-dl`_
extractor.twitter.conversations
-------------------------------
Type
``bool``
Default
``false``
Description
Fetch media from all Tweets and replies in a `conversation
<https://help.twitter.com/en/using-twitter/twitter-conversations>`__.
extractor.twitter.csrf
----------------------
Type
``string``
Default
``"cookies"``
Description
Controls how to handle Cross Site Request Forgery (CSRF) tokens.
* ``"auto"``: Always auto-generate a token.
* ``"cookies"``: Use token given by the ``ct0`` cookie if present.
extractor.twitter.size
----------------------
Type
``list`` of ``strings``
Default
``["orig", "4096x4096", "large", "medium", "small"]``
Description
The image version to download.
Any entries after the first one will be used for potential
`fallback <extractor.*.fallback_>`_ URLs.
Known available sizes are
``4096x4096``, ``orig``, ``large``, ``medium``, and ``small``.
extractor.twitter.syndication
-----------------------------
Type
``bool``
Default
``false``
Description
Retrieve age-restricted content using Twitter's syndication API.
extractor.twitter.logout
------------------------
Type
``bool``
Default
``false``
Description
Logout and retry as guest when access to another user's Tweets is blocked.
extractor.twitter.pinned
------------------------
Type
``bool``
Default
``false``
Description
Fetch media from pinned Tweets.
extractor.twitter.quoted
------------------------
Type
``bool``
Default
``false``
Description
Fetch media from quoted Tweets.
extractor.twitter.replies
-------------------------
Type
``bool``
Default
``true``
Description
Fetch media from replies to other Tweets.
If this value is ``"self"``, only consider replies where
reply and original Tweet are from the same user.
extractor.twitter.retweets
--------------------------
Type
``bool``
Default
``false``
Description
Fetch media from Retweets.
If this value is ``"original"``, metadata for these files
will be taken from the original Tweets, not the Retweets.
extractor.twitter.timeline.strategy
-----------------------------------
Type
``string``
Default
``"auto"``
Description
Controls the strategy / tweet source used for user URLs
(``https://twitter.com/USER``).
* ``"tweets"``: `/tweets <https://twitter.com/USER/tweets>`__ timeline + search
* ``"media"``: `/media <https://twitter.com/USER/media>`__ timeline + search
* ``"with_replies"``: `/with_replies <https://twitter.com/USER/with_replies>`__ timeline + search
* ``"auto"``: ``"tweets"`` or ``"media"``, depending on `retweets <extractor.twitter.retweets_>`__ and `text-tweets <extractor.twitter.text-tweets_>`__ settings
extractor.twitter.text-tweets
-----------------------------
Type
``bool``
Default
``false``
Description
Also emit metadata for text-only Tweets without media content.
This only has an effect with a ``metadata`` (or ``exec``) post processor
with `"event": "post" <metadata.event_>`_
and appropriate `filename <metadata.filename_>`_.
extractor.twitter.twitpic
-------------------------
Type
``bool``
Default
``false``
Description
Extract `TwitPic <https://twitpic.com/>`__ embeds.
extractor.twitter.unique
------------------------
Type
``bool``
Default
``true``
Description
Ignore previously seen Tweets.
extractor.twitter.users
-----------------------
Type
``string``
Default
``"timeline"``
Example
``"https://twitter.com/search?q=from:{legacy[screen_name]}"``
Description
| Format string for user URLs generated from
``following`` and ``list-members`` queries,
| whose replacement field values come from Twitter ``user`` objects
(`Example <https://gist.githubusercontent.com/mikf/99d2719b3845023326c7a4b6fb88dd04/raw/275b4f0541a2c7dc0a86d3998f7d253e8f10a588/github.json>`_)
Special values:
* ``"timeline"``: ``https://twitter.com/i/user/{rest_id}``
* ``"tweets"``: ``https://twitter.com/id:{rest_id}/tweets``
* ``"media"``: ``https://twitter.com/id:{rest_id}/media``
Note: To allow gallery-dl to follow custom URL formats, set the blacklist__
for ``twitter`` to a non-default value, e.g. an empty string ``""``.
.. __: `extractor.*.blacklist & .whitelist`_
extractor.twitter.videos
------------------------
Type
``bool`` or ``string``
Default
``true``
Description
Control video download behavior.
* ``true``: Download videos
* ``"ytdl"``: Download videos using `youtube-dl`_
* ``false``: Skip video Tweets
extractor.unsplash.format
-------------------------
Type
``string``
Default
``"raw"``
Description
Name of the image format to download.
Available formats are
``"raw"``, ``"full"``, ``"regular"``, ``"small"``, and ``"thumb"``.
extractor.vsco.videos
---------------------
Type
``bool``
Default
``true``
Description
Download video files.
extractor.wallhaven.api-key
---------------------------
Type
``string``
Default
``null``
Description
Your `Wallhaven API Key <https://wallhaven.cc/settings/account>`__,
to use your account's browsing settings and default filters when searching.
See https://wallhaven.cc/help/api for more information.
extractor.weasyl.api-key
------------------------
Type
``string``
Default
``null``
Description
Your `Weasyl API Key <https://www.weasyl.com/control/apikeys>`__,
to use your account's browsing settings and filters.
extractor.weasyl.metadata
-------------------------
Type
``bool``
Default
``false``
Description
| Fetch extra submission metadata during gallery downloads.
| (``comments``, ``description``, ``favorites``, ``folder_name``,
``tags``, ``views``)
Note: This requires 1 additional HTTP request per submission.
extractor.weibo.include
-----------------------
Type
* ``string``
* ``list`` of ``strings``
Default
``"feed"``
Description
A (comma-separated) list of subcategories to include
when processing a user profile.
Possible values are
``"home"``, ``"feed"``, ``"videos"``, ``"newvideo"``, ``"article"``, ``"album"``.
It is possible to use ``"all"`` instead of listing all values separately.
extractor.weibo.livephoto
-------------------------
Type
``bool``
Default
``true``
Description
Download ``livephoto`` files.
extractor.weibo.retweets
------------------------
Type
``bool``
Default
``true``
Description
Fetch media from retweeted posts.
If this value is ``"original"``, metadata for these files
will be taken from the original posts, not the retweeted posts.
extractor.weibo.videos
----------------------
Type
``bool``
Default
``true``
Description
Download video files.
extractor.ytdl.enabled
----------------------
Type
``bool``
Default
``false``
Description
Match **all** URLs, even ones without a ``ytdl:`` prefix.
extractor.ytdl.format
---------------------
Type
``string``
Default
youtube-dl's default, currently ``"bestvideo+bestaudio/best"``
Description
Video `format selection
<https://github.com/ytdl-org/youtube-dl#format-selection>`__
directly passed to youtube-dl.
extractor.ytdl.generic
----------------------
Type
``bool``
Default
``true``
Description
Controls the use of youtube-dl's generic extractor.
Set this option to ``"force"`` for the same effect as youtube-dl's
``--force-generic-extractor``.
extractor.ytdl.logging
----------------------
Type
``bool``
Default
``true``
Description
Route youtube-dl's output through gallery-dl's logging system.
Otherwise youtube-dl will write its output directly to stdout/stderr.
Note: Set ``quiet`` and ``no_warnings`` in
`extractor.ytdl.raw-options`_ to ``true`` to suppress all output.
extractor.ytdl.module
---------------------
Type
``string``
Default
``null``
Description
Name of the youtube-dl Python module to import.
Setting this to ``null`` will try to import ``"yt_dlp"``
followed by ``"youtube_dl"`` as fallback.
extractor.ytdl.raw-options
--------------------------
Type
``object``
Example
.. code:: json
{
"quiet": true,
"writesubtitles": true,
"merge_output_format": "mkv"
}
Description
Additional options passed directly to the ``YoutubeDL`` constructor.
All available options can be found in `youtube-dl's docstrings
<https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L138-L318>`__.
extractor.ytdl.cmdline-args
---------------------------
Type
* ``string``
* ``list`` of ``strings``
Example
* ``"--quiet --write-sub --merge-output-format mkv"``
* ``["--quiet", "--write-sub", "--merge-output-format", "mkv"]``
Description
Additional options specified as youtube-dl command-line arguments.
extractor.ytdl.config-file
--------------------------
Type
|Path|_
Example
``"~/.config/youtube-dl/config"``
Description
Location of a youtube-dl configuration file to load options from.
extractor.[booru].tags
----------------------
Type
``bool``
Default
``false``
Description
Categorize tags by their respective types
and provide them as ``tags_<type>`` metadata fields.
Note: This requires 1 additional HTTP request for each post.
extractor.[booru].notes
-----------------------
Type
``bool``
Default
``false``
Description
Extract overlay notes (position and text).
Note: This requires 1 additional HTTP request for each post.
extractor.[manga-extractor].chapter-reverse
-------------------------------------------
Type
``bool``
Default
``false``
Description
Reverse the order of chapter URLs extracted from manga pages.
* ``true``: Start with the latest chapter
* ``false``: Start with the first chapter
extractor.[manga-extractor].page-reverse
----------------------------------------
Type
``bool``
Default
``false``
Description
Download manga chapter pages in reverse order.
Downloader Options
==================
downloader.*.enabled
--------------------
Type
``bool``
Default
``true``
Description
Enable/Disable this downloader module.
downloader.*.filesize-min & .filesize-max
-----------------------------------------
Type
``string``
Default
``null``
Example
``"32000"``, ``"500k"``, ``"2.5M"``
Description
Minimum/Maximum allowed file size in bytes.
Any file smaller/larger than this limit will not be downloaded.
Possible values are valid integer or floating-point numbers
optionally followed by one of ``k``, ``m``. ``g``, ``t`` or ``p``.
These suffixes are case-insensitive.
downloader.*.mtime
------------------
Type
``bool``
Default
``true``
Description
Use |Last-Modified|_ HTTP response headers
to set file modification times.
downloader.*.part
-----------------
Type
``bool``
Default
``true``
Description
Controls the use of ``.part`` files during file downloads.
* ``true``: Write downloaded data into ``.part`` files and rename
them upon download completion. This mode additionally supports
resuming incomplete downloads.
* ``false``: Do not use ``.part`` files and write data directly
into the actual output files.
downloader.*.part-directory
---------------------------
Type
|Path|_
Default
``null``
Description
Alternate location for ``.part`` files.
Missing directories will be created as needed.
If this value is ``null``, ``.part`` files are going to be stored
alongside the actual output files.
downloader.*.progress
---------------------
Type
``float``
Default
``3.0``
Description
Number of seconds until a download progress indicator
for the current download is displayed.
Set this option to ``null`` to disable this indicator.
downloader.*.rate
-----------------
Type
``string``
Default
``null``
Example
``"32000"``, ``"500k"``, ``"2.5M"``
Description
Maximum download rate in bytes per second.
Possible values are valid integer or floating-point numbers
optionally followed by one of ``k``, ``m``. ``g``, ``t`` or ``p``.
These suffixes are case-insensitive.
downloader.*.retries
--------------------
Type
``integer``
Default
`extractor.*.retries`_
Description
Maximum number of retries during file downloads,
or ``-1`` for infinite retries.
downloader.*.timeout
--------------------
Type
``float`` or ``null``
Default
`extractor.*.timeout`_
Description
Connection timeout during file downloads.
downloader.*.verify
-------------------
Type
``bool`` or ``string``
Default
`extractor.*.verify`_
Description
Certificate validation during file downloads.
downloader.*.proxy
------------------
Type
``string`` or ``object``
Default
`extractor.*.proxy`_
Description
| Proxy server used for file downloads.
| Disable the use of a proxy by explicitly setting this option to ``null``.
downloader.http.adjust-extensions
---------------------------------
Type
``bool``
Default
``true``
Description
Check the file headers of ``jpg``, ``png``, and ``gif`` files
and adjust their filename extensions if they do not match.
downloader.http.headers
-----------------------
Type
``object``
Example
``{"Accept": "image/webp,*/*", "Referer": "https://example.org/"}``
Description
Additional HTTP headers to send when downloading files,
downloader.ytdl.format
----------------------
Type
``string``
Default
youtube-dl's default, currently ``"bestvideo+bestaudio/best"``
Description
Video `format selection
<https://github.com/ytdl-org/youtube-dl#format-selection>`__
directly passed to youtube-dl.
downloader.ytdl.forward-cookies
-------------------------------
Type
``bool``
Default
``false``
Description
Forward cookies to youtube-dl.
downloader.ytdl.logging
-----------------------
Type
``bool``
Default
``true``
Description
Route youtube-dl's output through gallery-dl's logging system.
Otherwise youtube-dl will write its output directly to stdout/stderr.
Note: Set ``quiet`` and ``no_warnings`` in
`downloader.ytdl.raw-options`_ to ``true`` to suppress all output.
downloader.ytdl.module
----------------------
Type
``string``
Default
``null``
Description
Name of the youtube-dl Python module to import.
Setting this to ``null`` will first try to import ``"yt_dlp"``
and use ``"youtube_dl"`` as fallback.
downloader.ytdl.outtmpl
-----------------------
Type
``string``
Default
``null``
Description
The `Output Template <https://github.com/ytdl-org/youtube-dl#output-template>`__
used to generate filenames for files downloaded with youtube-dl.
Special values:
* ``null``: generate filenames with `extractor.*.filename`_
* ``"default"``: use youtube-dl's default, currently ``"%(title)s-%(id)s.%(ext)s"``
Note: An output template other than ``null`` might
cause unexpected results in combination with other options
(e.g. ``"skip": "enumerate"``)
downloader.ytdl.raw-options
---------------------------
Type
``object``
Example
.. code:: json
{
"quiet": true,
"writesubtitles": true,
"merge_output_format": "mkv"
}
Description
Additional options passed directly to the ``YoutubeDL`` constructor.
All available options can be found in `youtube-dl's docstrings
<https://github.com/ytdl-org/youtube-dl/blob/master/youtube_dl/YoutubeDL.py#L138-L318>`__.
downloader.ytdl.cmdline-args
----------------------------
Type
* ``string``
* ``list`` of ``strings``
Example
* ``"--quiet --write-sub --merge-output-format mkv"``
* ``["--quiet", "--write-sub", "--merge-output-format", "mkv"]``
Description
Additional options specified as youtube-dl command-line arguments.
downloader.ytdl.config-file
---------------------------
Type
|Path|_
Example
``"~/.config/youtube-dl/config"``
Description
Location of a youtube-dl configuration file to load options from.
Output Options
==============
output.mode
-----------
Type
``string``
Default
``"auto"``
Description
Controls the output string format and status indicators.
* ``"null"``: No output
* ``"pipe"``: Suitable for piping to other processes or files
* ``"terminal"``: Suitable for the standard Windows console
* ``"color"``: Suitable for terminals that understand ANSI escape codes and colors
* ``"auto"``: Automatically choose the best suitable output mode
output.shorten
--------------
Type
``bool``
Default
``true``
Description
Controls whether the output strings should be shortened to fit
on one console line.
Set this option to ``"eaw"`` to also work with east-asian characters
with a display width greater than 1.
output.colors
-------------
Type
``object``
Default
``{"success": "1;32", "skip": "2"}``
Description
Controls the `ANSI colors <https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797#colors--graphics-mode>`__
used with |mode: color|__ for successfully downloaded or skipped files.
.. __: `output.mode`_
output.ansi
-----------
Type
``bool``
Default
``false``
Description
| On Windows, enable ANSI escape sequences and colored output
| by setting the ``ENABLE_VIRTUAL_TERMINAL_PROCESSING`` flag for stdout and stderr.
output.skip
-----------
Type
``bool``
Default
``true``
Description
Show skipped file downloads.
output.fallback
---------------
Type
``bool``
Default
``true``
Description
Include fallback URLs in the output of ``-g/--get-urls``.
output.private
--------------
Type
``bool``
Default
``false``
Description
Include private fields,
i.e. fields whose name starts with an underscore,
in the output of ``-K/--list-keywords`` and ``-j/--dump-json``.
output.progress
---------------
Type
``bool`` or ``string``
Default
``true``
Description
Controls the progress indicator when *gallery-dl* is run with
multiple URLs as arguments.
* ``true``: Show the default progress indicator
(``"[{current}/{total}] {url}"``)
* ``false``: Do not show any progress indicator
* Any ``string``: Show the progress indicator using this
as a custom `format string`_. Possible replacement keys are
``current``, ``total`` and ``url``.
output.log
----------
Type
``string`` or |Logging Configuration|_
Default
``"[{name}][{levelname}] {message}"``
Description
Configuration for standard logging output to stderr.
If this is a simple ``string``, it specifies
the format string for logging messages.
output.logfile
--------------
Type
|Path|_ or |Logging Configuration|_
Default
``null``
Description
File to write logging output to.
output.unsupportedfile
----------------------
Type
|Path|_ or |Logging Configuration|_
Default
``null``
Description
File to write external URLs unsupported by *gallery-dl* to.
The default format string here is ``"{message}"``.
output.num-to-str
-----------------
Type
``bool``
Default
``false``
Description
Convert numeric values (``integer`` or ``float``) to ``string``
before outputting them as JSON.
Postprocessor Options
=====================
This section lists all options available inside
`Postprocessor Configuration`_ objects.
Each option is titled as ``<name>.<option>``, meaning a post processor
of type ``<name>`` will look for an ``<option>`` field inside its "body".
For example an ``exec`` post processor will recognize
an `async <exec.async_>`__, `command <exec.command_>`__,
and `event <exec.event_>`__ field:
.. code:: json
{
"name" : "exec",
"async" : false,
"command": "...",
"event" : "after"
}
classify.mapping
----------------
Type
``object``
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"]
}
Description
A mapping from directory names to filename extensions that should
be stored in them.
Files with an extension not listed will be ignored and stored
in their default location.
compare.action
--------------
Type
``string``
Default
``"replace"``
Description
The action to take when files do **not** compare as equal.
* ``"replace"``: Replace/Overwrite the old version with the new one
* ``"enumerate"``: Add an enumeration index to the filename of the new
version like `skip = "enumerate" <extractor.*.skip_>`__
compare.equal
-------------
Type
``string``
Default
``"null"``
Description
The action to take when files do compare as equal.
* ``"abort:N"``: Stop the current extractor run
after ``N`` consecutive files compared as equal.
* ``"terminate:N"``: Stop the current extractor run,
including parent extractors,
after ``N`` consecutive files compared as equal.
* ``"exit:N"``: Exit the program
after ``N`` consecutive files compared as equal.
compare.shallow
---------------
Type
``bool``
Default
``false``
Description
Only compare file sizes. Do not read and compare their content.
exec.async
----------
Type
``bool``
Default
``false``
Description
Controls whether to wait for a subprocess to finish
or to let it run asynchronously.
exec.command
------------
Type
``string`` or ``list`` of ``strings``
Example
* ``"convert {} {}.png && rm {}"``
* ``["echo", "{user[account]}", "{id}"]``
Description
The command to run.
* If this is a ``string``, it will be executed using the system's
shell, e.g. ``/bin/sh``. Any ``{}`` will be replaced
with the full path of a file or target directory, depending on
`exec.event`_
* If this is a ``list``, the first element specifies the program
name and any further elements its arguments.
Each element of this list is treated as a `format string`_ using
the files' metadata as well as ``{_path}``, ``{_directory}``,
and ``{_filename}``.
exec.event
----------
Type
``string``
Default
``"after"``
Description
The event for which `exec.command`_ is run.
See `metadata.event`_ for a list of available events.
metadata.mode
-------------
Type
``string``
Default
``"json"``
Description
Selects how to process metadata.
* ``"json"``: write metadata using `json.dump()
<https://docs.python.org/3/library/json.html#json.dump>`_
* ``"tags"``: write ``tags`` separated by newlines
* ``"custom"``: write the result of applying `metadata.content-format`_
to a file's metadata dictionary
* ``"modify"``: add or modify metadata entries
* ``"delete"``: remove metadata entries
metadata.filename
-----------------
Type
``string``
Default
``null``
Example
``"{id}.data.json"``
Description
A `format string`_ to build the filenames for metadata files with.
(see `extractor.filename <extractor.*.filename_>`__)
Using ``"-"`` as filename will write all output to ``stdout``.
If this option is set, `metadata.extension`_ and
`metadata.extension-format`_ will be ignored.
metadata.directory
------------------
Type
``string``
Default
``"."``
Example
``"metadata"``
Description
Directory where metadata files are stored in relative to the
current target location for file downloads.
metadata.extension
------------------
Type
``string``
Default
``"json"`` or ``"txt"``
Description
Filename extension for metadata files that will be appended to the
original file names.
metadata.extension-format
-------------------------
Type
``string``
Example
* ``"{extension}.json"``
* ``"json"``
Description
Custom format string to build filename extensions for metadata
files with, which will replace the original filename extensions.
Note: `metadata.extension`_ is ignored if this option is set.
metadata.event
--------------
Type
``string``
Default
``"file"``
Description
The event for which metadata gets written to a file.
The available events are:
``init``
After post processor initialization
and before the first file download
``finalize``
On extractor shutdown, e.g. after all files were downloaded
``prepare``
Before a file download
``file``
When completing a file download,
but before it gets moved to its target location
``after``
After a file got moved to its target location
``skip``
When skipping a file download
``post``
When starting to download all files of a `post`,
e.g. a Tweet on Twitter or a post on Patreon.
metadata.fields
---------------
Type
* ``list`` of ``strings``
* ``object`` (`field name` -> `format string`_)
Example
* .. code:: json
["blocked", "watching", "status[creator][name]"]
* .. code:: json
{
"blocked" : "***",
"watching" : "\fE 'yes' if watching else 'no'",
"status[username]": "{status[creator][name]!l}"
}
Description
* ``"mode": "delete"``:
A list of metadata field names to remove.
* ``"mode": "modify"``:
An object with metadata field names mapping to a `format string`_
whose result is assigned to said field name.
metadata.content-format
-----------------------
Type
``string`` or ``list`` of ``strings``
Example
* ``"tags:\n\n{tags:J\n}\n"``
* ``["tags:", "", "{tags:J\n}"]``
Description
Custom format string to build the content of metadata files with.
Note: Only applies for ``"mode": "custom"``.
metadata.archive
----------------
Type
|Path|_
Description
File to store IDs of generated metadata files in,
similar to `extractor.*.archive`_.
``archive-format`` and ``archive-prefix`` options,
akin to `extractor.*.archive-format`_ and `extractor.*.archive-prefix`_,
are supported as well.
metadata.mtime
--------------
Type
``bool``
Default
``false``
Description
Set modification times of generated metadata files
according to the accompanying downloaded file.
Enabling this option will only have an effect
*if* there is actual ``mtime`` metadata available, that is
* after a file download (``"event": "file"`` (default), ``"event": "after"``)
* when running *after* an ``mtime`` post processes for the same `event <metadata.event_>`__
For example, a ``metadata`` post processor for ``"event": "post"`` will
*not* be able to set its file's modification time unless an ``mtime``
post processor with ``"event": "post"`` runs *before* it.
mtime.event
-----------
Type
``string``
Default
``"file"``
Description
See `metadata.event`_
mtime.key
---------
Type
``string``
Default
``"date"``
Description
Name of the metadata field whose value should be used.
This value must either be a UNIX timestamp or a
|datetime|_ object.
Note: This option gets ignored if `mtime.value`_ is set.
mtime.value
-----------
Type
``string``
Default
``null``
Example
* ``"{status[date]}"``
* ``"{content[0:6]:R22/2022/D%Y%m%d/}"``
Description
A `format string`_ whose value should be used.
The resulting value must either be a UNIX timestamp or a
|datetime|_ object.
ugoira.extension
----------------
Type
``string``
Default
``"webm"``
Description
Filename extension for the resulting video files.
ugoira.ffmpeg-args
------------------
Type
``list`` of ``strings``
Default
``null``
Example
``["-c:v", "libvpx-vp9", "-an", "-b:v", "2M"]``
Description
Additional FFmpeg command-line arguments.
ugoira.ffmpeg-demuxer
---------------------
Type
``string``
Default
``auto``
Description
FFmpeg demuxer to read and process input files with. Possible values are
* "`concat <https://ffmpeg.org/ffmpeg-formats.html#concat-1>`_" (inaccurate frame timecodes for non-uniform frame delays)
* "`image2 <https://ffmpeg.org/ffmpeg-formats.html#image2-1>`_" (accurate timecodes, requires nanosecond file timestamps, i.e. no Windows or macOS)
* "mkvmerge" (accurate timecodes, only WebM or MKV, requires `mkvmerge <ugoira.mkvmerge-location_>`__)
`"auto"` will select `mkvmerge` if available and fall back to `concat` otherwise.
ugoira.ffmpeg-location
----------------------
Type
|Path|_
Default
``"ffmpeg"``
Description
Location of the ``ffmpeg`` (or ``avconv``) executable to use.
ugoira.mkvmerge-location
------------------------
Type
|Path|_
Default
``"mkvmerge"``
Description
Location of the ``mkvmerge`` executable for use with the
`mkvmerge demuxer <ugoira.ffmpeg-demuxer_>`__.
ugoira.ffmpeg-output
--------------------
Type
``bool``
Default
``true``
Description
Show FFmpeg output.
ugoira.ffmpeg-twopass
---------------------
Type
``bool``
Default
``false``
Description
Enable Two-Pass encoding.
ugoira.framerate
----------------
Type
``string``
Default
``"auto"``
Description
Controls the frame rate argument (``-r``) for FFmpeg
* ``"auto"``: Automatically assign a fitting frame rate
based on delays between frames.
* any other ``string``: Use this value as argument for ``-r``.
* ``null`` or an empty ``string``: Don't set an explicit frame rate.
ugoira.keep-files
-----------------
Type
``bool``
Default
``false``
Description
Keep ZIP archives after conversion.
ugoira.libx264-prevent-odd
--------------------------
Type
``bool``
Default
``true``
Description
Prevent ``"width/height not divisible by 2"`` errors
when using ``libx264`` or ``libx265`` encoders
by applying a simple cropping filter. See this `Stack Overflow
thread <https://stackoverflow.com/questions/20847674>`__
for more information.
This option, when ``libx264/5`` is used, automatically
adds ``["-vf", "crop=iw-mod(iw\\,2):ih-mod(ih\\,2)"]``
to the list of FFmpeg command-line arguments
to reduce an odd width/height by 1 pixel and make them even.
ugoira.mtime
------------
Type
``bool``
Default
``true``
Description
Set modification times of generated ugoira aniomations.
ugoira.repeat-last-frame
------------------------
Type
``bool``
Default
``true``
Description
Allow repeating the last frame when necessary
to prevent it from only being displayed for a very short amount of time.
zip.compression
---------------
Type
``string``
Default
``"store"``
Description
Compression method to use when writing the archive.
Possible values are ``"store"``, ``"zip"``, ``"bzip2"``, ``"lzma"``.
zip.extension
-------------
Type
``string``
Default
``"zip"``
Description
Filename extension for the created ZIP archive.
zip.keep-files
--------------
Type
``bool``
Default
``false``
Description
Keep the actual files after writing them to a ZIP archive.
zip.mode
--------
Type
``string``
Default
``"default"``
Description
* ``"default"``: Write the central directory file header
once after everything is done or an exception is raised.
* ``"safe"``: Update the central directory file header
each time a file is stored in a ZIP archive.
This greatly reduces the chance a ZIP archive gets corrupted in
case the Python interpreter gets shut down unexpectedly
(power outage, SIGKILL) but is also a lot slower.
Miscellaneous Options
=====================
extractor.modules
-----------------
Type
``list`` of ``strings``
Default
The ``modules`` list in
`extractor/__init__.py <../gallery_dl/extractor/__init__.py#L12>`__
Example
``["reddit", "danbooru", "mangadex"]``
Description
The list of modules to load when searching for a suitable
extractor class. Useful to reduce startup time and memory usage.
cache.file
----------
Type
|Path|_
Default
* (``%APPDATA%`` or ``"~"``) + ``"/gallery-dl/cache.sqlite3"`` on Windows
* (``$XDG_CACHE_HOME`` or ``"~/.cache"``) + ``"/gallery-dl/cache.sqlite3"`` on all other platforms
Description
Path of the SQLite3 database used to cache login sessions,
cookies and API tokens across `gallery-dl` invocations.
Set this option to ``null`` or an invalid path to disable
this cache.
format-separator
----------------
Type
``string``
Default
``"/"``
Description
Character(s) used as argument separator in format string
`format specifiers <formatting.md#format-specifiers>`__.
For example, setting this option to ``"#"`` would allow a replacement
operation to be ``Rold#new#`` instead of the default ``Rold/new/``
signals-ignore
--------------
Type
``list`` of ``strings``
Example
``["SIGTTOU", "SIGTTIN", "SIGTERM"]``
Description
The list of signal names to ignore, i.e. set
`SIG_IGN <https://docs.python.org/3/library/signal.html#signal.SIG_IGN>`_
as signal handler for.
warnings
--------
Type
``string``
Default
``"default"``
Description
The `Warnings Filter action <https://docs.python.org/3/library/warnings.html#the-warnings-filter>`__
used for (urllib3) warnings.
pyopenssl
---------
Type
``bool``
Default
``false``
Description
Use `pyOpenSSL <https://www.pyopenssl.org/en/stable/>`__-backed
SSL-support.
API Tokens & IDs
================
All configuration keys listed in this section have fully functional default
values embedded into *gallery-dl* itself, but if things unexpectedly break
or you want to use your own personal client credentials, you can follow these
instructions to get an alternative set of API tokens and IDs.
extractor.deviantart.client-id & .client-secret
-----------------------------------------------
Type
``string``
How To
* login and visit DeviantArt's
`Applications & Keys <https://www.deviantart.com/developers/apps>`__
section
* click "Register Application"
* scroll to "OAuth2 Redirect URI Whitelist (Required)"
and enter "https://mikf.github.io/gallery-dl/oauth-redirect.html"
* scroll to the bottom and agree to the API License Agreement.
Submission Policy, and Terms of Service.
* click "Save"
* copy ``client_id`` and ``client_secret`` of your new
application and put them in your configuration file
as ``"client-id"`` and ``"client-secret"``
* clear your `cache <cache.file_>`__ to delete any remaining
``access-token`` entries. (``gallery-dl --clear-cache deviantart``)
* get a new `refresh-token <extractor.deviantart.refresh-token_>`__ for the
new ``client-id`` (``gallery-dl oauth:deviantart``)
extractor.flickr.api-key & .api-secret
--------------------------------------
Type
``string``
How To
* login and `Create an App <https://www.flickr.com/services/apps/create/apply/>`__
in Flickr's `App Garden <https://www.flickr.com/services/>`__
* click "APPLY FOR A NON-COMMERCIAL KEY"
* fill out the form with a random name and description
and click "SUBMIT"
* copy ``Key`` and ``Secret`` and put them in your configuration
file
extractor.reddit.client-id & .user-agent
----------------------------------------
Type
``string``
How To
* login and visit the `apps <https://www.reddit.com/prefs/apps/>`__
section of your account's preferences
* click the "are you a developer? create an app..." button
* fill out the form, choose "installed app", preferably set
"http://localhost:6414/" as "redirect uri" and finally click
"create app"
* copy the client id (third line, under your application's name and
"installed app") and put it in your configuration file
* use "``Python:<application name>:v1.0 (by /u/<username>)``" as
user-agent and replace ``<application name>`` and ``<username>``
accordingly (see Reddit's
`API access rules <https://github.com/reddit/reddit/wiki/API>`__)
extractor.smugmug.api-key & .api-secret
---------------------------------------
Type
``string``
How To
* login and `Apply for an API Key <https://api.smugmug.com/api/developer/apply>`__
* use a random name and description,
set "Type" to "Application", "Platform" to "All",
and "Use" to "Non-Commercial"
* fill out the two checkboxes at the bottom and click "Apply"
* copy ``API Key`` and ``API Secret``
and put them in your configuration file
extractor.tumblr.api-key & .api-secret
--------------------------------------
Type
``string``
How To
* login and visit Tumblr's
`Applications <https://www.tumblr.com/oauth/apps>`__ section
* click "Register application"
* fill out the form: use a random name and description, set
https://example.org/ as "Application Website" and "Default
callback URL"
* solve Google's "I'm not a robot" challenge and click "Register"
* click "Show secret key" (below "OAuth Consumer Key")
* copy your ``OAuth Consumer Key`` and ``Secret Key``
and put them in your configuration file
Custom Types
============
Date
----
Type
* ``string``
* ``integer``
Example
* ``"2019-01-01T00:00:00"``
* ``"2019"`` with ``"%Y"`` as `date-format`_
* ``1546297200``
Description
A |Date|_ value represents a specific point in time.
* If given as ``string``, it is parsed according to `date-format`_.
* If given as ``integer``, it is interpreted as UTC timestamp.
Duration
--------
Type
* ``float``
* ``list`` with 2 ``floats``
* ``string``
Example
* ``2.85``
* ``[1.5, 3.0]``
* ``"2.85"``, ``"1.5-3.0"``
Description
A |Duration|_ represents a span of time in seconds.
* If given as a single ``float``, it will be used as that exact value.
* If given as a ``list`` with 2 floating-point numbers ``a`` & ``b`` ,
it will be randomly chosen with uniform distribution such that ``a <= N <=b``.
(see `random.uniform() <https://docs.python.org/3/library/random.html#random.uniform>`_)
* If given as a ``string``, it can either represent a single ``float``
value (``"2.85"``) or a range (``"1.5-3.0"``).
Path
----
Type
* ``string``
* ``list`` of ``strings``
Example
* ``"file.ext"``
* ``"~/path/to/file.ext"``
* ``"$HOME/path/to/file.ext"``
* ``["$HOME", "path", "to", "file.ext"]``
Description
A |Path|_ is a ``string`` representing the location of a file
or directory.
Simple `tilde expansion <https://docs.python.org/3/library/os.path.html#os.path.expanduser>`__
and `environment variable expansion <https://docs.python.org/3/library/os.path.html#os.path.expandvars>`__
is supported.
In Windows environments, backslashes (``"\"``) can, in addition to
forward slashes (``"/"``), be used as path separators.
Because backslashes are JSON's escape character,
they themselves have to be escaped.
The path ``C:\path\to\file.ext`` has therefore to be written as
``"C:\\path\\to\\file.ext"`` if you want to use backslashes.
Logging Configuration
---------------------
Type
``object``
Example
.. code:: json
{
"format" : "{asctime} {name}: {message}",
"format-date": "%H:%M:%S",
"path" : "~/log.txt",
"encoding" : "ascii"
}
.. code:: json
{
"level" : "debug",
"format": {
"debug" : "debug: {message}",
"info" : "[{name}] {message}",
"warning": "Warning: {message}",
"error" : "ERROR: {message}"
}
}
Description
Extended logging output configuration.
* format
* General format string for logging messages
or a dictionary with format strings for each loglevel.
In addition to the default
`LogRecord attributes <https://docs.python.org/3/library/logging.html#logrecord-attributes>`__,
it is also possible to access the current
`extractor <https://github.com/mikf/gallery-dl/blob/33fe67b594dbf8fb742464c95e0f6952bb60eb8a/gallery_dl/extractor/common.py#L23>`__,
`job <https://github.com/mikf/gallery-dl/blob/33fe67b594dbf8fb742464c95e0f6952bb60eb8a/gallery_dl/job.py#L18>`__,
`path <https://github.com/mikf/gallery-dl/blob/33fe67b594dbf8fb742464c95e0f6952bb60eb8a/gallery_dl/util.py#L702>`__,
and `keywords` objects and their attributes, for example
``"{extractor.url}"``, ``"{path.filename}"``, ``"{keywords.title}"``
* Default: ``"[{name}][{levelname}] {message}"``
* format-date
* Format string for ``{asctime}`` fields in logging messages
(see `strftime() directives <https://docs.python.org/3/library/time.html#time.strftime>`__)
* Default: ``"%Y-%m-%d %H:%M:%S"``
* level
* Minimum logging message level
(one of ``"debug"``, ``"info"``, ``"warning"``, ``"error"``, ``"exception"``)
* Default: ``"info"``
* path
* |Path|_ to the output file
* mode
* Mode in which the file is opened;
use ``"w"`` to truncate or ``"a"`` to append
(see `open() <https://docs.python.org/3/library/functions.html#open>`__)
* Default: ``"w"``
* encoding
* File encoding
* Default: ``"utf-8"``
Note: path, mode, and encoding are only applied when configuring
logging output to a file.
Postprocessor Configuration
---------------------------
Type
``object``
Example
.. code:: json
{ "name": "mtime" }
.. code:: json
{
"name" : "zip",
"compression": "store",
"extension" : "cbz",
"filter" : "extension not in ('zip', 'rar')",
"whitelist" : ["mangadex", "exhentai", "nhentai"]
}
Description
An ``object`` containing a ``"name"`` attribute specifying the
post-processor type, as well as any of its `options <Postprocessor Options_>`__.
It is possible to set a ``"filter"`` expression similar to
`image-filter <extractor.*.image-filter_>`_ to only run a post-processor
conditionally.
It is also possible set a ``"whitelist"`` or ``"blacklist"`` to
only enable or disable a post-processor for the specified
extractor categories.
The available post-processor types are
``classify``
Categorize files by filename extension
``compare``
| Compare versions of the same file and replace/enumerate them on mismatch
| (requires `downloader.*.part`_ = ``true`` and `extractor.*.skip`_ = ``false``)
``exec``
Execute external commands
``metadata``
Write metadata to separate files
``mtime``
Set file modification time according to its metadata
``ugoira``
Convert Pixiv Ugoira to WebM using `FFmpeg <https://www.ffmpeg.org/>`__
``zip``
Store files in a ZIP archive
.. |.netrc| replace:: ``.netrc``
.. |requests.request()| replace:: ``requests.request()``
.. |timeout| replace:: ``timeout``
.. |verify| replace:: ``verify``
.. |mature_content| replace:: ``mature_content``
.. |webbrowser.open()| replace:: ``webbrowser.open()``
.. |datetime| replace:: ``datetime``
.. |datetime.max| replace:: ``datetime.max``
.. |Date| replace:: ``Date``
.. |Duration| replace:: ``Duration``
.. |Path| replace:: ``Path``
.. |Last-Modified| replace:: ``Last-Modified``
.. |Logging Configuration| replace:: ``Logging Configuration``
.. |Postprocessor Configuration| replace:: ``Postprocessor Configuration``
.. |strptime| replace:: strftime() and strptime() Behavior
.. |postprocessors| replace:: ``postprocessors``
.. |mode: color| replace:: ``"mode": "color"``
.. _base-directory: `extractor.*.base-directory`_
.. _date-format: `extractor.*.date-format`_
.. _deviantart.metadata: `extractor.deviantart.metadata`_
.. _postprocessors: `extractor.*.postprocessors`_
.. _download archive: `extractor.*.archive`_
.. _.netrc: https://stackoverflow.com/tags/.netrc/info
.. _Last-Modified: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.29
.. _datetime: https://docs.python.org/3/library/datetime.html#datetime-objects
.. _datetime.max: https://docs.python.org/3/library/datetime.html#datetime.datetime.max
.. _strptime: https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior
.. _webbrowser.open(): https://docs.python.org/3/library/webbrowser.html
.. _mature_content: https://www.deviantart.com/developers/http/v1/20160316/object/deviation
.. _Authentication: https://github.com/mikf/gallery-dl#authentication
.. _OAuth: https://github.com/mikf/gallery-dl#oauth
.. _format string: https://github.com/mikf/gallery-dl/blob/master/docs/formatting.md
.. _format strings: https://github.com/mikf/gallery-dl/blob/master/docs/formatting.md
.. _youtube-dl: https://github.com/ytdl-org/youtube-dl
.. _requests.request(): https://requests.readthedocs.io/en/master/api/#requests.request
.. _timeout: https://requests.readthedocs.io/en/master/user/advanced/#timeouts
.. _verify: https://requests.readthedocs.io/en/master/user/advanced/#ssl-cert-verification
.. _`Requests' proxy documentation`: https://requests.readthedocs.io/en/master/user/advanced/#proxies
Reference in New Issue View Git Blame Copy Permalink