1
0
mirror of https://github.com/krateng/maloja.git synced 2023-08-10 21:12:55 +03:00
Self-hosted music scrobble database to create personal listening statistics and charts
Go to file
2020-01-21 15:09:52 +01:00
cache Updated to doreah 0.5.1 2019-04-15 12:26:12 +02:00
clients Documentation 2019-05-14 13:04:05 +02:00
images More leniency on image filenames 2019-04-03 16:03:48 +02:00
logs Cleaned up gitignores a bit 2019-04-18 15:38:26 +02:00
packages Release 1.5 2019-06-24 12:16:10 +02:00
rules Misc 2019-11-21 19:29:46 +01:00
scrobblers Updated Spotify scrobbling 2019-10-03 05:10:31 +02:00
scrobbles Cleaned up gitignores a bit 2019-04-18 15:38:26 +02:00
settings Reverted default use of pyhp until parity achieved 2019-11-19 21:29:29 +01:00
website Can now upload artist / track images from web 2019-11-21 23:15:10 +01:00
.doreah Updated to new pyhp 2019-10-24 20:51:49 +02:00
.gitignore Added script tp update requirements 2019-10-16 15:17:55 +02:00
cleanup.py Added addartists rule type 2019-10-24 04:03:44 +02:00
compliant_api.py Added temporary debug logging 2019-08-22 21:35:58 +02:00
database.py Can now upload artist / track images from web 2019-11-21 23:15:10 +01:00
Dockerfile Add Dockerfile support 2020-01-21 15:09:52 +01:00
external.py Fixed encoding for proxy scrobbling 2019-06-24 17:23:27 +02:00
fixexisting.py Moved logging and timing to doreah 2019-03-29 19:44:42 +01:00
htmlgenerators.py Disabled search provider per default and moved around some things 2019-08-22 22:49:58 +02:00
htmlmodules.py Switching time range or similar now resets to first page 2019-07-25 17:35:03 +02:00
info.py Added transition updater to version 2 2019-12-04 20:49:32 +01:00
lastfmconverter.py Moved logging and timing to doreah 2019-03-29 19:44:42 +01:00
LICENSE Create LICENSE 2018-11-27 16:35:33 +01:00
maloja Adjusted update script 2019-12-10 14:31:42 +01:00
malojatime.py Fixed time ranges again 2019-09-26 18:24:42 +02:00
monkey.py Liverpool 4 Barcelona 0 2019-05-08 18:44:39 +02:00
README.md Adjusted update script 2019-12-10 14:31:42 +01:00
requirements.txt Adjusted update script 2019-12-10 14:31:42 +01:00
server.py Can now upload artist / track images from web 2019-11-21 23:15:10 +01:00
supervisor.py Added log output to supervisor 2019-10-16 15:09:15 +02:00
update_requirements.sh Made update script more portable 2019-10-16 15:24:07 +02:00
urihandler.py Added graphical pagination 2019-06-17 14:59:30 +02:00
utilities.py Can now upload artist / track images from web 2019-11-21 23:15:10 +01:00

Maloja

Simple self-hosted music scrobble database to create personal listening statistics. No recommendations, no social network, no nonsense.

You can check my own Maloja page to see what it looks like.

IMPORTANT NOTICE

Update to Version 2

With the update 2.0, Maloja has been refactored into a Python package and the old update script no longer works. I will keep this repository on the old version for a while so that users with regular updates have a chance to load the transition script. If you have any trouble with updating, simply install Maloja as described below, then manually copy all your user data to your ~/.local/share/maloja folder.

Why not Last.fm / Libre.fm / GNU FM?

Maloja is self-hosted. You will always be able to access your data in an easily-parseable format. Your library is not synced with any public or official music database, so you can follow your own tagging schema or even group associated artists together in your charts.

Maloja also gets rid of all the extra stuff: social networking, radios, recommendations, etc. It only keeps track of your listening history and lets you analyze it.

Maloja's database has one big advantage: It supports multiple artists per track. This means artists who are often just "featuring" in the track title get a place in your charts, and collaborations between several artists finally get credited to all participants. This allows you to get an actual idea of your artist preferences over time.

Also neat: You can use your custom artist or track images.

Requirements

  • Python 3
  • Pip packages specified in requirements.txt
  • If you'd like to display images, you will need API keys for Last.fm and Fanart.tv. These are free of charge!

How to install

  1. Install Maloja with

     pip3 install malojaserver
    
  2. Start the server with

     maloja start
    
  3. (Recommended) Put your server behind a reverse proxy for SSL encryption.

How to use

  1. If you would like to import all your previous last.fm scrobbles, use benfoxall's website (GitHub page). Use the command

     maloja import *filename*
    

    to import the downloaded file into Maloja.

  2. You can interact with the server at any time with the commands

     maloja stop
     maloja restart
     maloja start
     maloja update
    
  3. Various folders have .info files with more information on how to use their associated features.

  4. If you'd like to implement anything on top of Maloja, visit /api_explorer.

How to scrobble

Native API

If you use Plex Web, Spotify, Bandcamp, Soundcloud or Youtube Music on Chromium, you can use the included extension (also available on the Chrome Web Store). Make sure to enter the random key Maloja generates on first startup in the extension settings.

If you want to implement your own method of scrobbling, it's very simple: You only need one POST request to /api/newscrobble with the keys artist, title and key - either as form-data or json.

Standard-compliant API

You can use any third-party scrobbler that supports the audioscrobbler (GNUFM) or the ListenBrainz protocol. This is still very experimental, but give it a try with these settings:

GNU FM  
Gnukebox URL Your Maloja URL followed by /api/s/audioscrobbler
Username Any name, doesn't matter
Password Any of your API keys
ListenBrainz  
API URL Your Maloja URL followed by /api/s/listenbrainz
Username Any name, doesn't matter
Auth Token Any of your API keys

These are tested with the Pano Scrobbler and the Simple Last.fm Scrobbler for Android. I'm thankful for any feedback whether other scrobblers work!

It is recommended to define a different API key for every scrobbler you use in clients/authenticated_machines.tsv in your Maloja folder.

Manual

If you can't automatically scrobble your music, you can always do it manually on the /manual page of your Maloja server.