search

qx6ghqkz / gallery-dl-server

Web UI for downloading media with gallery-dl and yt-dlp.
MIT License
4 stars 2 forks source link

readme

Docker Stars Shield Docker Pulls Shield GitHub license

gallery-dl-server

Web UI for gallery-dl with support for downloading videos via yt-dlp.

screenshot

Running

Docker CLI

This example uses the docker run command to create the container to run the app.

docker run -d \
  --name gallery-dl-server \
  --user 1000:1000 \
  -p 9080:9080 \
  --mount type=bind,source="/path/to/data",target=/etc \
  --mount type=bind,source="/path/to/downloads",target=/gallery-dl \
  --restart unless-stopped \
  qx6ghqkz/gallery-dl-server:latest

Docker Compose

This is an example service definition that could be put in docker-compose.yaml. This service uses a VPN client container for its networking.

Gluetun is recommended for VPN usage. See docker-compose.yaml for a template.

services:
  gallery-dl-server:
    image: qx6ghqkz/gallery-dl-server:latest
    container_name: gallery-dl-server
    network_mode: container:vpn
    user: 1000:1000
    volumes:
      - type: bind
        source: "/path/to/data"
        target: /etc
      - type: bind
        source: "/path/to/downloads"
        target: /gallery-dl
    restart: unless-stopped

Important: Make sure to mount the directory containing the config file rather than the file itself. This ensures changes to the config file will be picked up without having to restart the Docker container. The server loads all changes made to the config file before each download, but if the file is mounted directly, in order to ensure modifications are propagated to the Docker container while it is still running, you need to make sure your text editor saves changes to the file directly instead of using a temp-replace method (nano should work). More information on this issue here.

Python

If you have Python ^3.6.0 installed in your PATH you can simply run like this.

python3 -m uvicorn gallery-dl-server:app --port 9080

Port Mapping

By default, this service listens on port 9080. You can use any value for the host port, but if you would like to map to a different internal container port, you need to set the CONTAINER_PORT environment variable. This can be done using the -e flag with docker run or in a Docker Compose file.

For example, if you need to run multiple instances of gallery-dl-server using Gluetun for the networking (every instance must use a different internal port), you can specify an internal port other than the default 9080.

All services defined in the same docker-compose.yaml file:

services:
  gallery-dl-server:
    image: qx6ghqkz/gallery-dl-server:latest
    container_name: gallery-dl-server
    depends_on:
      - gluetun
    network_mode: service:gluetun
    ...

  gallery-dl-server-2:
    image: qx6ghqkz/gallery-dl-server:latest
    container_name: gallery-dl-server-2
    environment:
      - CONTAINER_PORT=9090
    depends_on:
      - gluetun
    network_mode: service:gluetun
    ...

  gluetun:
    image: qmcgaw/gluetun:latest
    container_name: gluetun
    ports:
      # gallery-dl-server
      - 9080:9080
      # gallery-dl-server-2
      - 9090:9090
    ...

Configuration

Configuration of gallery-dl is as documented in the official documentation.

The configuration file must be mounted inside the Docker container in one of the locations where gallery-dl will check for the config file (gallery-dl.conf or config.json depending on the location).

The target config location used in the examples is /etc/gallery-dl.conf. A default configuration file for use with gallery-dl-server has been provided (gallery-dl.conf).

For more information on configuration file options, see gallery-dl/docs/configuration.rst.

Any additional directories specified in the configuration file must also be mounted inside the Docker container, for example if you specify a cookies file location then make sure that location is accessible from within the Docker container.

It is recommended to place any additional files such as archive, cache and cookies files inside the same data directory as the config file.

Usage

Start a download remotely

Downloads can be triggered by supplying the {{url}} of the requested video through the Web UI or through the REST interface via curl, etc.

HTML

Just navigate to http://{{host}}:9080/gallery-dl and enter the requested {{url}}.

Curl

curl -X POST --data-urlencode "url={{url}}" http://{{host}}:9080/gallery-dl/q

Fetch

fetch(`http://${host}:9080/gallery-dl/q`, {
  method: "POST",
  body: new URLSearchParams({
    url: url
  }),
});

Bookmarklet

Add the following bookmarklet to your bookmark bar so you can conveniently send the current page URL to your gallery-dl-server instance.

javascript:!function(){fetch("http://${host}:9080/gallery-dl/q",{body:new URLSearchParams({url:window.location.href}),method:"POST"})}();

Implementation

The server uses starlette for the web framework with gallery-dl and yt-dlp to handle the downloading. The integration with gallery-dl uses Python as described here. For video downloads, gallery-dl imports yt-dlp.

The Docker image is based on python:alpine and consequently alpine.

Useful Links

gallery-dl

yt-dlp

Issues