Files
pipu-music/docs/README.md
T
mrleo1nidandClaude Opus 5.5 1633b28c1a
ci / contract (сгенерированный код совпадает с openapi.yaml) (push) Successful in 47s
ci / api (push) Successful in 53s
ci / recommender (push) Successful in 37s
ci / ts (packages + web) (push) Successful in 38s
ci / mobile (Metro-бандл Android) (push) Successful in 52s
docs(deploy): add install guide for a domain with HTTPS
- docs/install-guide.md: step-by-step server setup (DNS, Docker, install.sh,
  .env, launch, checks), web and Android client setup, own reverse proxy
  variant, updates, backups and troubleshooting
- deploy/compose.tls.yaml + Caddyfile: optional Caddy with automatic
  Let's Encrypt in front of nginx (enabled via COMPOSE_FILE in .env)
- nginx: honour X-Forwarded-Proto/For from private networks
- .env.example: DOMAIN, ACME_EMAIL, COMPOSE_FILE, bootstrap admin vars
- install.sh: create caddy data dirs; release.yml: ship TLS files as assets
- deployment.md, docs index and README link to the guide

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-20 00:03:26 +03:00

3.2 KiB
Raw Permalink Blame History

Документация Pipu Music

Pipu Music — self-hosted музыкальный сервис (веб + Android) с умной бесконечной лентой «Моя волна».

Карта документов

Документ О чём
IDEA.md Исходная идея продукта глазами пользователя (вход для дизайна)
design.md Дизайн-система (токены, шрифты, анимация), кнопка волны, решения по вариантам прототипа, ссылки на макеты
architecture.md Общая архитектура, компоненты, потоки данных, структура репозитория
decisions.md ADR — принятые архитектурные решения и их обоснование
data-model.md Схема БД PostgreSQL
api.md REST API: соглашения, эндпоинты, ошибки
auth-and-roles.md Аутентификация, токены, роли и права, первый запуск
library-and-storage.md Хранилища (NFS), шаблоны путей, сканер, метаданные, поиск
uploads.md Предложение треков модераторами: очередь, квота, дубли, одобрение, раскладка в хранилище
playback.md Стриминг, транскодинг, состояние плеера, офлайн
recommendations.md Рекомендательная система и «Моя волна»
web.md Веб-клиент
mobile.md Android-приложение, офлайн, самообновление
i18n.md Локализация (ru / en, расширяемость)
testing.md Стратегия тестирования
ci-cd.md Gitea Actions: проверки и релиз по тегу
install-guide.md Пошагово: установка сервера на домен с HTTPS, подключение веба и Android
deployment.md Справочник по развёртыванию: сервисы, каталоги, переменные, бэкапы
conventions.md Соглашения по коду, git, версиям
roadmap.md Этапы разработки и критерии готовности

Стек в одном абзаце

Backend API — Go; рекомендации и аудиоанализ — Python; БД — PostgreSQL + pgvector; поиск — Meilisearch; кэш / очереди событий — Redis; раздача аудио — nginx (X-Accel-Redirect); веб — React + TypeScript + Vite; мобильное — React Native (Expo, Android); монорепо — pnpm + Turborepo; CI/CD — Gitea Actions; деплой — Docker Compose.