Package: malojaserver
MalojaSimple self-hosted music scrobble database to create personal listening statistics.You can checkmy own Maloja pageas an example instance.Table of ContentsFeaturesHow to installRequirementsDocker / PodmanPyPIFrom SourceExtrasHow to useBasic controlDataCustomizationHow to scrobbleHow to extendFeaturesSelf-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 installRequirementsMaloja should run on any x86 or ARM machine that runs Python.It is highly recommended to useDockerorPodman.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.Docker / PodmanPull thelatest imageor 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 locatedMount avolumeto the specified directory to access these files outside the container (and to make them persistent)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 vialocalhost:42010:docker run -p 42010:42010 -v $PWD/malojadata:/mljdata -e MALOJA_DATA_DIRECTORY=/mljdata krateng/malojaLinux HostNOTE:If you are usingrootless containers with Podmanthis DOES NOT apply to you.If you are running Docker on aLinux Hostyou should specifyuser:groupids of the user who owns the folder on the host machine bound toMALOJA_DATA_DIRECTORYin order to avoiddocker file permission problems.These can be specified using theenvironmental variablesPUIDandPGID.To get the UID and GID for the current user run these commands from a terminal:id -u-- prints UID (EX1000)id -g-- prints GID (EX1001)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/malojaPyPIYou can install Maloja withpip install malojaserverTo make sure all dependencies are installed, you can also use one of the included scripts in theinstallfolder.From SourceClone this repository and enter the directory withgit clone https://github.com/krateng/malojacd malojaThen install all the requirements and build the package, e.g.:sh ./install/install_dependencies_alpine.shpip install -r requirements.txtpip install .ExtrasIf you'd like to display images, you will need API keys forLast.fmandSpotify. 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.How to useBasic controlWhen not running in a container, you can run the application withmaloja run. You can also run it in the background withmaloja startandmaloja stop, but this might not be supported in the future.DataIf you would like to import your previous scrobbles, use the commandmaloja import *filename*. This works on:a Last.fm export generated bybenfoxall's website(GitHub page)an officialSpotify data export filean officialListenBrainz export filethe 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.docker run -it --entrypoint sh -v $PWD/malojadata:/mljdata -e MALOJA_DATA_DIRECTORY=/mljdata krateng/malojacd /mljdatamaloja import my_last_fm_export.csvTo backup your data, runmaloja backup, optional with--include_images.CustomizationHave a look at theavailable settingsand 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 - consultimages.infoin the/var/lib/maloja/imagesfolder.To specify custom rules, consult therules.infofile in/etc/maloja/rules. You can also apply some predefined rules on the/admin_setuppage of your server.How to scrobbleYou can set up any amount of API keys in the fileapikeys.ymlin 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. SeeAPI.mdfor 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_manualpage of your Maloja server.How to extendIf you'd like to implement anything on top of Maloja, visit/api_explorer.