Skip to main content

Mopidy extension for playing music from your local music archive

Project description

Latest PyPI version Travis CI build status Test coverage

Mopidy extension for playing music from your local music archive.

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 the mopidy-local package:

sudo apt install mopidy-local

If you want the latest version of Mopidy-Local, add as an APT archive on your system.

Arch Linux

Install the mopidy-local package from AUR:

yay -S mopidy-local

Other distributions

If Mopidy-Local isn’t packages for your Linux distribution yet, install the package from PyPI:

pip install Mopidy-Local


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/library: Local library provider to use, change this if you want to use a third party library for local files.
  • local/media_dir: Path to directory with local media files.
  • 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/excluded_file_extensions: File extensions to exclude when scanning the media directory. Values should be separated by either comma or newline.


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

Note that if you are using the default local library storage, json, you need to restart Mopidy after the scan completes for the updated index to be used.

If you want index updates to come into effect immediately, you can try out Mopidy-Local-SQLite, which will probably become the default backend in the near future.

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.

Files for Mopidy-Local, version 3.0.0a1
Filename, size File type Python version Upload date Hashes
Filename, size Mopidy_Local-3.0.0a1-py2.py3-none-any.whl (19.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size Mopidy-Local-3.0.0a1.tar.gz (31.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page