maloja/README.md

59 lines
3.0 KiB
Markdown
Raw Normal View History

2018-11-27 18:31:52 +03:00
# Maloja
Simple self-hosted music scrobble database to create personal listening statistics. No recommendations, no social network, no nonsense.
2018-11-27 18:51:02 +03:00
## Never Asked Questions
2018-11-27 18:31:52 +03:00
2018-11-27 18:51:02 +03:00
### Why not Last.fm / Libre.fm?
2018-11-27 18:31:52 +03:00
2018-11-29 15:43:45 +03:00
Maloja is self-hosted. You will always be able to access your data, and not have to trust anyone to provide an API for it. 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.
2018-11-27 18:31:52 +03:00
2018-11-27 18:51:02 +03:00
### Why not GNU FM?
2018-11-27 18:31:52 +03:00
2018-11-29 15:43:45 +03:00
Maloja 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. This focus on its core allows it to potentially implement much better database features. One example: Maloja 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.
2018-11-27 18:31:52 +03:00
2018-11-27 18:51:02 +03:00
### Why Maloja?
2018-11-27 18:31:52 +03:00
2018-11-27 18:51:02 +03:00
I like to name my projects after regions in Grisons, Switzerland. Don't waste your time trying to find a connection, I just picked one at random. Do visit Maloja though. It's a great pass to drive.
2018-11-27 18:31:52 +03:00
2018-11-27 18:51:02 +03:00
## Current status
2018-11-27 18:31:52 +03:00
2019-02-02 22:51:04 +03:00
You can check [my own Maloja page](https://maloja.krateng.ch) to see what it currently looks like.
The software works fairly well and has a few web views, but there is only one scrobbler (a Chrome extension for Plex).
2018-11-28 15:46:58 +03:00
## How to install
2019-02-16 22:10:12 +03:00
Installing Maloja is fairly easy on a Linux machine. Don't ask me how to do it on Windows, I have no clue. Don't ask me to add any lines to make it work on Windows either, the code is already shitty enough.
2018-11-28 15:46:58 +03:00
2018-12-06 15:36:42 +03:00
1) Install the requirements:
* [bottle.py](https://github.com/bottlepy/bottle)
* [waitress](https://github.com/Pylons/waitress)
2019-02-16 23:43:57 +03:00
2) Put the Maloja folder anywhere and make sure the file "maloja" is executable. Start the server with
./maloja start
2018-12-06 15:36:42 +03:00
3) (Recommended) Put your server behind a reverse proxy for SSL encryption. Configure that proxy to rewrite /db/ requests to the database port. In nginx this would look as follows:
2018-11-28 15:46:58 +03:00
2018-11-29 15:43:45 +03:00
location / {
proxy_pass http://yoururl:42010;
}
2018-11-28 15:46:58 +03:00
location /db {
rewrite ^/db(.*)$ $1 break;
2018-11-29 15:43:45 +03:00
proxy_pass http://yoururl:42011;
2018-11-28 15:46:58 +03:00
}
4) In order to scrobble your music from Plex Web, install the included Chrome extension. Make sure to generate a random key and enter that key in the extension as well as the file autenticated_machines.tsv in the clients folder.
5) If you would like to import all your previous last.fm scrobbles, use [benfoxall's website](https://benjaminbenben.com/lastfm-to-csv/) ([GitHub page](https://github.com/benfoxall/lastfm-to-csv)). Use the python script lastfmconverter.py with two arguments - the downloaded csv file and your new tsv file - to convert your data. Place the tsv file in scrobbles/ and the server will recognize it on startup.
2019-02-16 23:43:57 +03:00
6) You can interact with the server at any time with the commands
./maloja stop
./maloja restart
./maloja start
./maloja update