- buster-backports 1.17.2-1~bpo10+1
- testing 1.18.0-1
- unstable 1.18.2-1
GALLERY-DL.CONF(5) | gallery-dl Manual | GALLERY-DL.CONF(5) |
NAME¶
gallery-dl.conf - gallery-dl configuration fileDESCRIPTION¶
gallery-dl will search for configuration files in the following places every time it is started, unless --ignore-config is specified:/etc/gallery-dl.conf $HOME/.config/gallery-dl/config.json $HOME/.gallery-dl.conf
It is also possible to specify additional configuration files with the -c/--config command-line option or to add further option values with -o/--option as <key>=<value> pairs,
Configuration files are JSON-based and therefore don't allow any ordinary comments, but, since unused keys are simply ignored, it is possible to utilize those as makeshift comments by settings their values to arbitrary strings.
EXAMPLE¶
{"extractor": {
"filename": "{id}{num}.{extension}",
"username": "foo",
"password": "bar"
"flickr": {
"access-token": "0123456789-0123456789abcdef",
"access-token-secret": "fedcba9876543210"
"downloader": {
"timeout": 2.5
EXTRACTOR OPTIONS¶
extractor.*.filename¶
- Type:
- string
- Example:
- "{manga}_c{chapter}_{page:>03}.{extension}"
- Description:
- A format string to build the resulting filename for a downloaded
file.
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:
$ 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
- Example:
- ["{category}", "{manga}", "c{chapter} - {title}"]
- Description:
- A list of format strings for the resulting target directory.
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 for any spawned 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 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-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.*.extension-map¶
- Type:
- object
- Default:
-
{ "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.
* true: Skip downloads
* false: Overwrite already existing files* "abort": Abort the current extractor run
* "abort:N": Skip downloads and abort extractor run 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:
- float
- Default:
- 0
- Description:
- Number of seconds to sleep before each download.
extractor.*.sleep-extractor¶
- Type:
- float
- Default:
- 0
- Description:
- Number of seconds to sleep before handling an input URL, i.e. before starting a new extractor.
extractor.*.sleep-request¶
- Type:
- float
- 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
* seigaand optional for
* aryion
* danbooru
* e621
* exhentai
* idolcomplex
* inkbunny
* instagram
* luscious
* pinterest
* sankaku
* subscribestar
* tsumino
* twitterThese values can also be specified via the -u/--username and -p/--password command-line options or by using a .netrc file. (see Authentication_)
Note: 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
- Default:
- null
- Description:
- Source to read additional cookies from. Either as
* the Path to a Mozilla/Netscape format cookies.txt file or
* a JSON object specifying cookies as a name-to-value mappingExample:
{ "cookie-name": "cookie-value", "sessionid" : "14313336321%3AsabDFvuASDnlpb%3A31", "isAdult" : "1" }
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:
{ "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.*.user-agent¶
- Type:
- string
- Default:
- "Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Firefox/68.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.*.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.*.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
- Description:
- A list of extractor categories to ignore (or allow) when spawning child
extractors for unknown URLs, e.g. from reddit or plurk.
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.
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 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.*.postprocessors¶
- Type:
- list of Postprocessor Configuration objects
- Example:
-
[ { "name": "zip" , "compression": "store" }, { "name": "exec", "command": ["/home/foobar/script", "{category}", "{image_id}"] } ]
- Description:
- A list of post processors 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 --execwill 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.*.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, 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, 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, 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.blogger.videos¶
- Type:
- bool
- Default:
- true
- Description:
- Download embedded videos hosted on https://www.blogger.com/
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, to use your account's browsing settings and filters.
extractor.derpibooru.filter¶
- Type:
- integer
- Default:
- 56027 (Everything 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.
See Filters for details.
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.quality¶
- Type:
- integer
- Default:
- 100
- Description:
- JPEG quality level of newer images for which an original file download is not available.
extractor.deviantart.refresh-token¶
- Type:
- string
- Default:
- null
- Description:
- The refresh-token value you get from linking your DeviantArt
account to gallery-dl.
Using a refresh-token allows you to access private or otherwise not publicly available deviations.
Note: The refresh-token becomes invalid after 3 months or whenever your 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:
- bool or integer
- Default:
- true
- Description:
- Check image download limits and stop extraction when they are exceeded.
If this value is an integer, it gets used as the limit maximum instead of the value listed on https://e-hentai.org/home.php
extractor.exhentai.original¶
- Type:
- bool
- Default:
- true
- Description:
- Download full-sized original images if available.
extractor.exhentai.wait-min & .wait-max¶
- Type:
- float
- Default:
- 3.0 and 6.0
- Description:
- Minimum and maximum wait time in seconds between each image
ExHentai detects and blocks automated downloaders. *gallery-dl* waits a randomly selected number of seconds between wait-min and wait-max after each image to prevent getting blocked.
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.
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.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.gelbooru.api¶
- Type:
- bool
- Default:
- true
- Description:
- Enable use of Gelbooru's API.
Set this value to false if the API has been disabled to switch to manual information extraction.
extractor.gfycat.format¶
- Type:
- string
- Default:
- "mp4"
- Description:
- The name of the preferred animation format, which can be one of
"mp4", "webm", "gif",
"webp" or "mjpg".
If the selected format is not available, "mp4", "webm" and "gif" (in that order) will be tried instead, until an available format is found.
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.metadata¶
- Type:
- bool
- Default:
- true
- Description:
- Try to extract artist, group, parody, and characters metadata.
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 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", "stories", "highlights", "channel".
You can use "all" instead of listing all values separately.
extractor.instagram.videos¶
- Type:
- bool
- Default:
- true
- Description:
- Download video files.
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.newgrounds.flash¶
- Type:
- bool
- Default:
- true
- Description:
- Download original Adobe Flash animations instead of pre-rendered videos.
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".
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.
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.photobucket.subalbums¶
- Type:
- bool
- Default:
- true
- Description:
- Download subalbums.
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.user.avatar¶
- Type:
- bool
- Default:
- false
- Description:
- Download user avatars.
extractor.pixiv.work.related¶
- Type:
- bool
- Default:
- false
- Description:
- Also download related artworks.
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__)
extractor.plurk.comments¶
- Type:
- bool
- Default:
- false
- Description:
- Also search Plurk comments for URLs.
extractor.reactor.wait-min & .wait-max¶
- Type:
- float
- Default:
- 3.0 and 6.0
- Description:
- Minimum and maximum wait time in seconds between HTTP requests during the extraction process.
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.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.
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:
- string
- Default:
- "mp4"
- Description:
- The name of the preferred format, which can be one of
"mp4", "webm", "gif",
"webp", "mobile", or
"mini".
If the selected format is not available, "mp4", "webm" and "gif" (in that order) will be tried instead, until an available format is found.
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.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.twitter.cards¶
- Type:
- bool
- Default:
- false
- Description:
- Fetch media from Cards.
extractor.twitter.quoted¶
- Type:
- bool
- Default:
- true
- Description:
- Fetch media from quoted Tweets.
extractor.twitter.replies¶
- Type:
- bool
- Default:
- true
- Description:
- Fetch media from replies to other Tweets.
extractor.twitter.retweets¶
- Type:
- bool
- Default:
- true
- 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.twitpic¶
- Type:
- bool
- Default:
- false
- Description:
- Extract TwitPic embeds.
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, 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, to use your account's browsing settings and filters.
extractor.weibo.retweets¶
- Type:
- bool
- Default:
- true
- Description:
- Extract media from retweeted posts.
extractor.weibo.videos¶
- Type:
- bool
- Default:
- true
- Description:
- Download video files.
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.[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
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.*.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.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.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.outtmpl¶
- Type:
- string
- Default:
- null
- Description:
- The 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:
-
{ "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>.
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.
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¶
classify.mapping¶
- Type:
- object
- Default:
-
{ "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"
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:
- Select how to write metadata.
* "json": all metadata using json.dump() <https://docs.python.org/3/library/json.html#json.dump>
* "tags": tags separated by newlines
* "custom": result of applying metadata.content-format to a file's metadata dictionary
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)
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 procesor 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.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".
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.
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-location¶
- Type:
- Path
- Default:
- "ffmpeg"
- Description:
- Location of the ffmpeg (or avconv) executable to use.
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 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.
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
- 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.
ciphers¶
- Type:
- bool or string
- Default:
- true
- Description:
-
* true: Update urllib3's default cipher list
* false: Leave the default cipher list as is
* Any string: Replace urllib3's default ciphers with these (See SSLContext.set_ciphers() for details)
pyopenssl¶
- Type:
- bool
- Default:
- false
- Description:
- Use pyOpenSSL-backed SSL-support.
API TOKENS & IDS¶
extractor.deviantart.client-id & .client-secret¶
- Type:
- string
- How To:
-
* login and visit DeviantArt's Applications & Keys 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 to delete any remaining access-token entries. (gallery-dl --clear-cache)
* get a new 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 in Flickr's App Garden
* 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 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)
extractor.smugmug.api-key & .api-secret¶
- Type:
- string
- How To:
-
* login and Apply for an API Key
* 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 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 or 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.
Path¶
- Type:
- string or 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 and environment variable expansion 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:
-
{ "format" : "{asctime} {name}: {message}", "format-date": "%H:%M:%S", "path" : "~/log.txt", "encoding" : "ascii" }
{ "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, it is also possible to access the current extractor, job, path, 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)
* 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())
* 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:
-
{ "name": "mtime" }
{ "name" : "zip", "compression": "store", "extension" : "cbz", "whitelist" : ["mangadex", "exhentai", "nhentai"] }
- Description:
- An object containing a "name" attribute specifying
the post-processor type, as well as any of its options. 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 zip Store files in a ZIP archive
BUGS¶
https://github.com/mikf/gallery-dl/issuesAUTHORS¶
Mike Fährmann <mike_faehrmann@web.de>and https://github.com/mikf/gallery-dl/graphs/contributors
SEE ALSO¶
gallery-dl(1)2021-02-14 | 1.16.5 |