Skip to main content

Mopidy extension for playing music from your local music archive

Project description

Latest PyPI version CI build status Test coverage

Mopidy extension for playing music from your local music archive.

Table of contents

Maintainer wanted

Mopidy-Local is currently kept on life support by the Mopidy core developers. It is in need of a more dedicated maintainer.

If you want to be the maintainer of Mopidy-Local, please:

  1. Make 2-3 good pull requests improving any part of the project.

  2. Read and get familiar with all of the project’s open issues.

  3. Send a pull request removing this section and adding yourself as the “Current maintainer” in the “Credits” section below. In the pull request description, please refer to the previous pull requests and state that you’ve familiarized yourself with the open issues.

    As a maintainer, you’ll be given push access to the repo and the authority to make releases to PyPI when you see fit.


Install by running:

sudo python3 -m pip install Mopidy-Local

See for alternative installation methods.


Before starting Mopidy, you must add configuration for Mopidy-Local to your Mopidy configuration file:

media_dir = /path/to/your/music/archive

The following configuration values are available:

  • local/enabled: If the local extension should be enabled or not. Defaults to true.

  • local/media_dir: Path to directory with local media files.

  • local/max_search_results: Number of search results that should be returned. Default is 100.

  • local/scan_timeout: Number of milliseconds before giving up scanning a file and moving on to the next file.

  • local/scan_follow_symlinks: If we should follow symlinks found in local/media_dir.

  • local/scan_flush_threshold: Number of tracks to wait before telling library it should try and store its progress so far. Some libraries might not respect this setting. Set this to zero to disable flushing.

  • local/included_file_extensions: File extensions to include when scanning the media directory. Values should be separated by either comma or newline. Each file extension should start with a dot, .e.g. .flac. Setting any values here will override the existence of local/excluded_file_extensions.

  • local/excluded_file_extensions: File extensions to exclude when scanning the media directory. Values should be separated by either comma or newline. Each file extension should start with a dot, .e.g. .html. Defaults to a list of common non-audio file extensions often found in music collections. This config value has no effect if local/included_file_extensions is set.

  • local/directories: List of top-level directory names and URIs for browsing.

  • local/timeout: Database connection timeout in seconds.

  • local/use_artist_sortname: Whether to use the sortname field for ordering artist browse results. Disabled by default, since this may give confusing results if not all artists in the library have proper sortnames.

  • local/album_art_files: List of file names to check for when searching for external album art. These may contain UNIX shell patterns, i.e. *, ?, etc.


Generating a library

The command mopidy local scan will scan the path set in the local/media_dir config value for any audio files and build a library of metadata.

To make a local library for your music available for Mopidy:

  1. Ensure that the local/media_dir config value points to where your music is located. Check the current setting by running:

    mopidy config
  2. Scan your media library.:

    mopidy local scan
  3. Start Mopidy, find the music library in a client, and play some local music!

Updating the library

When you’ve added or removed music in your collection and want to update Mopidy’s index of your local library, you need to rescan:

mopidy local scan

Options can be specified to control the behavior of the scan command:

  • --force Force rescan of all media files

  • --limit <number> Maximum number of tracks to scan


mopidy local scan --limit 50

Clearing the library

To delete your local images and clear your local library:

mopidy local clear

A prompt will ask you to confirm this irreversible operation.

Project resources


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Mopidy-Local-3.2.1.tar.gz (38.2 kB view hashes)

Uploaded Source

Built Distribution

Mopidy_Local-3.2.1-py3-none-any.whl (30.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page