A music downloader dashboard.

Getting Started

Important

This tutorial assumes linux as your operating system. The instructions/commands may be slightly different for windows/macos. Linux is the only officially supported operating system.

Prerequisites

• Node.js is required for the client. The instructions use v20.11.1 but any future versions should work fine.
• Go is required for the server. v1.22 is assumed but future versions should still work.
• Install pnpm

  npm install -g pnpm

Setup

Note

Most of the build process is automated in start.sh, however it's still recommended to manually build the application as you'll probably only do it once.

You're going to need a directory to store config and the binary in. The instructions are going to use out as an example.

# Clone the repo
git clone https://github.com/itzTheMeow/YTMusic.git ytmusic
# Move into cloned repo
cd ytmusic
# Create out directory
mkdir out

Config

Copy config.example.yaml to your out directory and name it config.yaml.

Spotify is recommended for the best experience. It is not required to provide a spotify token for YTMusic to work, however you will be limited to soundcloud for metadata. If you don't want spotify then skip this section.

Go to the spotify developer dashboard. Log in or create an account, you may need to accept the terms.

Click Create app and enter details about your instance.

• App Name

  Enter whatever you want here as a name.

• App Description

  Also put whatever you want here.

• Redirect URIs

  This is a required field so you can just put https://example.com here as its not used in YTMusic.

• Leave all of the other fields blank, they are not required.

• Do not choose any APIs/SDKs either.

Save your new app and then click Settings in the top right.

Copy the Client ID, this is your spotify-id. Click to view the Client Secret, copy that to spotify-secret.

Paste the values in the config. You can now pretty much never touch spotify again.

It's recommended to keep your library-folder set to ./Music while you're testing but you can change it later in the web ui.

You can change the piped-api instance if the default one is giving you trouble. You can get a list of instances here. Just use them at your own risk.

Building YTMusic

# Install Dependencies
pnpm install
# Build the Client
pnpm start
# Move the Built Client
mv dist server

# Move Into Server
cd server
# Install Dependencies
go get
# Move Back
cd ..
# Build the Server
go build -o out/YTMusic ./server
# Allow Execution
chmod +x out/YTMusic

Run the Server

You can run the server by executing the YTMusic binary in the out directory.

# Move Into Out Directory
cd out
# Start YTMusic
./YTMusic

You will be given a default admin password to log in with:

Automatically created account "admin" with password "XXXXXX". Please change your password once logging in.

Go to http://localhost:8777 in your browser and log in with username admin and the password you were given.

Click the settings icon in the top right and change the password to the panel. Once you change the password you'll have to log in again. The username always stays admin.

You can now use YTMusic!

You'll notice a database.db has been created in your out directory. That houses your account information.

You can rename the out directory to something else and move it elsewhere since the build process is finished. Change the library location in settings on the web panel to store your music somewhere else.

Development

There is no development instructions at this time. The project is currently in maintenance mode.

License

This project is licensed under the GNU General Public License v3.0.