Documentation¶
These guides are for people who run MangaPixer on their own hardware. They describe the current release; the version you are running is shown in the app footer and returned by GET /api/v1/system/info.
Install¶
| Page | What it covers |
|---|---|
| Install on Unraid | The Unraid template or Compose file: single /config folder, PUID/PGID, media shares, upgrades. |
| Install on Windows | The native package since 1.13.0: the MSI installer, the tray app, ports and LAN access, where data lives, upgrades and uninstall. |
| Install with Docker | The canonical Compose setup: volumes, media mounts, ports, first-run setup, upgrades, where backups land. |
Set up and run¶
| Page | What it covers |
|---|---|
| How MangaPixer works | The parts that run, where your data goes, what happens when you scan and read, memory use, and privacy. |
| Configuration reference | Every environment variable and settings key you can set, with defaults, plus the settings admins change in the app. |
| Library layout | How your folders and archives appear in the app, supported formats, sorting, filters, favorites, rescans and moves, and the read-only guarantee. |
| Users and access | First-run setup, admins and readers, activation links, library access, analytics, Private libraries, Incognito, sessions. |
| Backup and restore | Automatic database backups, backup settings and a custom backup folder, restoring a backup, what a backup contains, importing YACReader progress. |
| Reverse proxy and HTTPS | Putting MangaPixer behind Caddy or nginx for TLS, the forwarded headers it trusts, and exposing it to the internet. |
Use¶
| Page | What it covers |
|---|---|
| Features | Everything MangaPixer does, by area, and the supported archive and image formats. |
| Reader | Page modes, fit, image quality (Page quality, Downscale filter, Enhance), reading direction, page-turn animation, keyboard/touch controls, prefetch, resume position, read state. |
| Series information | Series details from ComicInfo.xml and, if an admin allows it, MangaUpdates: the panel and series page, search by alternative title, Identify and automatic matching, what is sent, the Metadata Manager page for admins. |
Help¶
| Page | What it covers |
|---|---|
| Troubleshooting | Health checks, logs, sign-in problems, scans that miss files, archives that won't open, missing thumbnails, backups that stopped, permission errors, port conflicts, restore problems. |
| FAQ | Short answers to common questions. |
| Privacy and security | No telemetry, what leaves your server when an admin turns on an internet feature, how sessions and logs are protected, reporting a vulnerability. |
| MangaPixer compared | How MangaPixer differs from Komga, Kavita and YACReader, and when another server is the better fit. |