Installation Using Docker Compose

Follow the docker-compose-example.yml file to host your application using Docker.

version: "3"

services:
  server:
    image: yooooomi/your_spotify_server
    restart: always
    ports:
      - "8080:8080"
    links:
      - mongo
    depends_on:
      - mongo
    environment:
      API_ENDPOINT: http://localhost:8080 # This MUST be included as a valid URL in the Spotify dashboard!!!
      CLIENT_ENDPOINT: http://localhost:3000
      SPOTIFY_PUBLIC: __your_spotify_client_id__
      SPOTIFY_SECRET: __your_spotify_secret__
  mongo:
    container_name: mongo
    image: mongo:6
    volumes:
      - ./your_spotify_db:/data/db

  web:
    image: yooooomi/your_spotify_client
    restart: always
    ports:
      - "3000:3000"
    environment:
      API_ENDPOINT: http://localhost:8080

Environment variables

Spotify App Setup

Step 1

Open up the Spotify Developer Dashboard Click "Create app"

Step 2

Fill in all the required info set the redirect URI, corresponding to your server location on the internet (or your local network) adding the suffix /oauth/spotify/callback (/api/oauth/spotify/callback if using the linuxserver image).

example: http://localhost:8080/oauth/spotify/callback or http://home.mydomain.com/your_spotify_backend/oauth/spotify/callback

Step 3

Select Web API, agree to the TOS and Save

Step 4

Back at main page for the App, open up the settings page

Step 5

Copy the Client ID and the client secret key into your docker-compose file under the name of SPOTIFY_PUBLIC and SPOTIFY_SECRET respectively

After creating your application, you may need to register the users who will have access to it. (Note: The account that created the application is automatically registered.)

1. Click the User Management button.
2. Enter the required information: the user's name and the email associated with their Spotify account.
3. (Optional) You can request an extension if you prefer not to register users manually.

Importing Past History

By default, YourSpotify retrieves data for the past 24 hours once registered. This is a technical limitation. However, you can import previous data in two ways.

The import process uses cache to limit requests to the Spotify API. By default, the cache size is unlimited, but you can set a limit with the MAX_IMPORT_CACHE_SIZE environment variable in the server.

Spotify Account Data Download

1. Request your privacy data from Spotify to access your history for the past year here.

Full Privacy Data (Recommended)

• Takes a maximum of 30 days. Retrieves your entire history since the creation of your account.

  2. Choose the Extended streaming history method.
  3. Upload your files starting with endsongX.json.
  4. Start your import.

Privacy Data

• Takes a maximum of 5 days. Only retrieves the last year of history.

  2. Choose the Account data method.
  3. Upload your files starting with StreamingHistoryX.json.
  4. Start your import.

Importing Spotify account data into your_spotify

Back in Your Spotify, open up the settings page to import your Spotify account data.