Skip to content

Introduction

Welcome to the documentation of mbzlists, a self hosted, login-free, annotated playlist manager based on Musicbrainz IDs. It came from the need of curating static music playlists with stories not tied to any platform. With mbzlists, you can create and share portable playlist blogs that can be played back as list of songs as needed.

Here is an example of how an annotated playlist looks like:


screenshot

To get started, check out the publicly available instance here. The source code for various involved projects are kept here. mbzlists depends on great projects like musicbrainz, listenbrainz, and editorjs, among others to function.

Note

mbzlists is just a web app wrapping over the mbzlists playlist file format. You can work with the format any way you want. For example, you can take a playlist file and generate static HTML with custom themes. Go here for more details.

Self Hosting

The easiest way to self-host mbzlists is to use the docker images available from dockerhub. Something like this will get the application running on port 3000.

docker run -d \
    -v "$(pwd)/data:/data" \
    -p 3000:3000 \
    -e PUBLIC_BASE_URL="https//mbzlists.com/" \
    --name mbzlists \
    lepisma/mbzlists:latest

mbzlists stores everything in a single SQLite file that needs a data directory to be mounted (./data/ directory). Other than that, the PUBLIC_BASE_URL is used to show or hide certain data policy notices that only make sense for the hosted instance at https://mbzlists.com.

Contributing

mbzlists development, at the moment, is split across repositories kept here.

You can raise tickets here and do discussions on this mailing list.