From a1856e293e053dcf091e3d657e0974adc9dbb906 Mon Sep 17 00:00:00 2001 From: siwinter <45730097+siwinter@users.noreply.github.com> Date: Wed, 25 Aug 2021 16:42:18 +0200 Subject: [PATCH] Update README.md --- README.md | 72 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 54 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index b20ee4b..f2ef09c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,3 @@ - - # Mopidy for YunoHost [![Integration level](https://dash.yunohost.org/integration/mopidy.svg)](https://dash.yunohost.org/appci/app/mopidy) ![](https://ci-apps.yunohost.org/ci/badges/mopidy.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mopidy.maintain.svg) @@ -10,25 +5,67 @@ It shall NOT be edited by hand. *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Mopidy quickly and simply on a YunoHost server. +> *This package allows you to install Mopidy quickly and simply on a YunoHost server. If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview +Mopidy - is an extensible music server. It plays music, podcasts and radio programs from local disk and various streaming services. You edit the playlist from any phone, tablet, or computer. You hear the music through the speakers connected to the server. -plays music, podcasts and radio programs from local disk and various streaming services +**Shipped version:** 3.1.1 -**Shipped version:** 3.2.0~ynh1 +## Screenshots -**Demo:** https://demo.example.com +![](sources/extra_files/mopidy_screenshot1.png) +## Demo -## Documentation and resources +* No demo available -* Official app website: https://www.mopidy.com/ -* Official user documentation: https://yunohost.org/apps -* Official admin documentation: https://docs.mopidy.com/en/latest/ -* Upstream app code repository: https://github.com/mopidy/mopidy -* YunoHost documentation for this app: https://yunohost.org/app_mopidy -* Report a bug: https://github.com/YunoHost-Apps/mopidy_ynh/issues +## Configuration + +This installation is shipped with various extensions: + +* [MusicBox-Webclient](https://mopidy.com/ext/musicbox-webclient/) to control mopidy from your web browser +* [local](https://mopidy.com/ext/local/) to make your private music collection on `/home/yunohost.multimedia/share/Music/` browseable and searchable +* [YouTube](https://pypi.org/project/Mopidy-YouTube/) to play sound from YouTube +* [YTMusic](https://music.youtube.com/) to access Google’s streaming music named [YouTube Music](https://music.youtube.com/) +* [Podcast-iTunes](https://mopidy.com/ext/podcast-itunes/) to search and browse podcasts from the Apple iTunes Store. +* [RadioNet](https://mopidy.com/ext/radionet/) to play radio channels from the [radio.net](https://www.radio.net/). +* [Podcast](https://mopidy.com/ext/podcast/) to browse RSS feeds of podcasts and stream the episodes. +* [Soundcloud](https://pypi.org/project/Mopidy-SoundCloud/) to play music from the [SoundCloud](https://soundcloud.com/) service \([authentication token](https://pypi.org/project/Mopidy-SoundCloud/) needed\). + +## Documentation + + * Official documentation: https://docs.mopidy.com/en/latest/ + +## YunoHost specific features + +#### Multi-user support + +* Are LDAP and HTTP auth supported? **No** +* Can the app be used by multiple users? ?? + +#### Supported architectures + +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mopidy.svg)](https://ci-apps.yunohost.org/ci/apps/mopidy/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mopidy.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mopidy/) + +## Limitations + +* cannot be used with VPS or other servers that have no real audio hardware + +## Additional information + +* To list current settings enter `sudo mopidyctl config`. +* Edit the file `/opt/yunohost/mopidy/mopidy.conf` to adjust Mopidy's configuration. +* To rebuild the database of your local music collection enter `sudo mopidyctl local scan`. + +## Links + + * Report a bug: https://github.com/YunoHost-Apps/mopidy_ynh/issues + * App website: https://mopidy.com/ + * YunoHost website: https://yunohost.org/ + +--- ## Developer info @@ -39,6 +76,5 @@ To try the testing branch, please proceed like that. sudo yunohost app install https://github.com/YunoHost-Apps/mopidy_ynh/tree/testing --debug or sudo yunohost app upgrade mopidy -u https://github.com/YunoHost-Apps/mopidy_ynh/tree/testing --debug -``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +```