Installation

Installation

Pip

The stable releases of gallery-dl are distributed on PyPI and can be easily installed or upgraded using pip:

   python3 -m pip install -U gallery-dl

Installing the latest dev version directly from GitHub can be done with pip as well:

  python3 -m pip install -U -I --no-deps --no-cache-dir https://github.com/mikf/gallery-dl/archive/master.tar.gz

Note: Windows users should use py -3 instead of python3.

It is advised to use the latest version of PyPI, including the essential packages setuptools and wheel. To ensure these packages are up-to-date, run:

python3 -m pip install --upgrade pip setuptools wheel

Standalone Executable

Prebuilt executable files with a Python interpreter and required Python packages included are available for:

• Windows (Requires Microsoft Visual C++ Redistributable Package (x86)
• Linux

Nightly Builds

Executables built from the latest commit can be found at https://github.com/gdl-org/builds/releases

Snap

Linux users that are using a distro that is supported by Snapd can install gallery-dl from the Snap Store:

snap install gallery-dl

Chocolatey

Windows users that have Chocolatey installed can install gallery-dl from the Chocolatey Community Packages repository:

choco install gallery-dl

Scoop

gallery-dl is also available in the Scoop "main" bucket for Windows users:

  scoop install gallery-dl

Homebrew

For macOS or Linux users using Homebrew:

   brew install gallery-dl

MacPorts

For macOS users with MacPorts:

 sudo port install gallery-dl

Docker

Using the Dockerfile in the repository:

   git clone https://github.com/mikf/gallery-dl.git
   cd gallery-dl/
   docker build -t gallery-dl:latest .

Pulling image from Docker Hub:

   docker pull mikf123/gallery-dl
   docker tag mikf123/gallery-dl gallery-dl

Pulling image from GitHub Container Registry:

    docker pull ghcr.io/mikf/gallery-dl
    docker tag ghcr.io/mikf/gallery-dl gallery-dl

To run the container you will probably want to attach some directories on the host so that the config file and downloads can persist across runs.

Make sure to either download the example config file reference in the repo and place it in the mounted volume location or touch an empty file there.

If you gave the container a different tag or are using podman then make sure you adjust. Run docker image ls to check the name if you are not sure.

This will remove the container after every use so you will always have a fresh environment for it to run. If you setup a ci-cd pipeline to autobuild the container you can also add a --pull=newer flag so that when you run it docker will check to see if there is a newer container and download it before running.

   docker run --rm  -v $HOME/Downloads/:/gallery-dl/ -v $HOME/.config/gallery-dl/gallery-dl.conf:/etc/gallery-dl.conf -it gallery-dl:latest

You can also add an alias to your shell for "gallery-dl" or create a simple bash script and drop it somewhere in your $PATH to act as a shim for this command.