Skip to Content
DocsApplicationsMedia ManagementMylar3
Mylar3

Mylar3

Overview

Mylar3 is an automated comic book downloader for NZB and torrent workflows, written in Python and built for cbr/cbz libraries. QuickBox installs Mylar3 under a per‑user path and manages it as a systemd service, with a dedicated config file and web UI route per user.

You can also set an optional comics library path during install. If you leave it blank, QuickBox uses the default comics directory under the user home and creates it when needed.

Key features

These are the QuickBox behaviors that shape how Mylar3 is installed, routed, and managed.

📚 Custom comics library path

Install and reinstall support an optional comics path, with a default of /home/username/Media/Comics if left blank.

🌐 Per-user web route

QuickBox sets http_root = /username/mylar and installs an nginx location at /username/mylar that proxies to the local service.

🔐 Basic auth in nginx

The nginx location uses auth_basic with the user htpasswd file at /etc/htpasswd.d/htpasswd.username.

⚙️ Managed service and config

Mylar3 runs as mylar3@username with settings in /etc/default/username.mylar and /home/username/.config/Mylar3/config.ini.

When to use it

Mylar3 is a good fit when you want a dedicated comics manager that integrates with your existing download clients and is isolated per QuickBox user.

Good fit if

  • You want an automated comics workflow for NZB and torrent downloads.
  • You need a per-user web route like /username/mylar for multi-user servers.
  • You prefer systemd-managed services with predictable paths per user.

You can do this in QuickBox

  • Install Mylar3 from the CLI or Dashboard and optionally set a custom comics path.
  • Access the UI through the nginx route at /username/mylar.
  • Manage the service through the mylar3@username unit that QuickBox creates.

Installation

QuickBox supports Mylar3 install, reinstall, update, and removal through the CLI and the Dashboard. The comics path is optional and can be provided during install or reinstall.

Install from the QuickBox CLI

The Mylar3 installer accepts the user with -u and an optional comics path using -clp or —comic-location-path.

qb install mylar3 -u username
qb install mylar3 -u username -clp /path/to/comics
 
qb reinstall mylar3 -u username
qb reinstall mylar3 -u username -clp /path/to/comics
 
qb update mylar3 -u username
qb remove mylar3 -u username

Install from the Dashboard

The Dashboard exposes Mylar3 install and reinstall actions, labeled “Mylar3 Install” and “Mylar3 Reinstall.” The install form allows an optional comics path; if left blank, the default location is /home/username/Media/Comics and QuickBox will create the directory if it does not exist.

Access and authentication

Mylar3 is deployed as a local service and accessed through an nginx reverse proxy path. QuickBox also wires basic authentication at the proxy layer.

URL / route

The nginx config uses a per-user location at /username/mylar and proxies to http://127.0.0.1:assigned-port/username/mylar/ . The Mylar3 config sets http_root = /username/mylar to match this route.

Credentials / tokens

Mylar3 stores its API key in /home/username/.config/Mylar3/config.ini as the api_key value. The QuickBox dashboard reads that file to display the key when needed.

Security notes

The nginx location is protected with auth_basic using /etc/htpasswd.d/htpasswd.username. The installer warns that enabling Mylar3’s own browser auth can conflict with nginx auth digest, so use only one auth layer at a time.

Ports and networking

Mylar3 has a base/default web port and QuickBox can auto-assign a nearby available port during install. The assigned value is written into the service and nginx configs, and also stored in the QuickBox database.

  • Base/default port: 8090.
  • Assigned port: QuickBox auto-generates a port within $\pm 50$ of the base when auto-assignment is enabled, and checks that the candidate port is free before use.
  • Where to confirm the live port:
    • /etc/default/username.mylar (the MYLAR_PORT value)
    • /etc/nginx/software/username.mylar3.conf (proxy target)
    • /home/username/.config/Mylar3/config.ini (the http_port value)
    • QuickBox stores the assigned port in the user_software database record and the dashboard reads it with getSoftwarePort

Configuration and files

Mylar3’s config and service files are installed in per‑user paths. The tree below mirrors the paths QuickBox writes during install.

Mylar3 paths created by QuickBox
/
opt/
└── username/
│ ├── Mylar3/# Application install directory
│ └── lib/
│ │ └── python/
│ │ │ └── Mylar3/# Python venv and dependencies
home/
└── username/
│ ├── .config/
│ │ └── Mylar3/
│ │ │ └── config.ini# Mylar3 settings and api_key
│ ├── tmp/
│ │ └── Mylar3/# Installer temp directory
│ └── Media/
│ │ └── Comics/# Default comics library path
etc/
├── default/
│ └── username.mylar# Daemon options including MYLAR_PORT
├── nginx/
│ └── software/
│ │ └── username.mylar3.conf# nginx location block and proxy target
├── systemd/
│ └── system/
│ │ └── mylar3@username.service# Per-user systemd service
└── htpasswd.d/
│ └── htpasswd.username# nginx basic auth credentials
var/
└── run/
│ └── mylar/# Runtime directory for PID file

Common tasks

QuickBox manages Mylar3 with the mylar3@username systemd unit and tracks its version and port in the QuickBox database. Updates stop the service, refresh the code and virtual environment, then start the service again.

If you need to confirm what QuickBox will manage, use the file locations above and check the service unit, default options file, and nginx config for the active user.

Best practices

Use these guidelines to keep Mylar3 predictable and easy to troubleshoot in QuickBox.

Do

  • Keep the comics library path stable once set, or reinstall with a new -clp path if you must change it.
  • Use the nginx route at /username/mylar instead of direct port access.
  • Back up /home/username/.config/Mylar3/config.ini before major changes or updates.

Don't

  • Do not enable Mylar3 browser auth if nginx auth digest is enabled for the proxy location.
  • Do not edit MYLAR_PORT in /etc/default/username.mylar without also updating the nginx proxy and config.ini port.
  • Do not delete /home/username/tmp/Mylar3 while an install or update is running.

Troubleshooting

Start with the route, auth file, and config.ini values that QuickBox writes during install.

UI loads but redirects or 404s

Confirm http_root = /username/mylar and http_port in /home/username/.config/Mylar3/config.ini, and verify the nginx location in /etc/nginx/software/username.mylar3.conf.

Auth prompt repeats or fails

The nginx config uses auth_basic and /etc/htpasswd.d/htpasswd.username. If you enabled Mylar3’s own auth and nginx auth digest, disable one layer to avoid conflicts.

Port mismatch after install or update

Check MYLAR_PORT in /etc/default/username.mylar and compare it to http_port in /home/username/.config/Mylar3/config.ini and the nginx proxy target.

Resources

Use the official project pages and the QuickBox community for updates and support.

Mylar3 resources

Mylar3 GitHub repository

Source code and releases

Join the Community

Media server operators sharing configs, getting support, and shaping the future of QuickBox Pro.

Dedicated Support
Feature Previews
Community Configs
Active Discussions
Join Discord Server
MedusaRadarr