diff --git a/README.md b/README.md index 6740dbc..6f129e9 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,47 @@ -# Universal Media Server (ums) YunoHost + +# Universal Media Server for YunoHost [![Integration level](https://dash.yunohost.org/integration/ums.svg)](https://dash.yunohost.org/appci/app/ums) ![](https://ci-apps.yunohost.org/ci/badges/ums.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ums.maintain.svg) -[![Install ums with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ums) - -Official website : [![https://www.universalmediaserver.com/](https://raw.githubusercontent.com/UniversalMediaServer/UniversalMediaServer/master/src/main/resources/images/logo.png)](https://www.universalmediaserver.com/) +[![Install Universal Media Server with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ums) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install ums quickly and simply on a YunoHost server. +> *This package allows you to install Universal Media Server 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 -Universal Media Server is a free DLNA, UPnP and HTTP/S Media Server supporting all major operating systems, with versions for Windows, Linux and macOS. -The program streams or transcodes many different media formats with little or no configuration. -It is powered by FFmpeg, MediaInfo, OpenSubtitles, Crowdin, MEncoder, tsMuxeR, AviSynth, VLC and more, which combine to offer support for a wide range of media formats. -It was originally based on PS3 Media Server by shagrath, and started by SubJunk, an official developer of PMS, in order to ensure greater stability and file-compatibility. - -Upstream source code may be found [here](https://github.com/UniversalMediaServer/UniversalMediaServer) +A DLNA, UPnP and HTTP(S) Media Server **Shipped version:** 10.9.0 + + ## Screenshots -![](https://www.universalmediaserver.com/assets/img/web-interface.gif) +![](./doc/screenshots/screenshot.gif) -## Configuration +## Disclaimers / important information + +### Configuration Once installed, UMS will create config file in `/home/ums/.config/UMS/` All settings are pretty well documented directly in the files. The default setting will use the shared multimedia directory by default (located into `/home/yunohost.multimedia/share`), you may change this setting in `/home/ums/.config/UMS/UMS.conf` with the setting "folders" - - -## Documentation - - * The [wiki](https://github.com/UniversalMediaServer/UniversalMediaServer/wiki) described main settings - * The [forum](https://www.universalmediaserver.com/forum/) has also a lot of info - - -## YunoHost specific features - -#### Multi-user support - -For now, the app support single instance only. -As there is no user management, LDAP is not requested. - - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/ums.svg)](https://ci-apps.yunohost.org/ci/apps/ums/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/ums.svg)](https://ci-apps-arm.yunohost.org/ci/apps/ums/) - -## Limitations +### Limitations - No multi-instance - work only on its own subdomain (ums.mydomain.tld, not on mydomain.tld/ums) - No user management - Not tested that much - -## Other infos +### Other infos If you can't find the server on a renderer, you may try the following trouble shooting : - Wait a little bit : the first start up will intialized the database and if you have a lot of media, this may take a while @@ -71,18 +50,18 @@ If you can't find the server on a renderer, you may try the following trouble sh - check on which network interface the server is annoucing : You may find the network and address used in `/home/ums/.config/UMS/debug.log` or `/var/log/ums/ums.log`. Search for a line like `Using address /192.168.0.54 found on network interface: name:enp0s3 (enp0s3)` The subnet to be used should be the same as your renderer (ie : if your TV is on 192.168.0.X and ums on 192.168.1.X, this will not work) -## Links +On small device (Raspberry for example), transco may be requiring too much power : try some alternate transcoder. - * Report a bug: https://github.com/YunoHost-Apps/ums_ynh/issues - * App website: [https://www.universalmediaserver.com](https://www.universalmediaserver.com/) - * Upstream app repository: [https://www.universalmediaserver.com/](https://www.universalmediaserver.com/) - * YunoHost website: https://yunohost.org/ +## Documentation and resources ---- +* Official app website: www.universalmediaserver.com +* Official admin documentation: https://github.com/UniversalMediaServer/UniversalMediaServer/wiki +* Upstream app code repository: https://github.com/UniversalMediaServer +* YunoHost documentation for this app: https://yunohost.org/app_ums +* Report a bug: https://github.com/YunoHost-Apps/ums_ynh/issues ## Developer info -**Only if you want to use a testing branch for coding, instead of merging directly into master.** Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/ums_ynh/tree/testing). To try the testing branch, please proceed like that. @@ -91,3 +70,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/ums_ynh/tree/testing or sudo yunohost app upgrade ums -u https://github.com/YunoHost-Apps/ums_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 0b1a286..898c595 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,63 +1,42 @@ -# Universal Media Server (ums) pour YunoHost - +# Universal Media Server pour YunoHost [![Niveau d'intégration](https://dash.yunohost.org/integration/ums.svg)](https://dash.yunohost.org/appci/app/ums) ![](https://ci-apps.yunohost.org/ci/badges/ums.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/ums.maintain.svg) -[![Installer ums avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ums) +[![Installer Universal Media Server avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=ums) -Site Web officiel : [![https://www.universalmediaserver.com/](https://raw.githubusercontent.com/UniversalMediaServer/UniversalMediaServer/master/src/main/resources/images/logo.png)](https://www.universalmediaserver.com/) +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -*[Read this readme in english.](./README.md)* - -> *Ce package vous permet d'installer ums rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* +> *Ce package vous permet d'installer Universal Media Server rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* ## Vue d'ensemble -Universal Media Server est un serveur DLNA, UPnp et HTTP/S libre supportant tous les grands systèmes d'exploitation, avec une version pour Windows, Linux et MacOS -Le programme stream ou transcode beaucoup de formats différents avec peu ou pas de configuration. -Il utilise by FFmpeg, MediaInfo, OpenSubtitles, Crowdin, MEncoder, tsMuxeR, AviSynth, VLC et d'autres, qiu'il combine pour permettre d'exploiter une grande variété de format. -Il était originellement basé sur PS3 Media Server de shagrath, et a été lancé par SubJunk, un développeur officiel de PMS, pour assurer la plus grande stabilité et compatiblité. -Le code du programme peut être consulté [ici]](https://github.com/UniversalMediaServer/UniversalMediaServer) +Un Serveur Multimedia DLNA, UPnP et HTTP(S) + +**Version incluse :** 10.9.0 + -**Version incluse :** 10.9.0 ## Captures d'écran -![](https://www.universalmediaserver.com/assets/img/web-interface.gif) +![](./doc/screenshots/screenshot.gif) -## Configuration +## Avertissements / informations importantes + +### Configuration Une fois installé, tous les réglages peuvent etre trouver dans `/ums/.config/UMS/` Les réglages sont plutot bien documentés, vous pouvez les changer directement dans le fichier. Le réglage par défaut utilisera le répertoire multimedia partagé (situé dans `/home/yunohost.multimedia/share`). Vous pouvez changer ce réglage dans le fichier `/home/ums/.config/UMS/UMS.conf` sur le réglage "folders". -## Documentation - - * Le [wiki](https://github.com/UniversalMediaServer/UniversalMediaServer/wiki) décrit les principaux réglages. - * Le [forum](https://www.universalmediaserver.com/forum/) a également énormément d'info. - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -Pour l'instant, l'application supporte uniquement un mode mono-instance. -Et comme elle ne gère pas d'utilisateur, il n'y a bien entendu pas de LDAP. - - - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/ums.svg)](https://ci-apps.yunohost.org/ci/apps/ums/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/ums.svg)](https://ci-apps-arm.yunohost.org/ci/apps/ums/) - -## Limitations +### Limitations - pas de multiinstance - fonctionne uniquement en sous-domaine (ums.mydomain.tld, et non mydomain.tld/ums) - pas de gestion d'utilisateur - Pas énormément testée -## Other infos +### Other infos Si vous ne trouvez pas le serveur sur vos renderer, vous pouvez essayer les trucs suivants: - Attendez un petit peu : lors du premier démarrage, UMS va indexer tous vos médias et ceci peut prendre un certain temps si vous en avez beaucoup @@ -65,20 +44,18 @@ Si vous ne trouvez pas le serveur sur vos renderer, vous pouvez essayer les truc - Vérifiez bien que le service ums tourne dans l'interface d'administration de yunohost - Vérifiez sur quel interface réseau ums s'annonce. Vous pouvez trouver l'adresse utilisée et le réseau dans `/home/ums/.config/UMS/debug.log` ou `/var/log/ums/ums.log`. Cherchez une ligne ressemblant à `Using address /192.168.0.54 found on network interface: name:enp0s3 (enp0s3)`. Le sous-réseau utilisé doit être le même que le renderer (ie : si votre TV est sur 192.168.0.X et ums sur 192.168.1.X, cela ne marchera pas) -Sur de petits appareils (par exemple une raspberry, la transco peut demander trop de puissance, n'hésiter par à utiliser des transcodeur alternatifs. +Sur de petits appareils (par exemple un raspberry), la transco peut demander trop de puissance, n'hésiter par à utiliser des transcodeur alternatifs. -## Liens +## Documentations et ressources - * Signaler un bug : https://github.com/YunoHost-Apps/ums_ynh/issues - * Site de l'application : [https://www.universalmediaserver.com](https://www.universalmediaserver.com/) - * Dépôt de l'application principale :[ https://www.universalmediaserver.com/](https://www.universalmediaserver.com/) - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : www.universalmediaserver.com +* Documentation officielle de l'admin : https://github.com/UniversalMediaServer/UniversalMediaServer/wiki +* Dépôt de code officiel de l'app : https://github.com/UniversalMediaServer +* Documentation YunoHost pour cette app : https://yunohost.org/app_ums +* Signaler un bug : https://github.com/YunoHost-Apps/ums_ynh/issues ## Informations pour les développeurs -**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/ums_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. @@ -87,3 +64,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/ums_ynh/tree/testing ou sudo yunohost app upgrade ums -u https://github.com/YunoHost-Apps/ums_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file