Skip to content

This is the multi-page printable view of this section. .

Return to the regular view of this page.

Blog

Posts, design notes, and release announcements.

News, design notes and release announcements for Stashix.

1 - Posts

News and write-ups about Stashix.

1.1 - Introducing Stashix

A self-hosted library for your comics and ebooks, now with a home on the web.

Stashix is a self-hosted library for comics and ebooks. You point it at the folders where your files already live, and it turns them into a shelf you can browse, search and read from any browser on your network.

This site is its new home: documentation, guides and release notes in one place.

Why Stashix

Most collections start as a folder of .cbz files and grow into something nobody can find their way around. Stashix keeps your files where they are and builds a library on top of them:

  • Read in the browser. The built-in reader for comics and manga saves your place on every page, per user, and has a long-strip mode for webtoons.
  • Folder watching. Drop a file into a watched folder and it appears in the library a few seconds later.
  • Metadata from your files. Series, issue numbers, creators and publishers come from ComicInfo.xml, MetronInfo.xml, sidecar files and filenames.
  • Series and issue matching. Stashix identifies each series and issue against Metron, Comic Vine and the Grand Comics Database, and fills in credits, summaries, story arcs and more. Confident matches are applied on their own; anything unclear waits for you in a review queue.
  • Full-text search across titles, series and publishers.
  • Accounts for the household. Admin and user roles, per-library permissions and age-gates.
  • Installable on your phone as a progressive web app.

Stashix reads .cbz, .cbr, .cb7 and .pdf files, plus image-based .epub files such as manga. Text ebooks can’t be read yet. Metadata you edit is saved back to your files, or kept only in the database if you’d rather Stashix never touch them.

Try it

Stashix runs with Docker Compose next to a PostgreSQL database:

cp .env.example .env   # set secrets and LIBRARIES_PATH
docker compose up -d   # then open http://localhost:4000

A setup wizard runs on first launch. The installation guide walks through every step, and the file structure guide shows how to lay out your folders so series group correctly.

What’s next

Stashix is early: the first release, 0.0.1, is being prepared. On the roadmap are more formats, more metadata sources and reading lists. Follow along, report bugs or ask questions on GitHub. Stashix is free and open source under the AGPL-3.0.

2 - Releases

Stashix releases and upgrade notes.

2.1 - Stashix 0.0.1

First public release.
Note

This version has not been released yet. The notes below may still change.

Added

  • Self-hosted library server for comics and ebooks, with multiple libraries and folder watching.
  • In-browser readers for CBZ, CBR, CB7 and PDF.
  • Metadata from file names, ComicInfo.xml and MetronInfo.xml, plus matching against external metadata sources.
  • Series, publisher (with aliases) and creator pages; full-text search.
  • Admin and user roles with per-library access and age ratings.
  • Light and dark themes; installable as a PWA.
  • Prometheus metrics on a separate port.
  • Docker image at git.aroy-art.com/aroy/stashix.

Known issues

  • The metrics listener (port 9568) has no authentication. It is not published by docker-compose.yml; set :metrics_ip to restrict it.
  • X-Forwarded-For is trusted from any client, so the IP shown in the sessions list can be spoofed.
  • Library files with many made-up XML element names can, over many scans, exhaust the atom table and crash the server.

Release notes on the Stashix repository