Skip to content

Example Use Cases

Complete Docker Compose configurations for common use cases.

Overview

Each example includes:

  • Use case description with target audience
  • Key features highlighted
  • Complete docker-compose.yml configuration
  • Step-by-step setup instructions
  • Expected results and validation
  • Customization options for your needs

Available Examples

  • Ebook Forum Downloader

    Automatically download ebooks from Telegram forum topics

    Perfect for: Book collectors, students, researchers

    Features: PDF/EPUB/MOBI filtering, per-topic organization, Discord notifications

    View Example

  • YouTube Channel Archiver

    Archive YouTube content shared in Telegram channels

    Perfect for: Content archivists, education, preservation

    Features: Video file filtering, automatic organization, content preservation

    View Example

  • News Media Aggregator

    Collect and organize media from news channels

    Perfect for: Journalists, researchers, media monitoring

    Features: Multi-channel aggregation, media type filtering, date-based organization

    View Example

  • Personal Chat Backup

    Backup media from personal chats and saved messages

    Perfect for: Personal archiving, data preservation, backup solutions

    Features: Comprehensive media backup, saved messages support, privacy-focused

    View Example

  • Paperless-ngx Ingestion

    Ingest documents into Paperless-ngx via Telegram

    Perfect for: Mobile scanning, receipt capture, document management

    Features: Direct consume folder integration, quick ingestion, OCR-ready

    View Example

Quick Start with Examples

Using These Examples

  1. Choose an example that matches your use case
  2. Copy the complete docker-compose.yml configuration
  3. Replace placeholder values with your credentials
  4. Customize filters and settings for your needs
  5. Deploy with docker compose up -d

Configuration Patterns

Common Settings Across Examples

All examples share these core settings:

- TDL_API_ID=YOUR_API_ID
- TDL_API_HASH=YOUR_API_HASH
- TDL_PHONE_NUMBER=YOUR_PHONE_NUMBER

Get credentials from https://my.telegram.org/apps

- TDL_DAEMON_ENABLED=true
- TDL_DAEMON_CHECK_INTERVAL=300  # Check every 5 minutes

Enables continuous background operation

- TDL_NOTIFICATIONS_ENABLED=true
- TDL_NOTIFICATIONS_DISCORD_WEBHOOK_URL=YOUR_WEBHOOK_URL
- TDL_NOTIFICATIONS_DETAIL_LEVEL=summary

Optional but recommended for monitoring

Customization Options

Each example can be customized:

  • File Filters: Change file extensions to match your needs
  • Size Limits: Adjust min/max file sizes
  • Date Ranges: Filter by message date
  • Check Frequency: Balance between responsiveness and API usage
  • Notification Detail: Choose minimal, summary, or detailed notifications

Example Comparison

Example Best For File Types Complexity Setup Time
Ebook Forum Book collectors PDF, EPUB, MOBI Medium 10 min
YouTube Archiver Content archivists MP4, MKV, WEBM Low 5 min
News Aggregator Media monitoring Images, Videos Medium 10 min
Personal Backup Personal archiving All media types Low 5 min
Paperless-ngx Document management PDF, Images Low 5 min

Need Help?

Common Questions

"Can I combine multiple examples?"

Yes! Use multiple source configurations in a single docker-compose.yml file.

"How do I modify an example for my needs?"

Each example page includes a "Customization Options" section with guidance.

"What if my use case isn't covered?"

Use the Configuration Reference to create a custom setup.

Next Steps

  1. Choose an example that matches your needs
  2. Follow the setup instructions
  3. Customize for your specific requirements
  4. Deploy and monitor

Pro Tip

Start with one of these examples and gradually customize it. It's easier than starting from scratch!