dupe/docs/index.md

du.pe Documentation Index

📚 Complete Documentation Set

Welcome to the comprehensive documentation for du.pe - a self-hosted torrent-based file manager and media player. This documentation provides everything you need to understand, deploy, and develop the application.

🚀 Quick Start

New Users

1. README.md - Project overview and setup instructions
2. Quick Start Guide - Step-by-step installation
3. User Guide - How to use the application

Developers

1. Project Structure - Architecture overview
2. API Documentation - Complete API reference
3. Development Guide - Setup and coding guidelines

System Administrators

1. Deployment Guide - Production deployment
2. Configuration Guide - Environment setup
3. Monitoring & Maintenance - System management

---

📖 Documentation Sections

🏗️ Architecture & Structure

• Project Structure - Complete directory structure and component overview
• System Architecture - High-level system design and data flow
• Component Documentation - Frontend component details and usage
• Database Schema - Data models and relationships

🔌 API & Integration

• API Documentation - Complete REST API reference
• WebSocket Events - Real-time event documentation
• Integration Guide - Third-party service integration
• Authentication - Security and authentication details

🛠️ Development

• Development Guide - Setup, coding standards, and workflows
• Testing Guide - Unit, integration, and E2E testing
• Code Style Guide - Coding standards and best practices
• Contributing Guidelines - How to contribute to the project

🚀 Deployment & Operations

• Deployment Guide - Production deployment instructions
• Docker Guide - Container deployment and management
• Configuration Guide - Environment variables and settings
• Monitoring & Maintenance - System monitoring and upkeep

📚 User Documentation

• User Guide - Complete user manual
• Feature Guide - Detailed feature documentation
• Troubleshooting - Common issues and solutions
• FAQ - Frequently asked questions

🔒 Security & Performance

• Security Guide - Security best practices and guidelines
• Performance Guide - Optimization techniques
• Backup & Recovery - Data protection strategies

---

🎯 Navigation by Use Case

I want to set up du.pe for the first time

1. README.md - Overview and requirements
2. Quick Start Guide - Step-by-step installation
3. Configuration Guide - Initial setup
4. User Guide - Learn the basics

I want to develop new features

1. Development Guide - Setup and coding guidelines
2. Project Structure - Understand the codebase
3. API Documentation - Backend integration
4. Component Documentation - Frontend development
5. Testing Guide - Quality assurance

I want to deploy in production

1. Deployment Guide - Production setup
2. Docker Guide - Container deployment
3. Configuration Guide - Environment configuration
4. Security Guide - Hardening the deployment
5. Monitoring & Maintenance - Ongoing management

I want to integrate du.pe with other services

1. API Documentation - REST API reference
2. WebSocket Events - Real-time integration
3. Integration Guide] - Third-party service integration
4. Authentication - Secure API access

I need help with a problem

1. Troubleshooting - Common issues and solutions
2. FAQ - Frequently asked questions
3. API Documentation - API reference for debugging
4. User Guide - Usage instructions

---

📋 Quick Reference Cards

API Quick Reference

# Main endpoints
GET    /api/torrents           # List torrents
POST   /api/transfer           # Add torrent file
POST   /api/magnet             # Add magnet link
GET    /api/movies             # Movie library
GET    /api/tvshows            # TV shows library
GET    /api/files              # File browser
GET    /api/system/info        # System information

# Streaming
GET    /stream/:hash/:index    # Stream media file

# WebSocket
WS     ws://host:3001/?token   # Real-time events

Configuration Quick Reference

# Environment variables
USERNAME=admin                 # Basic auth username
PASSWORD=secure_password       # Basic auth password
TMDB_API_KEY=your_key         # Movie metadata
TVDB_API_KEY=your_key         # TV show metadata
PORT=3001                     # Server port

Directory Structure

dupe/
├── client/           # Frontend (Svelte)
├── server/           # Backend (Node.js)
├── downloads/        # Downloaded files
├── cache/           # Cached data
└── trash/           # Deleted items

Docker Commands

# Start application
docker compose up -d

# View logs
docker compose logs -f

# Stop application
docker compose down

# Rebuild
docker compose up -d --build

---

🔗 External Resources

Technology Documentation

• Svelte Documentation - Frontend framework
• Express.js Documentation - Backend framework
• WebTorrent Documentation - Torrent engine
• Node.js Documentation - Runtime environment
• Docker Documentation - Container platform

APIs and Services

• The Movie Database (TMDB) API - Movie metadata
• The TV Database (TVDB) API - TV show metadata
• Fanart.tv API - Media artwork

Development Tools

• Vite Documentation - Build tool
• WebSocket API - Real-time communication
• MDN Web Docs - Web standards

---

📝 Documentation Standards

Contribution Guidelines

• Documentation should be clear, concise, and accurate
• Include code examples and practical use cases
• Maintain consistency across all documentation files
• Use proper markdown formatting and structure
• Keep documentation up to date with code changes

Documentation Structure

Each documentation file should include:

• Clear title and description
• Overview section explaining the purpose
• Detailed sections with examples
• Cross-references to related documentation
• Quick reference cards when applicable

Version Control

• Documentation version should match application version
• Major changes should be reflected in documentation
• Maintain changelog for both code and documentation
• Use semantic versioning for releases

---

🔄 Documentation Updates

Last Updated: 2024-01-15

Documentation Version: 1.2.0

Application Version: 1.2.0

Recent Changes

• Added comprehensive API documentation
• Enhanced project structure documentation
• Added development and deployment guides
• Improved cross-referencing between documents

Planned Documentation Updates

• Complete user guide with screenshots
• Advanced troubleshooting guide
• Performance optimization guide
• Security hardening checklist

---

📞 Support & Community

Getting Help

• GitHub Issues: Report bugs and request features
• Documentation Issues: Report documentation problems
• Discussions: Community support and discussions
• Wiki: Additional community-contributed content

Contributing

We welcome contributions to both code and documentation! Please see the Contributing Guidelines for details on how to get started.

---

This index serves as the central navigation point for all du.pe documentation. Each section is cross-referenced and provides comprehensive coverage of the application from user, developer, and system administrator perspectives.