Self hosted Spotify tracking dashboard
Your Spotify
YourSpotify is a self-hosted application that tracks what you listen and offers you a dashboard to explore statistics about it! It's composed of a web server which polls the Spotify API every now and then and a web application on which you can explore your statistics.
Table of contents
docker-compose
file.A tutorial is available at the end of this readme.
Installation
Using docker-compose
Follow the docker-compose-example.yml to host your application through 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 (see below) 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
Some ARM-based devices might have trouble with Mongo >= 5. I suggest you use the image mongo:4.4.
Installing locally (not recommended)
You can follow the instructions here. Note that you will still have to do the steps below.
Environment
Key Default value (if any) Description
CLIENT_ENDPOINT REQUIRED The endpoint of your web application
API_ENDPOINT REQUIRED The endpoint of your server
SPOTIFY_PUBLIC REQUIRED The public key of your Spotify application (cf Creating the Spotify Application)
SPOTIFY_SECRET REQUIRED The secret key of your Spotify application (cf Creating the Spotify Application)
CORS not defined List of comma-separated origin allowed, or nothing to allow any origin
MAX_IMPORT_CACHE_SIZE Infinite The maximum element in the cache when importing data from an outside source, more cache means less requests to Spotify, resulting in faster imports
MONGO_ENDPOINT mongodb://mongo:27017/your_spotify The endpoint of the Mongo database, where mongo is the name of your service in the compose file
PORT 8080 The port of the server, do not modify if you're using docker
TIMEZONE Europe/Paris The timezone of your stats, only affects read requests since data is saved with UTC time
LOG_LEVEL info The log level, debug is useful if you encouter any bugs
COOKIE_VALIDITY_MS 1h Validity time of the authentication cookie, following this pattern
MONGO_NO_ADMIN_RIGHTS false Do not ask for admin right on the Mongo database
CORS
You can edit the CORS for the server:
all
will allow every source.origin1,origin2
will allow origin1
and origin2
.Creating the Spotify Application
For YourSpotify to work you need to provide a Spotify application public AND secret to the server environment. To do so, you need to create a Spotify application here.
docker-compose
file under the name of SPOTIFY_PUBLIC
and SPOTIFY_SECRET
respectively.EDIT SETTINGS
button on the top right corner of the page.Redirect URIs
section.http://localhost:8080/oauth/spotify/callback
or http://home.mydomain.com/your_spotify_backend/oauth/spotify/callback
By default, YourSpotify will only retrieve data for the past 24 hours once registered. This is a technical limitation. However, you can import previous data by two ways.
The import process uses cache to limit requests to the Spotify API. By default, the cache size is unlimited, but you can limit is with the MAX_IMPORT_CACHE_SIZE
env variable in the server.
Supported import methods Privacy data
Takes a maximum of 5 days. Only gets you the last year of history.
StreamingHistoryX.json
.Full privacy data
Takes a maximum of 30 days. Gets you the whole history since the creation of your account.
endsongX.json
.Troubleshoot
An import can fail:
A failed import can be retried in the Settings page. Be sure to clean your failed imports if you do not want to retry it as it will remove the files used for it.
It is safer to import data at account creation. Though YourSpotify detects duplicates, some may still be inserted.
FAQ
How can I block new registrations?
From an admin account, go to the Settings page and hit the Disable new registrations button.
Songs don't seem to synchronize anymore.
This can happen if you revoked access on your Spotify account. To re-sync the songs, go to settings and hit the Relog to Spotify button.
The web application is telling me it cannot retrieve global preferences.
This means that your web application can't connect to the backend. Check that your API_ENDPOINT env variable is reachable from the device you're using the platform from.
A specific user does not use the application in the same timezone as the server, how can I set a specific timezone for him?
Any user can set his proper timezone in the settings, it will be used for any computed statistics. The timezone of the device will be used for everything else, such as song history.
External guides
Contributing
If you have any issue or any idea that could make the project better, feel free to open an issue. I'd love to hear about new ideas or bugs you are encountering.
Sponsoring
I work on this project on my spare time and try to fix issues as soon as I can. If you feel generous and think this project and my investment are worth a few cents, you can consider sponsoring it with the button on the right, many thanks.
Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.
We'll never share your email with anyone else.