GALLERY-DL.CONF(5)

NAME
gallery-dl.conf - gallery-dl configuration file

DESCRIPTION
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
{
    "base-directory": "/tmp/",
    "extractor": {
        "pixiv": {
            "directory": ["Pixiv", "Works", "{user[id]}"],
            "filename": "{id}{num}.{extension}",
            "username": "foo",
            "password": "bar"
        },
        "flickr": {
            "_comment": "OAuth keys for account 'foobar'",
            "access-token": "0123456789-0123456789abcdef",
            "access-token-secret": "fedcba9876543210"
        }
    },
    "downloader": {
        "retries": 3,
        "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 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 the base for all download destinations.

  extractor.*.skip

Type:
    bool or string

Default:
    true

Description:
    Controls the behavior when downloading files whose filename already exists. * 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

  extractor.*.sleep

Type:
    float

Default:
    0

Description:
    Number of seconds to sleep before each download.

  extractor.*.username & .password

Type:
    string

Default:
    null

Description:
    The username and password to use when attempting to log in to another site. Specifying username and password is required for the pixiv, nijie and seiga modules and optional (but strongly recommended) for danbooru, exhentai, sankaku and idolcomplex. These values can also be set via the -u/--username and -p/--password command-line options or by using a .netrc file. (see Authentication_) Note: The password for danbooru is the API key found in your user profile, not the password for your account.

  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. * If this is a Path, it specifies a Mozilla/Netscape format cookies.txt file. * If this is an object, its key-value pairs, which should both be strings, will be used as cookie-names and -values.

  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:62.0) Gecko/20100101 Firefox/62.0"

Description:
    User-Agent header value to be used for HTTP requests. Note: This option has no effect on pixiv and readcomiconline 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.*.archive

Type:
    Path

Default:
    null

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.

  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": "zip"}, {"name": "exec", "command": ["/home/foobar/script", "{category}", "{image_id}"]} ]

Description:
    A list of post-processors to be applied to each downloaded file in the same order as they are specified.

  extractor.*.retries

Type:
    integer

Default:
    5

Description:
    Number of times a failed HTTP request is retried before giving up.

  extractor.*.timeout

Type:
    float or null

Default:
    30

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.*.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 images 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

Description:
    Like image-filter, but applies to delegated URLs like manga-chapters, etc.

EXTRACTOR-SPECIFIC OPTIONS

  extractor.artstation.external

Type:
    bool

Default:
    false

Description:
    Try to follow external URLs of embedded players.

  extractor.deviantart.extra

Type:
    bool

Default:
    false

Description:
    Download extra Sta.sh resources from description texts. 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.

  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.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.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.

  extractor.deviantart.wait-min

Type:
    integer

Default:
    0

Description:
    Minimum wait time in seconds before API requests. Note: This value will internally be rounded up to the next power of 2.

  extractor.exhentai.limits

Type:
    bool

Default:
    true

Description:
    Check image download limits and stop extraction when they are exceeded.

  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.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.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.kissmanga.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.oauth.browser

Type:
    bool

Default:
    true

Description:
    Controls how a user is directed to an OAuth authorization site. * true: Use Python's webbrowser.open() method to automatically open the URL in the user's browser. * false: Ask the user to copy & paste an URL from the terminal.

  extractor.photobucket.subalbums

Type:
    bool

Default:
    true

Description:
    Download subalbums.

  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 the single animation frames in JPEG format.

  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.recursive.blacklist

Type:
    list of strings

Default:
    ["directlink", "oauth", "recursive", "test"]

Description:
    A list of extractor categories which should be ignored when using the recursive extractor.

  extractor.reddit.comments

Type:
    integer or string

Default:
    500

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:
    integer or string

Default:
    0 and 253402210800 (timestamp of datetime.max)

Description:
    Ignore all submissions posted before/after this date. * If this is an integer, it represents the date as UTC timestamp. * If this is a string, it will get parsed according to date-format_.

  extractor.reddit.date-format

Type:
    string

Default:
    "%Y-%m-%dT%H:%M:%S"

Description:
    An explicit format string used to parse the string values of date-min and date-max. See strptime for a list of formatting directives.

  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.sankaku.wait-min & .wait-max

Type:
    float

Default:
    3.0 and 6.0

Description:
    Minimum and maximum wait time in seconds between each image Sankaku Channel responds with 429 Too Many Requests if it receives too many HTTP requests in a certain amount of time. Waiting a few seconds between each request tries to prevent that.

  extractor.smugmug.videos

Type:
    bool

Default:
    true

Description:
    Download video files.

  extractor.tumblr.avatar

Type:
    bool

Default:
    false

Description:
    Download blog avatars.

  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.retweets

Type:
    bool

Default:
    true

Description:
    Extract images from retweets.

  extractor.twitter.videos

Type:
    bool

Default:
    false

Description:
    Use youtube-dl to download from video tweets.

  extractor.wallhaven.api-key

Type:
    string

Default:
    null

Description:
    Your 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.[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.*.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

Examples:
    "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:
    Number of retries during file downloads.

  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.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.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.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.

  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:
    list of strings

Example:
    ["echo", "{user[account]}", "{id}"]

Description:
    The command to run. Each element of this list is treated as a format string using the files' metadata.

  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.format to a file's metadata dictionary

  metadata.extension

Type:
    string

Default:
    "json" or "txt"

Description:
    Filename extension for metadata files.

  metadata.format

Type:
    string

Example:
    "tags:\n\n{tags:J\n}\n"

Description:
    Custom format string to build content of metadata files. Note: Only applies for "mode": "custom".

  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 <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.

  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.

MISCELLANEOUS OPTIONS

  cache.file

Type:
    Path

Default:
    tempfile.gettempdir() + ".gallery-dl.cache"

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.

API TOKENS & 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 your Application" * scroll to "OAuth2 Redirect URI Whitelist (Required)" and enter "https://mikf.github.io/gallery-dl/oauth-redirect.html" * click "Save" (top right) * copy client_id and client_secret of your new application and put them in your configuration file

  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.pawoo.access-token

Type:
    string

How To
    :" 4

  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

  Path

Type:
    string or list of strings

Examples:
    * "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:
    { "format": "{asctime} {name}: {message}", "format-date": "%H:%M:%S", "path": "~/log.txt", "encoding": "ascii" }

Description:
    Extended logging output configuration. * format * Format string for logging messages 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/2e516a1e3e09cb8a9e36a8f6f7e41ce8d4402f5a/gallery_dl/extractor/common.py#L24> and job <https://github.com/mikf/gallery-dl/blob/2e516a1e3e09cb8a9e36a8f6f7e41ce8d4402f5a/gallery_dl/job.py#L19> objects as well as their attributes (e.g. "{extractor.url}") * 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:
    { "name": "zip", "compression": "store", "extension": "cbz", "whitelist": ["mangadex", "exhentai", "nhentai"] }

Description:
    An object with the name of a post-processor and its options. See Postprocessor Options for a list of all available post-processors and their respective options. You can also set a whitelist or blacklist to only enable or disable a post-processor for the specified extractor categories.

BUGS
https://github.com/mikf/gallery-dl/issues

AUTHORS
Mike Fährmann <mike_faehrmann@web.de>
and https://github.com/mikf/gallery-dl/graphs/contributors

SEE ALSO
gallery-dl(1)