mirror of
https://github.com/krateng/maloja.git
synced 2023-08-10 21:12:55 +03:00
176 lines
7.7 KiB
Markdown
176 lines
7.7 KiB
Markdown
# Maloja
|
|
|
|
[](https://github.com/krateng/maloja)
|
|
[](https://pypi.org/project/malojaserver/)
|
|
[](https://hub.docker.com/r/krateng/maloja)
|
|
|
|
[](https://github.com/krateng/maloja/blob/master/LICENSE)
|
|
[](https://codeclimate.com/github/krateng/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](https://maloja.krateng.ch) as an example instance.
|
|
|
|
|
|
## Table of Contents
|
|
* [Features](#features)
|
|
* [How to install](#how-to-install)
|
|
* [Requirements](#requirements)
|
|
* [PyPI](#pypi)
|
|
* [From Source](#from-source)
|
|
* [Docker / Podman](#docker--podman)
|
|
* [Extras](#extras)
|
|
* [How to use](#how-to-use)
|
|
* [Basic control](#basic-control)
|
|
* [Data](#data)
|
|
* [Customization](#customization)
|
|
* [How to scrobble](#how-to-scrobble)
|
|
* [How to extend](#how-to-extend)
|
|
|
|
## 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
|
|
|
|
### Requirements
|
|
|
|
Maloja should run on any x86 or ARM machine that runs Python.
|
|
|
|
I can support you with issues best if you use **Alpine Linux**.
|
|
|
|
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.
|
|
|
|
### PyPI
|
|
|
|
You can install Maloja with
|
|
|
|
```console
|
|
pip install malojaserver
|
|
```
|
|
|
|
To make sure all dependencies are installed, you can also use one of the included scripts in the `install` folder.
|
|
|
|
### From Source
|
|
|
|
Clone this repository and enter the directory with
|
|
|
|
```console
|
|
git clone https://github.com/krateng/maloja
|
|
cd maloja
|
|
```
|
|
|
|
Then install all the requirements and build the package, e.g.:
|
|
|
|
```console
|
|
sh ./install/install_dependencies_alpine.sh
|
|
pip install -r requirements.txt
|
|
pip install .
|
|
```
|
|
|
|
### Docker / Podman
|
|
|
|
Pull the [latest image](https://hub.docker.com/r/krateng/maloja) 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_DATA_DIRECTORY` -- Set the directory in the container where configuration folders/files should be located
|
|
* Mount a [volume](https://docs.docker.com/engine/reference/builder/#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 maloja
|
|
|
|
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`:
|
|
|
|
```console
|
|
docker run -p 42010:42010 -v $PWD/malojadata:/mljdata -e MALOJA_DATA_DIRECTORY=/mljdata krateng/maloja
|
|
```
|
|
|
|
### Extras
|
|
|
|
* If you'd like to display images, you will need API keys for [Last.fm](https://www.last.fm/api/account/create) and [Spotify](https://developer.spotify.com/dashboard/applications). 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.
|
|
|
|
* 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
|
|
|
|
```console
|
|
maloja start
|
|
maloja stop
|
|
maloja restart
|
|
```
|
|
|
|
If you need to run the server in the foreground, use
|
|
|
|
```console
|
|
maloja run
|
|
```
|
|
|
|
|
|
### Data
|
|
|
|
If you would like to import your previous scrobbles, use the command `maloja import *filename*`. This works on:
|
|
|
|
* a Last.fm export generated by [benfoxall's website](https://benjaminbenben.com/lastfm-to-csv/) ([GitHub page](https://github.com/benfoxall/lastfm-to-csv))
|
|
* an official [Spotify data export file](https://www.spotify.com/us/account/privacy/)
|
|
* an official [ListenBrainz export file](https://listenbrainz.org/profile/export/)
|
|
* the export of another Maloja instance
|
|
|
|
⚠️ 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.
|
|
|
|
```console
|
|
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`.
|
|
|
|
### Customization
|
|
|
|
* Have a look at the [available settings](settings.md) 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.
|
|
|
|
|
|
## How to scrobble
|
|
|
|
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](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.
|
|
|
|
|
|
## How to extend
|
|
|
|
If you'd like to implement anything on top of Maloja, visit `/api_explorer`.
|