Creator's Guide¶
Welcome to Mixtape Society! This guide will help you set up your server, create amazing mixtapes, and share them with the world.
📚 Complete Creator Journey¶
1. Installation & Setup¶
Choose your deployment method:
- Docker Compose (Recommended) - Production-ready with persistence
- Docker - Quick one-command setup
- Local Development - For contributors and testing
What you'll need:
- A music library (MP3, FLAC, etc.)
- Docker (or Python 3.11+ for local dev)
- 10 minutes for setup
2. Managing Your Collection¶
Learn to:
- View your library statistics
- Resync after adding new music
- Understand what gets indexed
- Troubleshoot collection issues
Key concepts:
- Initial indexing vs. resyncing
- What metadata is extracted
- How album art is handled
3. Creating Mixtapes¶
Master the mixtape editor:
- Search and add tracks
- Reorder for perfect flow
- Customize cover art
- Write meaningful liner notes
- Save and get your share link
Pro tips:
- Keyboard shortcuts for efficiency
- Track reference syntax in liner notes
- Cover art best practices
4. Sharing Your Mixtapes¶
Share your creations:
- Quick Share - Simple links for casual sharing
- Gift Experience - Themed landing pages for special occasions
- QR Codes - For physical gifts and events
Learn about:
- Privacy and access control
- Permanent vs. temporary sharing
- Creative sharing ideas
- When to use each method
🎯 Common Tasks¶
Creating Your First Mixtape¶
- Log in to your server
- Click "New Mixtape"
- Search and add 5-10 favorite tracks
- Add a title and optional liner notes
- Click Save
- Copy the link and share!
Adding New Music¶
- Add files to your music directory
- Log in to Mixtape Society
- Click "Collection" in navigation
- Click "Resync Library"
- Wait for indexing to complete
Sharing as a Gift¶
- Create your mixtape
- Click Save
- Choose "Gift Experience"
- Select Playful or Elegant theme
- Copy the gift link
- Share with your recipient
🔧 Installation Quick Reference¶
Docker One-Liner¶
docker run -d \
--name mixtape-society \
--restart unless-stopped \
-p 5000:5000 \
-v /path/to/your/music:/music:ro \
-v /data/mixtape-society:/app/collection-data \
-e APP_PASSWORD=YourStrongPassword123! \
ghcr.io/mark-me/mixtape-society:latest
Docker Compose¶
services:
mixtape:
image: ghcr.io/mark-me/mixtape-society:latest
container_name: mixtape-society
restart: unless-stopped
ports:
- "5000:5000"
volumes:
- /your/music:/music:ro
- mixtape_data:/app/collection-data
environment:
- APP_PASSWORD=${APP_PASSWORD}
- APP_ENV=production
volumes:
mixtape_data:
💡 Best Practices¶
Organizing Your Music Library¶
- Use consistent folder structure (Artist/Album/Tracks)
- Ensure proper ID3 tags (title, artist, album)
- Include album art in files when possible
- Use standard audio formats (MP3, FLAC, M4A)
Creating Great Mixtapes¶
- Flow matters - Order tracks for emotional journey
- Mix it up - Vary tempo and mood
- Liner notes - Explain why you chose each song
- Cover art - Use strong visual that represents the mood
- Length - 10-15 tracks is the sweet spot
Sharing Effectively¶
- Context is key - Add a personal message when sharing
- Choose the right format:
- Quick link for casual shares
- Gift theme for special occasions
- QR code for physical presents
- Privacy - Only share with people you trust
- Update when needed - Edit mixtapes after sharing if needed
🆘 Troubleshooting¶
Server Won't Start¶
Check:
- Docker is running
- Port 5000 isn't already in use
- Music directory path is correct
- You have sufficient disk space
Music Not Appearing¶
Solutions:
- Ensure files are in the mounted music directory
- Run a collection resync
- Check file formats are supported
- Verify file permissions
Sharing Link Not Working¶
Verify:
- Mixtape was saved successfully
- Server is accessible from outside your network
- Firewall allows inbound connections
- HTTPS setup is correct (if using)
❓ Frequently Asked Questions¶
How do I update my server?¶
Your mixtapes and database are preserved in volumes.
Can I edit a mixtape after sharing?¶
Yes! Edit anytime. The share link stays the same, and recipients see the updated version immediately.
How much disk space do I need?¶
- Database: ~1MB per 1000 tracks
- Cache: Up to 2GB for transcoded audio (configurable)
- Covers: ~5MB per 100 mixtapes
Can I run this on a Raspberry Pi?¶
Yes! Use the ARM-compatible Docker image. Works great on Pi 4 or newer.
Is there a user limit?¶
No built-in limits. Performance depends on your server hardware and concurrent users.
📖 Next Steps¶
Ready to dive deeper? Check out:
- Installation Guide - Full setup instructions
- Editor Guide - Master the mixtape creation tools
- Sharing Guide - Learn all sharing options
- Collection Management - Manage your music library
Happy mixtape making! 🎵
