Simple self-hosted music scrobble database to create personal listening statistics.
You can check my own Maloja page as an example instance.
Maloja should run on any x86 or ARM machine that runs Python.
It is highly recommended to use Docker or Podman.
Your CPU should have a single core passmark score of at the very least 1500. 500 MB RAM should give you a decent experience, but performance will benefit greatly from up to 2 GB.
Pull the latest image or check out the repository and use the included Containerfile.
Of note are these settings which should be passed as environmental variables to the container:
MALOJA_SKIP_SETUP -- Make the server setup process non-interactive. Maloja will not work properly in a container without this variable set. This is done by default in the provided Containerfile.MALOJA_FORCE_PASSWORD -- Set an admin password for Maloja. You only need this on the first run.MALOJA_DATA_DIRECTORY -- Set the directory in the container where configuration folders/files should be located
You must publish a port on your host machine to bind to the container's web port (default 42010). The container uses IPv4 per default.
An example of a minimum run configuration to access maloja via localhost:42010:
docker run -p 42010:42010 -v $PWD/malojadata:/mljdata -e MALOJA_DATA_DIRECTORY=/mljdata krateng/maloja
NOTE: If you are using rootless containers with Podman this DOES NOT apply to you.
If you are running Docker on a Linux Host you should specify user:group ids of the user who owns the folder on the host machine bound to MALOJA_DATA_DIRECTORY in order to avoid docker file permission problems. These can be specified using the environmental variables PUID and PGID.
To get the UID and GID for the current user run these commands from a terminal:
id -u -- prints UID (EX 1000)id -g -- prints GID (EX 1001)The modified run command with these variables would look like:
docker run -e PUID=1000 -e PGID=1001 -p 42010:42010 -v $PWD/malojadata:/mljdata -e MALOJA_DATA_DIRECTORY=/mljdata krateng/maloja
You can install Maloja with
pip install malojaserver
To make sure all dependencies are installed, you can also use one of the included scripts in the install folder.
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, e.g.:
sh ./install/install_dependencies_alpine.sh
pip install -r requirements.txt
pip install .
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 or IPv4 address according to your settings.
When not running in a container, you can run the application with maloja run. You can also run it in the background with
maloja start and maloja stop, but this might not be supported in the future.
If you would like to import your previous scrobbles, use the command maloja import *filename*. This works on:
⚠️ Never import your data while maloja is running. When you need to do import inside docker container start it in shell mode instead and perform import before starting the container as mentioned above.
docker run -it --entrypoint sh -v $PWD/malojadata:/mljdata -e MALOJA_DATA_DIRECTORY=/mljdata krateng/maloja
cd /mljdata
maloja import my_last_fm_export.csv
To backup your data, run maloja backup, optional with --include_images.
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 prefix MALOJA_ (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.
You can set up any amount of API keys in the file apikeys.yml in your configuration folder (or via the web interface). It is recommended to define a different API key for every scrobbler you use.
Some scrobbler clients support Maloja's native API. You can also use any scrobbler that allows you to set a custom Listenbrainz or GNUFM server. See API.md for details.
If you're the maintainer of a music player or server and would like to implement native Maloja scrobbling, feel free to reach out!
If you can't automatically scrobble your music, you can always do it manually on the /admin_manual page of your Maloja server.
If you'd like to implement anything on top of Maloja, visit /api_explorer.
FAQs
Self-hosted music scrobble database
We found that malojaserver demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.