Skip to content

Latest commit

 

History

History
179 lines (129 loc) · 5.61 KB

installation.fr.md

File metadata and controls

179 lines (129 loc) · 5.61 KB

Guide d’installation de NaviPort

NaviPort — Votre musique revient chez vous

← Retour au README · English guide

1. Démarrer NaviPort

Aucun fichier .env n’est nécessaire :

git clone https://github.com/JavaScript-X/NaviPort.git
cd NaviPort
docker compose up -d

Ouvrir http://127.0.0.1:3000. NaviPort affiche son assistant initial et génère automatiquement son secret de session.

2. Terminer la configuration web

  1. Ouvrir le Spotify Developer Dashboard.
  2. Créer une application puis ouvrir ses paramètres.
  3. Cocher Web API. NaviPort n’utilise pas Web Playback SDK.
  4. Copier dans Spotify la Redirect URI affichée par NaviPort.
  5. Cliquer sur Add à côté de cette URI puis enregistrer l’application Spotify.
  6. Copier le Client ID de Spotify dans NaviPort.
  7. Enregistrer puis cliquer sur Se connecter avec Spotify.

Aucun Spotify Client Secret n’est demandé. NaviPort utilise OAuth PKCE.

Pour un NAS, ouvrir NaviPort depuis son domaine HTTPS avant de remplir l’assistant. Il doit afficher une adresse semblable à :

https://naviport.example.com/auth/callback

Spotify impose HTTPS sauf pour une adresse de bouclage explicite. localhost, les adresses HTTP du réseau local, les jokers et une URL différant par une simple barre oblique ne sont pas acceptés.

En local, toujours ouvrir NaviPort avec http://127.0.0.1:PORT, jamais http://localhost:PORT. NaviPort corrige désormais automatiquement les liens utilisant localhost.

En mode développement Spotify, ajouter chaque utilisateur autorisé dans les paramètres de gestion des utilisateurs de l’application.

Contrôler le déploiement :

docker compose up -d
docker compose ps
docker compose logs -f naviport

Pour mettre à jour plus tard :

docker compose pull
docker compose up -d

3. ZimaOS

  1. Ouvrir l’interface web de ZimaOS.
  2. Aller dans App Store, cliquer sur +, puis Install a customized app.
  3. Choisir l’import Docker Compose.
  4. Copier le contenu de deploy/zimaos/compose.yaml.
  5. Installer l’application.
  6. Ouvrir le port 3000 depuis la tuile NaviPort.
  7. Suivre l’assistant de première configuration.

Le manifest contient les métadonnées ZimaOS/CasaOS et fonctionne sur les machines amd64 et arm64.

Pour se connecter depuis un autre appareil, publier NaviPort derrière un reverse proxy HTTPS, conserver TRUST_PROXY=1 et utiliser exactement la même URL HTTPS dans le manifest et le tableau de bord Spotify.

4. TrueNAS SCALE 24.10 ou plus récent

  1. Configurer un pool Apps dans TrueNAS s’il n’est pas déjà actif.
  2. Ouvrir Apps → Discover Apps.
  3. Ouvrir le menu puis choisir Install via YAML.
  4. Saisir naviport comme nom d’application.
  5. Copier le contenu de deploy/truenas/compose.yaml.
  6. Enregistrer puis attendre l’état Running.
  7. Ouvrir http://IP_TRUENAS:3000 ou l’adresse HTTPS du reverse proxy.
  8. Suivre l’assistant de première configuration.

Si le port 3000 est déjà utilisé, modifier uniquement la partie gauche :

ports:
  - "13000:3000"

Le PORT interne reste 3000.

5. Reverse proxy

Configuration recommandée :

SPOTIFY_REDIRECT_URI=https://naviport.example.com/auth/callback
TRUST_PROXY=1

Le reverse proxy doit :

  • terminer la connexion HTTPS ;
  • transférer les requêtes vers naviport:3000 ;
  • conserver le nom d’hôte d’origine ;
  • transmettre X-Forwarded-Proto: https ;
  • diriger /auth/callback vers la même instance NaviPort.

Enregistrer exactement cette même URL HTTPS chez Spotify. Ne pas exposer directement NaviPort sur Internet sans TLS et sans les protections adaptées à votre serveur domestique.

Avec les manifests NAS, passer TRUST_PROXY à 1 avant le déploiement. L’assistant déduit la callback depuis l’adresse HTTPS ouverte dans le navigateur.

Réinitialiser la configuration

La configuration se trouve dans /data/config.json. Pour recommencer avec le Compose principal :

docker compose down
docker volume rm naviport_naviport_data
docker compose up -d

Cette commande déconnecte les utilisateurs et supprime uniquement la configuration OAuth locale de NaviPort.

6. Utilisation avec Downtify et Navidrome

  1. Se connecter à Spotify dans NaviPort.
  2. Ajouter une collection entière ou choisir des morceaux précis.
  3. Télécharger l’export.
  4. Copier les URL Spotify dans Downtify.
  5. Laisser Downtify écrire dans le dossier déjà surveillé par Navidrome.
  6. Attendre ou déclencher le prochain scan Navidrome.

Les lignes commençant par # sont des commentaires. Chaque autre ligne contient une URL Spotify.

Dépannage

INVALID_CLIENT: Invalid redirect URI

L’URI enregistrée chez Spotify et SPOTIFY_REDIRECT_URI doivent être strictement identiques : protocole, domaine, port, chemin, casse et barre oblique finale.

La connexion revient à l’accueil sans authentifier

Consulter les logs du conteneur et vérifier que le reverse proxy transmet les cookies. Si HTTPS se termine au niveau du proxy, utiliser TRUST_PROXY=1.

Une playlist ne s’ouvre pas

Spotify peut limiter l’accès aux morceaux des playlists à celles possédées par l’utilisateur ou sur lesquelles il collabore. Les limites du mode développement peuvent également s’appliquer.

Le conteneur est signalé comme défaillant

docker inspect --format '{{json .State.Health}}' naviport
docker logs naviport