Aller au contenu

Introduction ​

TypeType n'est pas une seule application, c'est un écosystème auto-hébergeable. Un déploiement est un ensemble de services qui coopèrent : une application web, un serveur API, un service de jetons et de navigateur, un téléchargeur, et les stockages de données dont ils dépendent. Ensemble, ils vous permettent de faire tourner votre propre plateforme vidéo de bout en bout.

Ce guide couvre à la fois l'installateur pris en charge et une installation manuelle avec Docker Compose. L'installateur crée le .env, génère les secrets, choisit des ports libres et provisionne le stockage objet. Le chemin manuel décrit le même déploiement en commandes simples, pour que vous puissiez inspecter et maîtriser chaque étape.

Les composants ​

ComposantDépôt / imageRôle
Application webghcr.io/typetype-video/typetypeL'interface, plus un nginx qui relaie /api vers le serveur
Serveur APIghcr.io/typetype-video/typetype-serverComptes, extraction, API REST, le cœur de l'écosystème
Téléchargeurghcr.io/typetype-video/typetype-downloaderPrépare les téléchargements et les range dans le stockage objet
Tokenghcr.io/typetype-video/typetype-tokenJetons PO de YouTube, décodage du lecteur, métadonnées SABR, sous-titres et connexion distante optionnelle
Base de donnéespostgresComptes, historique, playlists, paramètres
CachedragonflyCache compatible Redis
Stockage objetgarageStockage compatible S3 pour les téléchargements

D'autres clients peuvent utiliser le même serveur API : un seul déploiement auto-hébergé peut donc servir plus que l'application web.

Comment ils s'assemblent ​

Seule l'application web doit être joignable par vos utilisateurs. En production, vous placez un proxy inverse devant elle et la servez en HTTPS, comme décrit dans Proxy inverse et HTTPS.

Token est un service interne, mais il n'est pas optionnel pour la lecture YouTube actuelle. YOUTUBE_REMOTE_LOGIN_ENABLED ne commande que la connexion interactive à YouTube ; les jetons PO, le décodeur, les sous-titres et SABR passent toujours par Token quand la connexion distante est désactivée.

Pour savoir quel dépôt possède quoi et connaître le chemin de lecture dans le navigateur, voir la vue d'ensemble du projet et Lecture et téléchargements.

À quoi cela ressemble ​

Une instance auto-hébergée une fois lancée, en train de lire une vidéo, de chercher, et ses paramètres :

Regarder une vidéo sur une instance auto-hébergée


Résultats de recherche


La page des paramètres


La lecture en action :

Lecture vidéo

Comment ce guide est organisé ​

  1. Architecture : comment les pièces communiquent, et où vivent les données.
  2. Limites de sécurité : ce qui est public, interne, et appuyé sur un navigateur.
  3. Prérequis : ce qu'il vous faut avant de commencer.
  4. Démarrage rapide : l'installation recommandée en une commande.
  5. Installation manuelle : la même chose à la main, pas à pas.
  6. Configuration : chaque variable d'environnement, expliquée.
  7. Importer vos données : ramener abonnements, playlists, historique.
  8. Proxy inverse et HTTPS : l'exposer sur votre domaine.
  9. Maintenance : mises à jour, sauvegardes et journaux.
  10. Beta et main : faire tourner les canaux stable et préversion.
  11. Signaler un problème : comment signaler les bugs.
  12. Dépannage : problèmes courants et solutions.

D'où viennent les fichiers ?

Le docker-compose.yml, le .env.example et les scripts de la stack cités tout au long de ce guide se trouvent dans le dépôt TypeType. L'image web inclut sa configuration nginx, et Compose initialise la configuration par défaut de Garage dans un volume nommé. Clonez d'abord le dépôt central (voir Installation manuelle ou Démarrage rapide).