Skip to content

jean-voila/gargantua

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gargantua

This Docker image is a simple music downloader at ihgh quality from Soulseek. This project has been made with Spotify in mind, but it can also be used with other platforms (see the sldl project's documentation)

Gargantua principle

Prerequisites

  • Docker and Docker Compose installed on your system.
  • A Soulseek account.
  • A source for the music list you want : either a Spotify playlist link or a CSV file.
  • (Optional but highly recommended) A Gluetun container for VPN usage.

Building the Image

To build the Docker image, execute the following command in the directory containing the Dockerfile:

docker build -t gargantua .

Usage

Required Environment Variables

  • USERNAME: Your Soulseek username.
  • PASSWORD: Your Soulseek password.

Optional Environment Variables

  • SPOTIFY_LINK: A link to a Spotify playlist. If this variable is set, it will be used as the input source.
  • CSV_FILENAME: The name of a CSV file containing the exported list of musics. If SPOTIFY_LINK is not set, this file will be used as the input source. The CSV file must be located in the mounted /data directory. If neither SPOTIFY_LINK nor CSV_FILENAME is set, the program will search by default the file playlist.csv, or the first .csv file in /data.
  • FORMAT: The desired audio file format (default: flac).
  • NAME_FORMAT: The desired file naming format (default: "{artist( - )title|filename}").
  • CONCURRENT_DOWNLOADS: The number of simultaneous downloads (default: 7).
  • STRICT_CONDITIONS: Enables or disables strict conditions (default: true).

Output and Logs

  • Downloaded files will be placed in the mounted /downloads directory.
  • Application logs will be saved as sldl.log in the mounted /data directory.
  • the sldl index file will be created in the mounted /data directory as index.sldl.

About

Mass high-quality automated dockerized music downloader

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors