mikf / gallery-dl

==========
gallery-dl
==========
*gallery-dl* is a command-line program
to download image galleries and collections
from several image hosting sites
(see `Supported Sites `__).
It is a cross-platform tool
with many
`command-line `__ and
`configuration `__
options, as well as powerful
`file-naming capabilities `__.
-----
Migration
=========
| Active development has moved to `Codeberg `__
| (see `[Announcement] Moving to Codeberg `__ for details)
-----
.. contents::
|pypi| |discord| |build|
Dependencies
============
- Python_ 3.8+
- Requests_
Optional
--------
- yt-dlp_ or youtube-dl_: HLS/DASH video downloads, ``ytdl`` integration
- FFmpeg_: Pixiv Ugoira conversion
- mkvmerge_: Accurate Ugoira frame timecodes
- PySocks_: SOCKS proxy support
- brotli_ or brotlicffi_: Brotli compression support
- zstandard_: Zstandard compression support
- PyYAML_: YAML configuration file support
- toml_: TOML configuration file support for Python `__
 (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:
.. code:: bash
 snap install gallery-dl
Chocolatey
----------
Windows users that have Chocolatey_ installed can install *gallery-dl* from the Chocolatey Community Packages repository:
.. code:: powershell
 choco install gallery-dl
Scoop
-----
*gallery-dl* is also available in the Scoop_ "main" bucket for Windows users:
.. code:: powershell
 scoop install gallery-dl
Homebrew
--------
For macOS or Linux users using Homebrew:
.. code:: bash
 brew install gallery-dl
MacPorts
--------
For macOS users with MacPorts:
.. code:: bash
 sudo port install gallery-dl
Docker
--------
Using the Dockerfile in the repository:
.. code:: bash
 git clone https://codeberg.org/mikf/gallery-dl.git
 cd gallery-dl/
 docker build -t gallery-dl:latest .
Pulling image from `Docker Hub `__:
.. code:: bash
 docker pull mikf123/gallery-dl
 docker tag mikf123/gallery-dl gallery-dl
Pulling image from `GitHub Container Registry `__:
.. code:: bash
 docker pull ghcr.io/mikf/gallery-dl
 docker tag ghcr.io/mikf/gallery-dl gallery-dl
Pulling *Nightly Build* images built from the latest commit by using the ``dev`` tag:
.. code:: bash
 docker pull mikf123/gallery-dl:dev
 docker pull ghcr.io/mikf/gallery-dl:dev
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 env