Skip to content

Latest commit

 

History

History
127 lines (99 loc) · 5.7 KB

File metadata and controls

127 lines (99 loc) · 5.7 KB
layout home
hero
name text tagline actions
TuneCamp
Federated Music Platform
Self-hosted streaming for indie artists, labels, and communities — with federation, Web3, and Subsonic support.
theme text link
brand
Get Started
/getting-started
theme text link
alt
View on GitHub
features
icon title details
🎵
Streaming & Clients
Full Subsonic API, HLS live streaming, playlists, and cross-platform client support.
icon title details
🌐
Federated by Design
ActivityPub-based federation lets instances discover and share content across the network.
icon title details
💎
Web3 & Monetization
NFT minting, Stripe payments, factory contracts, and wallet integration on Base.
icon title details
🔌
Extensible via Plugins
Custom streaming, metadata, and storage providers via a simple plugin system.
icon title details
🤖
AI-Powered Metadata
Automatic metadata enrichment and recommendations via OpenRouter integrations.
icon title details
🛡️
RBAC & Security
Role-based access control with Instance Owner, Manager, Curator, and Listener tiers.

Documentation

🚀 Getting Started

New here? Start with the Getting Started guide. It walks you from an empty machine to a running instance with music in it — install, first login, adding your library, and listening — in about 10 minutes.

Once you're up and running, the guides below go deeper.

Doc Description
Getting Started Install → first login → add music → listen (start here)
Adding Music Library layout on disk, scanning, and draft → public release — the reference for getting audio in
Deploy on Railway One-click deploy on Railway — no VPS required, HTTPS included
API & Services Setup Step-by-step configuration for Stripe, Google Drive, AI, and other integrations
Nginx Configuration Reverse proxy setup for SSL, WebSocket, and HLS
Backup & Migration Database backup, restore, and moving your instance

User Guide

For listeners and artists using a TuneCamp instance.

Doc Description
Roles & Permissions What each role (Owner, Manager, Curator, Listener) can do
Radio Broadcasting an always-on station from your library (playlists + genre mixes)
Subsonic Protocol Connecting external clients (DSub, Symfonium, Tempo, Substreamer)
Social & Community Features Posts, comments, and fan interactions
Collab Multi-artist collaborative track building: stems, version snapshots, no realtime
Becoming an Artist & Selling Artist request flow and the can_sell sales gate
Payments & Monetization Stripe checkout, crypto on-ramp, and on-chain purchases

Administrator Guide

For people running a TuneCamp instance.

Doc Description
Federation ActivityPub and HTTP gossip discovery — how instances find each other
Sidecamp Desktop Desktop application for Sidecamp, Soulseek, and Torrents
Monitoring /health endpoint, the admin System Resources panel, Sentry crash reporting, and uptime checks
Scaling SQLite / single-process limits and mitigations
MCP Setup Exposing the TuneCamp catalog to AI clients via MCP

Developer Guide

For contributors and people building on TuneCamp.

Doc Description
Contributing Code contribution guidelines and pull request process
Development Guide Local dev environment setup, running, and testing
Backend Architecture Express server, SQLite, ActivityPub, federated discovery, and the full data model / database schema
Webapp Architecture React, Vite, Zustand, and instance discovery in the frontend
API Contracts REST endpoints, authentication, and supported protocols
FID Identity Self-sovereign identity and instance passports via FID (Ed25519)

Integrations

Optional third-party services you can connect to your instance.

Doc Description
AI Integrations Metadata automation and recommendations via OpenRouter
Smart Contracts Solidity contracts (Factory, NFT, Checkout) on Base
Google Drive Cloud storage backend for media files
Sidecamp P2P acquisition (Soulseek, BitTorrent, yt-dlp) via the desktop companion app
Telegram Bot Rapid file ingestion and remote management

Reference

Doc Description
Project Overview Goals, tech stack, repository structure, source tree, and webapp component catalog
Status & Maturity Honest maturity level of each area and known limitations
Comparison with Funkwhale Differences in models and features
Audio Fingerprinting How TuneCamp deduplicates tracks in the library
Payments Security Review Internal security review findings for the payments flow

Last updated: August 22, 2026