.github/workflows | ||
auxiliary | ||
dev-scripts | ||
install | ||
maloja | ||
testing | ||
.gitignore | ||
DEVELOPMENT.md | ||
Dockerfile | ||
Dockerfile-pypi | ||
FUTURE.md | ||
install_alpine.sh | ||
install_ubuntu.sh | ||
LICENSE | ||
pyproject.toml | ||
README.md | ||
requirements_extra.txt | ||
requirements.txt | ||
settings.md | ||
setup.py |
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 (it's down fairly often because I use it as staging environment, that doesn't reflect the stability of the Maloja software!).
If you're a new Maloja user, consider installing Version 3 Beta right away. This way, you avoid having to upgrade later and you might help catch some bugs.
Simply clone this repository and change branches with
git checkout v3
, then follow the Readme of that branch to install from source or run the included Containerfile.Thank you for your help testing the new release!
Table of Contents
Features
- 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.
- Associated Artists: Compare different artists' popularity in your listening habits including subunits, collaboration projects or solo performances by their members. Change these associations at any time without losing any information.
- Multi-Artist Tracks: Some artists often collaborate with others or are listed under "featuring" in the track title. Instead of tracking each combination of artists, each individual artist competes in your charts.
- Custom Images: Don't rely on the community to select the best pictures for your favorite artists. Upload your own so that your start page looks like you want it to look.
- Proxy Scrobble: No need to fully commit or set up every client twice - you can configure your Maloja server to forward your scrobbles to other services.
- Standard-compliant API: Use existing, mature apps or extensions to scrobble to your Maloja server.
- Manual Scrobbling: Listening to vinyl or elevator background music? Simply submit a scrobble with the web interface.
- Keep it Simple: Unlike Last.fm and similar alternatives, Maloja doesn't have social networking, radios, recommendations or any other gimmicks. It's a tool to keep track of your listening habits over time - and nothing more.
How to install
LXC / VM / Bare Metal
I can support you with issues best if you use Alpine Linux.
From PyPI
You can download the included script install_alpine.sh
and run it with
sh install_alpine.sh
You can also simply call the install command
pip install malojaserver
directly (e.g. if you're not on Alpine) - make sure you have all the system packages installed.
From Source
Clone this repository and enter the directory with
git clone https://github.com/krateng/maloja
cd maloja
Then install all the requirements and build the package:
sh ./install/install_dependencies.sh
pip install -r requirements.txt
pip install .
Docker
Pull the latest image or check out the repository and use the included Dockerfile.
Of note are these settings which should be passed as environmental variables to the container:
MALOJA_DATA_DIRECTORY
-- Set the directory in the container where configuration folders/files should be located- Mount a volume to the specified directory to access these files outside the container (and to make them persistent)
MALOJA_FORCE_PASSWORD
-- Set an admin password for malojaMALOJA_HOST
(Optional) -- Maloja uses IPv6 by default for the host. Set this to0.0.0.0
if you cannot initially access the webserver
You must also publish a port on your host machine to bind to the container's web port (default 42010)
An example of a minimum run configuration when accessing maloja from an IPv4 address IE localhost:42010
:
docker run -p 42010:42010 -e MALOJA_HOST=0.0.0.0 maloja
Extras
-
If you'd like to display images, you will need API keys for Last.fm and Spotify. These are free of charge!
-
Put your server behind a reverse proxy for SSL encryption. Make sure that you're proxying to the IPv6 address unless you changed your settings to use IPv4.
-
You can set up a cronjob to start your server on system boot, and potentially restart it on a regular basis:
@reboot sleep 15 && maloja start
42 0 7 * * maloja restart
How to use
Basic control
Start and stop the server in the background with
maloja start
maloja stop
maloja restart
If you need to run the server in the foreground, use
maloja run
Data
-
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. -
To backup your data, run
maloja backup
or, to only backup essential data (no artwork etc),maloja backup -l minimal
. -
To fix your database (e.g. after you've added new rules), use
maloja fix
.
Customization
-
Have a look at the available settings and specifiy your choices in
/etc/maloja/settings.ini
. You can also set each of these settings as an environment variable with the prefixMALOJA_
(e.g.MALOJA_SKIP_SETUP
). -
If you have activated admin mode in your web interface, you can upload custom images for artists or tracks by simply dragging them onto the existing image on the artist or track page. You can also manage custom images directly in the file system - consult
images.info
in the/var/lib/maloja/images
folder. -
To specify custom rules, consult the
rules.info
file in/etc/maloja/rules
. You can also apply some predefined rules on the/admin_setup
page of your server.
How to scrobble
You can set up any amount of API keys in the file authenticated_machines.tsv
in the /etc/maloja/clients
folder. It is recommended to define a different API key for every scrobbler you use.
Native support
These solutions allow you to directly setup scrobbling to your Maloja server:
- Tauon Desktop Player
- Web Scrobbler Browser Extension
- Multi Scrobbler Desktop Application
- Cmus-maloja-scrobbler Script
- OngakuKiroku Desktop Application (Mac)
- Albula Music Server
- Maloja Scrobbler Chromium Extension (also included in the repository) for Plex Web, Spotify, Bandcamp, Soundcloud or Youtube Music
Native API
If you want to implement your own method of scrobbling, it's very simple: You only need one POST request to /apis/mlj_1/newscrobble
with the keys artist
, title
and key
(and optionally album
,duration
(in seconds) and time
(for cached scrobbles)) - either as form-data or json.
If you're the maintainer of a music player or server and would like to implement native Maloja scrobbling, feel free to reach out - I'll try my best to help. For Python applications, you can simply use the malojalib
package for a consistent interface even with future updates.
Standard-compliant API
You can use any third-party scrobbler that supports the audioscrobbler (GNUFM) or the ListenBrainz protocol. This is still somewhat experimental, but give it a try with these settings:
GNU FM | |
---|---|
Gnukebox URL | Your Maloja URL followed by /apis/audioscrobbler |
Username | Doesn't matter |
Password | Any of your API keys |
ListenBrainz | |
---|---|
API URL | Your Maloja URL followed by /apis/listenbrainz |
Username | Doesn't matter |
Auth Token | Any of your API keys |
Audioscrobbler v1.2 | |
---|---|
Server URL | Your Maloja URL followed by /apis/audioscrobbler_legacy |
Username | Doesn't matter |
Password | Any of your API keys |
Known working scrobblers:
- Pano Scrobbler for Android
- Simple Scrobbler for Android
- Airsonic Advanced (requires you to supply the full endpoint (
yoururl.tld/apis/listenbrainz/1/submit-listens
)) - Funkwhale (use the legacy API
yoururl.tld/apis/audioscrobbler_legacy
) - mpdscribble (use the legacy API
yoururl.tld/apis/audioscrobbler_legacy
)
I'm thankful for any feedback whether other scrobblers work!
Manual
If you can't automatically scrobble your music, you can always do it manually on the /admin_manual
page of your Maloja server.
How to extend
If you'd like to implement anything on top of Maloja, visit /api_explorer
.