Skip to content
Klutch.sh Docs

Deploying Mylar3

Introduction

Mylar3 is a self-hosted automation tool for managing comic book collections. Similar to what Sonarr is for TV shows or Radarr is for movies, Mylar3 automates the process of tracking, downloading, and organizing comic books. It integrates with Comic Vine for metadata, various download clients, and organizes your collection with proper naming and folder structures.

A continuation of the original Mylar project, Mylar3 is actively maintained with Python 3 support and modern features. It handles both ongoing series and complete runs, automatically downloading new issues as they release while filling in missing back issues from your want list.

Key highlights of Mylar3:

  • Automatic Downloads: Monitors for new issues and downloads them automatically
  • Comic Vine Integration: Fetches comprehensive metadata from Comic Vine database
  • Want List Management: Track missing issues and automatically search for them
  • Multiple Download Clients: Supports SABnzbd, NZBGet, and various torrent clients
  • Post-Processing: Automatic file organization, renaming, and metadata embedding
  • CBZ/CBR Support: Works with standard comic book archive formats
  • Reading Integration: Exports to reading applications and libraries
  • Series Tracking: Monitor ongoing series with release calendars
  • Web Interface: Manage everything through a clean web UI

This guide walks through deploying Mylar3 on Klutch.sh using Docker.

Why Deploy Mylar3 on Klutch.sh

Deploying Mylar3 on Klutch.sh provides several advantages:

Always Monitoring: Your Mylar3 instance runs continuously, never missing new releases from your watched series.

Persistent Library: Your configuration, database, and download history persist across container restarts.

Remote Management: Add new series, check upcoming releases, and manage your collection from anywhere.

Simplified Deployment: Push to GitHub and Klutch.sh handles the infrastructure.

HTTPS by Default: Secure access to your Mylar3 dashboard with automatic SSL certificates.

Prerequisites

Before deploying Mylar3 on Klutch.sh, ensure you have:

Understanding Mylar3 Architecture

Mylar3 uses several integrated components:

Web Interface: Python-based web application for managing your collection.

Comic Vine API: Primary source for comic metadata, covers, and issue information.

Download Client Integration: Communicates with SABnzbd, NZBGet, or torrent clients to handle downloads.

Indexer Integration: Searches Usenet indexers or torrent trackers for releases.

Post-Processor: Organizes downloaded files with proper naming and folder structure.

SQLite Database: Stores series information, want lists, and history.

Preparing Your Repository

Create a GitHub repository for your deployment.

Repository Structure

mylar3-deploy/
├── Dockerfile
└── .dockerignore

Creating the Dockerfile

FROM lscr.io/linuxserver/mylar3:latest


# Environment configuration
ENV PUID=1000
ENV PGID=1000
ENV TZ=UTC


# Expose web interface
EXPOSE 8090


# Volumes for data and comics
VOLUME ["/config", "/comics", "/downloads"]

Creating the .dockerignore File

.git
.github
*.md
LICENSE
.gitignore
.DS_Store

Deploying Mylar3 on Klutch.sh

    Get Comic Vine API Key

    1. Create an account at Comic Vine
    2. Navigate to the API page
    3. Copy your API key for later configuration

    Push Your Repository to GitHub

    Initialize and push your repository with the Dockerfile to GitHub.

    Create a New Project on Klutch.sh

    Navigate to the Klutch.sh dashboard and create a project named “mylar3” or “comics”.

    Create a New App

    Create a new app and connect your GitHub repository.

    Configure HTTP Traffic

    Mylar3 serves its web interface over HTTP:

    • Select HTTP as the traffic type
    • Set the internal port to 8090

    Set Environment Variables

    Configure the application:

    VariableValue
    PUID1000
    PGID1000
    TZYour timezone (e.g., America/New_York)

    Attach Persistent Volumes

    Configure storage:

    Mount PathRecommended SizePurpose
    /config2 GBConfiguration, database, and cache
    /comics100+ GBYour comic book library
    /downloads50 GBTemporary download location

    Deploy Your Application

    Click Deploy to build and start your Mylar3 instance.

    Access Mylar3

    Visit https://your-app-name.klutch.sh to access the web interface.

Initial Configuration

First-Time Setup

On first access to Mylar3:

  1. Navigate to Settings (gear icon)
  2. Complete the configuration wizard
  3. Set up essential connections

Comic Vine API Configuration

Configure your metadata source:

  1. Go to Settings > Web Interface
  2. Enter your Comic Vine API key
  3. Test the connection
  4. Configure rate limiting to respect API limits

Download Client Setup

Connect to your download client:

For SABnzbd:

  1. Go to Settings > Download Settings
  2. Enable SABnzbd
  3. Enter SABnzbd URL and API key
  4. Configure download category

For NZBGet:

  1. Go to Settings > Download Settings
  2. Enable NZBGet
  3. Enter NZBGet URL and credentials
  4. Configure category mapping

Indexer Configuration

Add your Usenet or torrent indexers:

  1. Go to Settings > Search Providers
  2. Add indexer details (URL, API key)
  3. Test each indexer connection
  4. Configure priority order

Managing Your Comic Library

Adding Series

Track comic series:

  1. Go to Comics > Add Series
  2. Search by name or Comic Vine ID
  3. Select the correct series from results
  4. Configure monitoring options:
    • All issues
    • Future issues only
    • Specific issue range
  5. Set quality preferences

Want List Management

Track missing issues:

  1. Navigate to Wanted section
  2. View all missing issues
  3. Trigger manual searches
  4. Configure automatic searching

Search for specific issues:

  1. Find the series in your library
  2. Locate the specific issue
  3. Click search icon
  4. Review and select from results

File Organization

Folder Structure

Configure how Mylar3 organizes files:

  1. Go to Settings > Import/Export
  2. Set comic library path
  3. Configure folder naming template
  4. Configure file naming template

Naming Templates

Example templates:

Series Folder: {Series Name} ({Year})

Issue File: {Series Name} #{Issue Number} ({Year})

Post-Processing

Automate file handling:

  1. Enable post-processing in settings
  2. Configure file operations
  3. Set up metadata tagging
  4. Enable cover art embedding

Integration with Reading Apps

Komga Integration

Export to Komga comic server:

  1. Configure export settings in Mylar3
  2. Set library path matching Komga
  3. Enable metadata export
  4. Trigger library scans

Kavita Integration

Work with Kavita reader:

  1. Point both applications to same library
  2. Configure compatible naming
  3. Enable metadata embedding
  4. Schedule regular updates

ComicRack/CDisplayEx

For local reading:

  1. Export with embedded metadata
  2. Use ComicInfo.xml generation
  3. Maintain compatible folder structure

Advanced Features

Upcoming Releases

Track future releases:

  1. Navigate to Upcoming section
  2. View release calendar
  3. Configure lookback period
  4. Set up notifications

Duplicate Handling

Manage multiple versions:

  1. Configure duplicate detection
  2. Set quality preferences
  3. Enable automatic upgrades
  4. Define keep/replace rules

Mass Editing

Bulk operations:

  1. Select multiple series
  2. Apply common settings
  3. Trigger bulk searches
  4. Refresh metadata in bulk

Production Best Practices

API Rate Limiting

Respect Comic Vine limits:

  • Configure appropriate request intervals
  • Use caching for metadata
  • Avoid excessive refreshes

Storage Planning

Comic files can be large:

  • Plan for 50-500MB per issue for high quality
  • Consider series length when estimating
  • Monitor storage usage regularly

Backup Strategy

Protect your configuration:

  1. Backup the /config directory regularly
  2. Export your series list
  3. Store download history
  4. Document custom settings

Troubleshooting

Comic Vine API Errors

  • Verify API key is valid
  • Check rate limiting settings
  • Confirm network connectivity
  • Review API quota usage

Downloads Not Starting

  • Verify download client connection
  • Check indexer credentials
  • Review category settings
  • Check client download queue

Files Not Being Processed

  • Verify folder permissions
  • Check file naming compatibility
  • Review post-processing logs
  • Confirm file format support

Missing Series Metadata

  • Manual refresh from Comic Vine
  • Check series ID mapping
  • Verify API connectivity
  • Try manual search by Comic Vine ID

Additional Resources

Conclusion

Deploying Mylar3 on Klutch.sh gives you a powerful comic book management system that automatically tracks, downloads, and organizes your collection. The integration with Comic Vine provides rich metadata, while download client integration automates the acquisition process.

Whether you’re keeping up with current releases or building out back issues of classic series, Mylar3 on Klutch.sh provides reliable, always-on management for your comic collection.