- Rust 86.4%
- Python 5.6%
- Vue 3.4%
- TypeScript 1.4%
- Shell 1%
- Other 2.2%
PMOMusic
Un serveur de musique pour la maison, écrit en Rust. Il tourne sur une machine du réseau (un NAS, un mini-PC, un Raspberry Pi…) et se pilote depuis un navigateur ou depuis une application Android.
- Serveur UPnP / DLNA : expose vos sources (Qobuz, Radio Paradise, Radio France…) aux lecteurs du réseau.
- Interface web (
/app) : un point de contrôle pour choisir la musique et piloter les lecteurs, et un lecteur intégré au navigateur. - Application Android : le téléphone devient un lecteur pilotable depuis l'interface web, et la musique se parcourt aussi depuis Android Auto.
Version courante : voir version.txt.
1. Installer le serveur avec Docker
L'image est publiée sur le registre du projet :
gargoton.petite-maison-orange.fr/public/pmomusic:latest
Exemple docker-compose.yml
services:
pmomusic:
image: gargoton.petite-maison-orange.fr/public/pmomusic:latest
container_name: pmomusic
restart: always
# La découverte UPnP utilise le multicast : le plus simple est le réseau de l'hôte.
network_mode: host
environment:
PMOMUSIC_CONFIG: /config
RUST_LOG: info
volumes:
- ./config:/config
mkdir -p config && sudo chown 1000:1000 config # le conteneur tourne avec l'utilisateur 1000
docker compose up -d
docker compose logs -f
Puis ouvrez http://<adresse-de-la-machine>:8080/app.
Réseau
UPnP a besoin du multicast sur le réseau local. Deux montages fonctionnent :
network_mode: host(ci-dessus) : le conteneur partage l'adresse de l'hôte. C'est le plus simple.- Un réseau
macvlan: le conteneur reçoit sa propre adresse sur le réseau local (c'est le montage de l'auteur, avec en plus un réseauproxy_webvers le proxy inverse). Dans ce cas, pensez à réglerhost.http_portsi vous voulez un autre port que 8080.
Conseils
- Mettez les bases de données (
host.pmodb.directory) sur un disque local, pas sur un montage réseau (NFS) : SQLite y est très lent. La configuration et les caches supportent mieux le réseau. - L'utilisateur du conteneur est
1000: les volumes doivent lui être accessibles en écriture. - Une variable
PMOMUSIC_CONFIG__<clé>__<sous-clé>surcharge une clé du fichier de configuration, en minuscules comme les clés : par exemplePMOMUSIC_CONFIG__host__http_port=9000.
2. Configuration
Au démarrage, PMOMusic lit config.yaml dans le répertoire indiqué par PMOMUSIC_CONFIG (à défaut : .pmomusic dans le répertoire courant, puis dans le répertoire personnel) et le réécrit avec les valeurs par défaut complétées ; le répertoire doit exister. Seules les clés que vous voulez changer sont nécessaires. Les noms de clés sont en minuscules.
host:
http_port: 8080 # port de l'interface web et de l'API
base_url: "http://192.168.0.32:8080" # adresse annoncée aux lecteurs ; devinée si absente
upnp: # à différencier si plusieurs serveurs tournent sur le même réseau
friendly_name_prefix: "PMOMusic"
name_suffix: "" # ajouté au nom des lecteurs multiroom (ex. "-dev")
pmodb:
directory: "/config/pmodb" # bases de données (disque local conseillé)
logger:
min_level: "INFO"
accounts:
qobuz:
username: "vous@example.org"
password: "votre-mot-de-passe" # en clair, ou chiffré (préfixe `encrypted:`, lié à la machine)
sources:
radio_paradise:
default_channel: 0
folder: "/radio" # dossier du Media Server (défaut : /radio)
radiofrance:
enabled: true # activé par défaut ; false = source jamais initialisée
visible: true # false = absente de l'arbre UPnP mais toujours fonctionnelle
folder: "/radio" # défaut : /radio ; "/" ou vide = racine
qobuz:
visible: false # ex. : masquer Qobuz tout en gardant ses liens QOBUZ:…
Chaque source accepte enabled, visible et folder sous sources.<nom> (le nom est l'identifiant de la source, tirets remplacés par des soulignés : radio-paradise → radio_paradise). Un folder est un chemin (/radio, /radio/europe) : le Media Server expose un dossier virtuel de ce nom et y range la source. Radio France et Radio Paradise sont rangées sous /radio par défaut ; les autres restent à la racine. enabled et folder sont lus au démarrage.
Autres clés existantes : host.cover_cache, host.audio_cache et host.qobuz_cache (répertoire et taille des caches, durées de validité), host.logger.enable_console et host.logger.buffer_capacity, host.upnp.manufacturer et host.upnp.model_name_prefix.
Accès depuis Internet (port WAN) et authentification (SSO)
PMOMusic écoute toujours sur le port du réseau local (http_port, sans authentification : réservez-le au réseau local). Un second port, le port WAN, existe si et seulement si host.external_url est défini : c'est celui que votre proxy inverse expose sur Internet. external_url est l'adresse sous laquelle les clients externes voient PMOMusic (schéma, hôte, port éventuel, sans chemin) : toute URL absolue qui leur est renvoyée (pochettes, flux…) est construite sur elle, jamais sur l'adresse du réseau local. Le port WAN ne sert jamais le protocole UPnP brut (/device/…).
host:
external_url: "https://musique.example.org" # adresse externe ; sa présence ouvre le port WAN
wan_port: 8081 # port WAN (8081 par défaut), à exposer par le proxy
Qui protège le port WAN ? Deux situations, et PMOMusic ne les confond pas :
sso_enabledabsent oufalse: PMOMusic n'exige rien sur le port WAN. Il s'ouvre dès queexternal_urlest défini, sans authentification, et un avertissement est journalisé à chaque démarrage (« Port WAN ouvert SANS authentification ») : c'est attendu, pas une panne. C'est le cas d'usage d'une protection autre que l'OIDC, posée devant le port : authentification du proxy inverse (Basic, mTLS, Authelia enforward auth…), VPN, liste d'adresses autorisées. Dans ce cas, c'est à vous de garantir qu'aucune requête non authentifiée n'atteint le port WAN : PMOMusic ne peut pas le vérifier.sso_enabled: true: PMOMusic exige lui-même une identité OpenID Connect (Authelia, Keycloak…) sur tout ce que le port WAN sert. Le port WAN n'est alors jamais ouvert si cette protection ne peut pas être établie (clé manquante, fournisseur injoignable) : le serveur local démarre, le journal dit pourquoi, et il n'y a pas de port WAN pour cette exécution.
host:
external_url: "https://musique.example.org"
sso_enabled: true # exige external_url
oidc:
issuer: "https://auth.example.org"
client_id: "pmomusic"
client_secret: "…"
android:
client_id: "pmomusic-android"
audience: "https://musique.example.org" # valeur de `aud` des jetons du client Android
Côté fournisseur d'identité, il faut deux clients OIDC :
| Client | Type | Redirection | Usage |
|---|---|---|---|
pmomusic |
confidentiel | <external_url>/auth/callback |
l'interface web |
pmomusic-android |
public, PKCE S256, token_endpoint_auth_method: none |
pmomusic://oidc |
l'application Android |
Le client Android doit autoriser le scope offline_access (pour le renouvellement de session) et émettre des jetons d'accès JWT signés RS256 avec l'audience ci-dessus.
Ce qu'une identité valide donne. Il n'y a pas de rôles : toute session OIDC valide accède à tout ce que le port WAN sert. Le jeton Bearer de l'application Android est, lui, limité à une liste blanche (/api/control/, /api/webrenderer/, /media/, /covers/). Sans SSO, ce que votre protection laisse passer atteint tout le serveur.
L'éditeur de configuration sur le port WAN. L'éditeur (/config, voir plus bas) peut modifier toute la configuration et redémarrer le serveur. Par défaut le port WAN ne le sert pas : /config y répond 404, avant toute authentification, et l'éditeur reste réservé au port local. Pour l'atteindre aussi depuis Internet, derrière votre protection :
host:
wan_expose_config: true # défaut : false ; lu à l'ouverture du port WAN (redémarrage requis)
Le réglage se trouve aussi dans l'éditeur (page « Serveur », groupe « Accès externe »). Le jeton Bearer Android n'atteint jamais /config, exposé ou non. Un proxy qui bloque lui-même /config reste possible en défense en profondeur.
Éditer la configuration depuis le navigateur (/config)
Le serveur sert un éditeur de configuration : http://<serveur>:<http_port>/config. L'index liste les pages (Serveur, Journal, Pochettes, Qobuz, Appareils) ; chacune montre, pour chaque réglage, sa valeur, d'où elle vient (défaut, fichier, variable d'environnement), son défaut et si elle demande un redémarrage.
- Le fichier ne garde que ce que vous avez changé. Une valeur égale à son défaut est retirée de
config.yaml(« revenir au défaut » est le retrait de la clé) ; un défaut modifié dans une nouvelle version vous arrive donc sauf pour ce que vous avez choisi. - Un réglage imposé par une variable d'environnement (
PMOMUSIC_CONFIG__…) est affiché verrouillé : l'environnement l'emporte toujours, la page ne l'écrit pas. - Les secrets (mot de passe Qobuz) ne sont jamais affichés, seulement « défini » ou « non défini » ; laissé vide, un secret reste inchangé, saisi il est chiffré.
- Le formulaire est tout ou rien : si une valeur est refusée (type, bornes, option), rien n'est écrit et chaque motif est listé.
- Qobuz : le bouton « Enregistrer et tester la connexion » enregistre le formulaire puis se connecte vraiment à Qobuz avec l'identifiant et le mot de passe enregistrés. Il ne change pas la session en cours.
- Appareils : la liste des appareils UPnP dont PMOMusic garde l'identité. « Retirer » oublie l'identité d'un appareil : il en recevra une nouvelle et les points de contrôle le verront comme un nouvel appareil.
Redémarrer. Les réglages marqués « redémarrage requis » (port, adresses, journal, dossiers de cache…) ne sont lus qu'au démarrage. Sur une page qui en porte, le bouton « Enregistrer et redémarrer » (à côté de « Enregistrer ») enregistre le formulaire puis redémarre, sans étape de confirmation ; il ne redémarre pas si l'enregistrement est refusé. L'index a un bouton « Redémarrer le serveur » en tête, qui passe par une page de confirmation listant ce que le redémarrage prendra en compte ; dès qu'un de ces réglages est modifié, un bandeau le dit. Le redémarrage arrête le serveur proprement (écritures différées vidées), puis PMOMusic se relance lui-même dans le même processus (exec sous Unix : même PID, mêmes arguments, même environnement, même dossier) : il ne dépend ni de Docker, ni de systemd, ni d'aucun superviseur. Les flux servis s'interrompent et le serveur est indisponible quelques secondes ; la page se recharge seule jusqu'à son retour. Si la relance échoue (programme introuvable), le processus s'arrête avec un code d'erreur et le journal en donne la raison.
Qui peut s'en servir. L'éditeur n'a pas d'authentification propre : sur le port local, tout le réseau local y accède (réservez-le à un réseau de confiance) ; sur le port WAN, il n'est servi que si host.wan_expose_config est vrai, et la protection décrite plus haut s'applique alors.
3. Application Android
L'application (fr.pmo.pmomusic, Android 8.0 ou plus) :
- se comporte comme un lecteur (renderer) du serveur, pilotable depuis l'interface web ;
- affiche l'interface web ;
- expose l'arbre de navigation à Android Auto ;
- accepte les partages : depuis une autre application, Partager → Lire avec PMOMusic envoie une adresse web (épisode de podcast, album ou morceau Qobuz, émission Radio France, flux audio…) que le serveur reconnaît, et le téléphone la lit. Le résultat s'affiche dans une bulle (« Lecture : … » ou la raison de l'échec).
Installation
- Téléchargez
pmomusic-<version>.apk(et son.sha256pour vérifier l'intégrité) depuis la page des versions du projet : https://gargoton.petite-maison-orange.fr/pmo/pmomusic/releases - Ouvrez le fichier sur le téléphone et autorisez l'installation depuis cette source.
- Au premier lancement, acceptez la permission de notifications : sans elle le lecteur ne démarre pas.
Une mise à jour s'installe par-dessus la version précédente, sans perdre les réglages.
Réglages
Appui long sur l'icône de l'application, puis Réglages (ou via la page d'infos de l'application) :
- Adresse du serveur : par défaut celle du serveur de l'auteur (
https://orbis.petite-maison-orange.fr). Changez-la pour la vôtre, par exemplehttp://192.168.0.32:8080sur le réseau local ou votre adresse https publique. - Visibilité du lecteur pour les autres appareils : Privé (seul ce téléphone le voit), Auto (visible seulement quand Android Auto est connecté, pour que les passagers pilotent la musique), Visible (toujours).
Si le serveur est protégé par le SSO, l'application affiche au premier lancement la page de connexion de votre fournisseur d'identité ; la session est ensuite renouvelée automatiquement.
Android Auto
L'application n'étant pas installée depuis le Play Store, Android Auto doit accepter les sources inconnues : dans les réglages d'Android Auto, activez le mode développeur (touchez dix fois « Version »), puis Options pour les développeurs → Sources inconnues. PMOMusic apparaît alors dans les applications multimédias de la voiture.
Sans session ouverte, la voiture affiche « Connexion requise » : ouvrez l'application sur le téléphone pour vous connecter.
4. Compiler et contribuer
La compilation depuis les sources, l'application Android et les notes de développement sont dans DEVELOPMENT.md. La construction de l'image Docker est décrite dans DOCKER.md.