Skip to content
SpiffyChatterbox edited this page Aug 10, 2024 · 3 revisions

Configuration

Configuration files for gallery-dl use a JSON-based file format.

Documentation

A list of all available configuration options and their descriptions can be found at https://gdl-org.github.io/docs/configuration.html.

For a default configuration file with available options set to their default values, see docs/gallery-dl.conf.

For a commented example with more involved settings and option usage, see docs/gallery-dl-example.conf.

Locations

gallery-dl searches for configuration files in the following places:

Windows:

  • %APPDATA%\gallery-dl\config.json

  • %USERPROFILE%\gallery-dl\config.json

  • %USERPROFILE%\gallery-dl.conf

    (%USERPROFILE% usually refers to a user's home directory, i.e. C:\Users\<username>\)

Linux, macOS, etc.:

  • /etc/gallery-dl.conf
  • ${XDG_CONFIG_HOME}/gallery-dl/config.json
  • ${HOME}/.config/gallery-dl/config.json
  • ${HOME}/.gallery-dl.conf

When run as executable, gallery-dl will also look for a gallery-dl.conf file in the same directory as said executable.

It is possible to use more than one configuration file at a time. In this case, any values from files after the first will get merged into the already loaded settings and potentially override previous ones.

More Reading

Still having trouble understanding the configuration file? Here's a more detailed breakdown that walks through some examples.