Files
Musify/docs
Admin 589864e48f docs: rewrite the deploy documentation and fix the stale references
The root README was a design handoff for a prototype that is not in this repo,
web-player/README.md was the sv template, and deploy/README.md only covered
development. Replace all three and document the production deploy: its
prerequisites, what up.sh does and why nginx sits in front.

The docs under docs/ still used the pre-monorepo project paths, Ardalis.Result
instead of ErrorOr and the player.html test console that no longer exists.
2026-07-20 15:14:11 +02:00
..

Musify — Documentación

Musify es un backend de streaming de música: subir pistas, procesarlas (transcodificar el audio a .m4a y generar miniaturas), organizarlas en playlists y reproducirlas en streaming sin que los bytes pasen por la API.

Esta carpeta explica qué hace cada pieza, su propósito y por qué está diseñada así.

Índice

  • architecture.md — Visión global: componentes, cómo encajan y los flujos principales.
  • projects.md — Qué es y para qué sirve cada proyecto/solución.
  • authentication.md — Zitadel (OIDC), validación de JWT, provisioning/sync de usuarios.
  • storage.md — SeaweedFS (S3), estructura de claves, URLs prefirmadas, qué es público y qué privado.
  • streaming.md — Streaming del audio (.m4a por HTTP range) con stream-ticket (RS256) y el reverse proxy (StreamingGateway).
  • media-processing.md — El worker y los workflows de MassTransit (transcode de audio, miniaturas).
  • development.md — Cómo levantar todo en local: contenedores, puertos y comandos.
  • ../deploy/README.md — El deploy en detalle: compose, scripts y producción.

Mapa de componentes (alto nivel)

                 ┌─────────────────────────────────────────────┐
   Cliente  ───► │ Musify.Api (:5111)  API REST + emite tickets │
                 └─────────────────────────────────────────────┘
                        │ EF Core          │ presigned (subidas)   │ MassTransit (eventos)
                        ▼                  ▼                       ▼
                 PostgreSQL          SeaweedFS S3 (:8333)     RabbitMQ ──► Worker (procesa)
                 (metadatos)         (objetos)                            audio→.m4a, imágenes
                                          ▲
   Cliente  ───► StreamingGateway (:8081) ┘   sirve audio .m4a (valida ticket, proxy al filer)

   Login: Cliente ◄──► Zitadel (:8080, OIDC)   →  Musify.Api valida el JWT

Stack

  • .NET 10, C#. Minimal APIs (Musify.Api), Worker Service (Musify.Worker), ASP.NET + YARP (Musify.StreamingGateway).
  • CQRS con [Mediator] (source-generator) y resultados con ErrorOr.
  • EF Core 10 + PostgreSQL (metadatos).
  • MassTransit 8 + RabbitMQ (procesado asíncrono con routing slips/sagas).
  • SeaweedFS (almacenamiento de objetos compatible con S3, vía AWSSDK.S3).
  • ffmpeg (transcode de audio a AAC/.m4a), SixLabors.ImageSharp (miniaturas).
  • Zitadel (OIDC/OAuth2) para identidad.

Estructura del repositorio

Un solo repo: backend/ (los seis proyectos .NET), web-player/ (cliente web SvelteKit), deploy/ (stacks de Docker Compose y scripts) y docs/.