diff --git a/README.md b/README.md index 4e888d2..089fe57 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,24 @@ # Universal Media Server (ums) YunoHost -**WORK IN PROGRESS: This app does not work yet and does not install or remove properly : Use with caution!!** [![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/) + *[Lire ce readme en français.](./README_fr.md)* > *This package allows you to install ums 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 -Quick description of this app. + +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) **Shipped version:** 10.4.1 @@ -19,41 +26,45 @@ Quick description of this app. ![](Link to a screenshot of this app.) -## Demo - -* [Official demo](Link to a demo site for this app.) - ## Configuration -How to configure this app: From an admin panel, a plain file with SSH, or any other way. +Once installed, UMS will create config file in `/home/ums/.config/UMS/` +All settings are pretty well documented. You may change them from here. ## Documentation - * Official documentation: Link to the official documentation of this app - * YunoHost documentation: If specific documentation is needed, feel free to contribute. + * 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 -Are LDAP and HTTP auth supported? -Can the app be used by multiple users? +For now, the app support single instance only. +As there is no user management, LDAP is not requested. + +The default setting will use the shared multimedia directory by default, you may change this setting in `/home/ums/.config/UMS/UMS.conf` with the setting "folders" + + #### Supported architectures -**Only x_86_64 has been tested so far** * 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 -* Any known limitations : a lot :) +* Known limitations : + - No multiinstance + - work only on its own subdomain (ums.mydomain.tld, not on mydomain.tld/ums) + - No user management + - Not tested that much ## Additional information -* Must have its own domain (no subdir like mydomain.tld/ums) -* No multiinstance -* has been tested only on x86_64 so far +I added the possibility to install vlc on installation. Beware! I addn't tested it and I'm not sure it is of any use for a headless server. +Moreover, it will download a full graphical UI, so not very useful on a server... **More info on the documentation page:** https://yunohost.org/packaging_apps @@ -61,8 +72,8 @@ https://yunohost.org/packaging_apps ## Links * Report a bug: https://github.com/YunoHost-Apps/ums_ynh/issues - * App website: Link to the official website of this app. - * Upstream app repository: Link to the official repository of the upstream app. + * 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/ --- diff --git a/README_fr.md b/README_fr.md index a8240ce..a298a1b 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,17 +1,23 @@ # Universal Media Server (ums) pour YunoHost -**WORK IN PROGRESS : Le package n'est pas stable ni fonctionnel actuellement, aucune garantie de fonctionnement, d'installation sans souci ni d'ailleurs de désinstallation sans soucis** [![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) +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)* > *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.* ## Vue d'ensemble -Description rapide de cette application. + +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 ^etre consulté [ici]](https://github.com/UniversalMediaServer/UniversalMediaServer) **Version incluse :** 10.4.1 @@ -19,45 +25,42 @@ Description rapide de cette application. ![](Lien vers une capture d'écran de cette application.) -## Démo - -* [Démo officielle](Lien vers un site de démonstration de cette application.) - ## Configuration -Comment configurer cette application : via le panneau d'administration, un fichier brut en SSH ou tout autre moyen. +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. ## Documentation - * Documentation officielle : Lien vers la documentation officielle de cette application. - * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. - + * 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 -* L'authentification LDAP et HTTP est-elle prise en charge ? -* L'application peut-elle être utilisée par plusieurs utilisateurs ? +Pour l'instant, l'application supporte uniuqment un mode mono-instance. +Et comme elle ne gère pas d'utilisateur, il n'y a bien entendu pas de LDAP. + +Le réglage par défaut partagera le répertoire multimedia partagé. Vous pouvez changer ce réglage dans le fichier `/home/ums/.config/UMS/UMS.conf` sur le réglage "folders". #### Architectures supportées -**Développement en cours sur x86_64. Aucun tests effectués encore sur d'autres 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 connues: Ne fonctionne pas - +* Limitations connues: + - 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 + ## Informations additionnelles -* Autres informations que vous souhaitez ajouter sur cette application. -doit etre sur un domaine root -pas de multiinstance -regarder les logs => debug log -Tester uniquement sur x86_64 pour l'instant - +J'ai rajouté la possibilité d'installer vlc lors de l'installation. ATTENTION, je ne l'ai pas testé et je ne suis pas sur que cela serve à quelque chose sur un serveur headless... +De plus, vlc requiert l'installation d'un environnement graphique complet. **Plus d'informations sur la page de documentation :** https://yunohost.org/packaging_apps @@ -65,8 +68,8 @@ https://yunohost.org/packaging_apps ## Liens * Signaler un bug : https://github.com/YunoHost-Apps/ums_ynh/issues - * Site de l'application : Lien vers le site officiel de cette application. - * Dépôt de l'application principale : Lien vers le dépôt officiel de l'application principale. + * 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/ --- diff --git a/manifest.json b/manifest.json index 9161f38..777a778 100644 --- a/manifest.json +++ b/manifest.json @@ -44,8 +44,8 @@ "fr" : "Voulez vous installer vlc? Cela peut etre utile pour streamer du contenu web" }, "help": { - "en": "This will use approx 600GB more and will install a LOT of dependencies", - "fr": "Cela va utiliser environ 600GB supplémentaires et installera BEAUCOUP de dépendances" + "en": "This will use approx 600GB more and will install a LOT of dependencies - NOT RECOMMENDED", + "fr": "Cela va utiliser environ 600GB supplémentaires et installera BEAUCOUP de dépendances - NON RECOMMANDE" } } ]