Skip to content
This repository has been archived by the owner on Jan 6, 2024. It is now read-only.

Latest commit

 

History

History
217 lines (161 loc) · 7.79 KB

README.md

File metadata and controls

217 lines (161 loc) · 7.79 KB

Home Assistant Community Add-on: Mopidy

GitHub Release Project Stage License

GitLab CI Project Maintenance GitHub Activity

Discord Community Forum

Sponsor Frenck via GitHub Sponsors

Support Frenck on Patreon

HADashboard screenshot

Mopidy is an extensible music server.

About

Mopidy plays music from local disk, Youtube, Spotify, SoundCloud, Google Play Music, and more. You edit the playlist from any phone, tablet, or computer using a range of MPD and web clients.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on.

  1. Search for the "Mopidy" add-on in the Home Assistant add-on store and install it.
  2. Install the "Mopidy" add-on.
  3. Start the "Mopidy" add-on.
  4. Check the logs of the "Mopidy" add-on to see if everything went well.

Configuration

Note: Remember to restart the add-on when the configuration is changed.

Example add-on configuration:

settings:
  - name: soundcloud/auth_token
    value: 1-1111-1111-11eeaswdf23
  - name: spotify/username
    value: your@email.com
  - name: spotify/password
    value: thesupersecretpassword
  - name: spotify/client_id
    value: spotify-client-id
  - name: spotify/client_secret
    value: spotify-client-secret=
  - name: gmusic/username
    value: username
  - name: gmusic/password
    value: thesupersecretpassword
  - name: gmusic/deviceid
    value: yodeviceid
  - name: youtube/enabled
    value: 'true'
  - name: file/enabled
    value: 'true'
  - name: file/media_dirs
    value: /share/mopidy/media
system_packages: []
python_packages: []

Option: settings

This option allows you to tweak every aspect of Mopidy by setting configuration options. See the example at the start of this chapter to get an idea of how the configuration looks.

For more information about using these settings, see the official Mopidy documentation:

https://docs.mopidy.com/en/latest/config/

Note: This option support secrets, e.g., !secret spotify_password.

Option: system_packages

Allows you to specify additional Ubuntu packages to be installed in your shell environment (e.g., Python, PHP, Go).

Note: Adding many packages will result in a longer start-up time for the add-on.

Option: python_packages

Allows you to specify additional Python packages to be installed to your Mopidy setup (e.g., PyMySQL. Requests, Pillow).

Note: Adding many packages will result in a longer start-up time for the add-on.

Option: leave_front_door_open

Adding this option to the add-on configuration allows you to disable authentication on the VSCode by setting it to true.

Note: We STRONGLY suggest, not to use this, even if this add-on is only exposed to your internal network. USE AT YOUR OWN RISK!

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Support

Got questions?

You have several options to get them answered:

You could also open an issue here GitHub.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Bram Mittendorff, Franck Nijhof and Robbert Müller.

For a full list of all authors and contributors, check the contributor's page.

We have got some Home Assistant add-ons for you

Want some more functionality to your Home Assistant instance?

We have created multiple add-ons for Home Assistant. For a full list, check out our GitHub Repository.

License

MIT License

Copyright (c) 2019-2020 Bram Mittendorff, Franck Nijhof, Robbert Müller

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.