[![npm version](https://img.shields.io/docker/pulls/raiper34/spooty)](https://hub.docker.com/r/raiper34/spooty) [![npm version](https://img.shields.io/docker/image-size/raiper34/spooty)](https://hub.docker.com/r/raiper34/spooty) ![Docker Image Version](https://img.shields.io/docker/v/raiper34/spooty) [![npm version](https://img.shields.io/docker/stars/raiper34/spooty)](https://hub.docker.com/r/raiper34/spooty) [![GitHub License](https://img.shields.io/github/license/raiper34/spooty)](https://github.com/Raiper34/spooty) [![GitHub Repo stars](https://img.shields.io/github/stars/raiper34/spooty)](https://github.com/Raiper34/spooty) ![spooty logo](assets/logo.svg) # Spooty - selfhosted Spotify downloader Spooty is a self-hosted Spotify downloader. It allows download track/playlist/album from the Spotify url. It can also subscribe to a playlist or author page and download new songs upon release. Spooty basically downloads nothing from Spotify, it only gets information from spotify and then finds relevant and downloadeds music on Youtube. The project is based on NestJS and Angular. > [!IMPORTANT] > Please do not use this tool for piracy! Download only music you own rights! Use this tool only on your responsibility. ### Content - [🚀 Installation](#-installation) - [Spotify App Configuration](#spotify-app-configuration) - [Docker](#docker) - [Docker command](#docker-command) - [Docker compose](#docker-compose) - [Build from source](#build-from-source) - [Process](#requirements) - [Requirements](#process) - [Environment variables](#environment-variables) - [YouTube cookies](#youtube-cookies) - [⚖️ License](#-license) ## 🚀 Installation Recommended and the easiest way how to start to use of Spooty is using docker. ### Spotify App Configuration To fully use Spooty, you need to create an application in the Spotify Developer Dashboard: 1. Go to [Spotify Developer Dashboard](https://developer.spotify.com/dashboard) 2. Sign in with your Spotify account 3. Create a new application 4. Note your `Client ID` and `Client Secret` 5. Configure the redirect URI to `http://127.0.0.1:3000/api/callback` (or the corresponding URL of your instance) These credentials will be used by Spooty to access the Spotify API. ### Docker Just run docker command or use docker compose configuration. For detailed configuration, see available [environment variables](#environment-variables). #### Docker command ```shell docker run -d -p 3000:3000 \ -v /path/to/downloads:/spooty/backend/downloads \ -v /path/to/cookies.txt:/spooty/config/cookies.txt \ -e SPOTIFY_CLIENT_ID=your_client_id \ -e SPOTIFY_CLIENT_SECRET=your_client_secret \ raiper34/spooty:latest ``` #### Docker compose ```yaml services: spooty: image: raiper34/spooty:latest container_name: spooty restart: unless-stopped ports: - "3000:3000" volumes: - /path/to/downloads:/spooty/backend/downloads - /path/to/cookies.txt:/spooty/config/cookies.txt environment: - SPOTIFY_CLIENT_ID=your_client_id - SPOTIFY_CLIENT_SECRET=your_client_secret # Configure other environment variables if needed ``` ### Build from source Spooty can be also build from source files on your own. #### Requirements - Node v20.20.0 (it is recommended to use `nvm` node version manager to install proper version of node) - Redis in memory cache - Ffmpeg - Python3 #### Process - install Node v20.20.0 using `nvm install` and use that node version `nvm use` - from project root install all dependencies using `npm install` - copy `.env.default` as `.env` in `src/backend` folder and modify desired environment properties (see [environment variables](#environment-variables)) - add your Spotify application credentials to the `.env` file: ``` SPOTIFY_CLIENT_ID=your_client_id SPOTIFY_CLIENT_SECRET=your_client_secret ``` - build source files `npm run build` - built project will be stored in `dist` folder - start server `npm run start` ### Environment variables Some behaviour and settings of Spooty can be configured using environment variables and `.env` file. Name | Default | Description | -------------------------|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| DB_PATH | `./config/db.sqlite` (relative to backend) | Path where Spooty database will be stored | FE_PATH | `../frontend/browser` (relative to backend) | Path to frontend part of application | DOWNLOADS_PATH | `./downloads` (relative to backend) | Path where downaloded files will be stored | FORMAT | `mp3` | Format of downloaded files ('aac', 'flac', 'mp3', 'm4a', 'opus', 'vorbis', 'wav', 'alac') | QUALITY | undefined | Audio quality (0-9 VBR or specific bitrate) of downloaded files | PORT | 3000 | Port of Spooty server | REDIS_PORT | 6379 | Port of Redis server | REDIS_HOST | localhost | Host of Redis server | RUN_REDIS | false | Whenever Redis server should be started from backend (recommended for Docker environment) | SPOTIFY_CLIENT_ID | your_client_id | Client ID of your Spotify application (required) | SPOTIFY_CLIENT_SECRET | your_client_secret | Client Secret of your Spotify application (required) | YT_DOWNLOADS_PER_MINUTE | 3 | Set the maximum number of YouTube downloads started per minute | YT_COOKIES | | Browser name to automatically extract YouTube cookies from (e.g. `chrome`, `firefox`). Only works when running Spooty natively (not in Docker). See [below](#yt_cookies---browser-based-cookies-non-docker). | YT_COOKIES_FILE | `./config/cookies.txt` | Path to a Netscape-format `cookies.txt` file. Recommended for Docker deployments. See [below](#yt_cookies_file---cookies-file-recommended-for-docker). | ### YouTube cookies YouTube may block or throttle downloads without authentication cookies. Spooty supports two ways to provide them — use the one that fits your setup. #### `YT_COOKIES` — browser-based cookies (non-Docker) Set `YT_COOKIES` to the name of your browser and yt-dlp will automatically read cookies directly from it. Supported values: `chrome`, `firefox`, `edge`, `safari`, `brave`, `opera`, `chromium`. ``` YT_COOKIES=chrome ``` > [!NOTE] > This only works when Spooty runs on the same machine as your browser (i.e. not in Docker, where no browser is present). #### `YT_COOKIES_FILE` — cookies file (recommended for Docker) Export your YouTube cookies as a Netscape `cookies.txt` file and provide its path. This is the recommended approach for Docker deployments. **How to get your `cookies.txt` file:** 1. Install a browser extension that exports cookies in Netscape format, e.g. [Get cookies.txt LOCALLY](https://chrome.google.com/webstore/detail/get-cookiestxt-locally/cclelndahbckbenkjhflpdbgdldlbecc) for Chrome or [cookies.txt](https://addons.mozilla.org/en-US/firefox/addon/cookies-txt/) for Firefox. 2. Go to https://www.youtube.com and log in. 3. Use the extension to export cookies for `youtube.com` and save the file as `cookies.txt`. **Docker usage:** Bind mount the `cookies.txt` file into the container and set `YT_COOKIES_FILE` to its path inside the container. See the [Environment variables](#environment-variables) section for details. > [!NOTE] > `YT_COOKIES` takes priority over `YT_COOKIES_FILE` if both are set. # ⚖️ License [MIT](https://choosealicense.com/licenses/mit/)