README
¶
Monbooru
Your own self-hosted, lightweight and fast booru.
Designed for organizing your local media collection, including AI-generated images (Stable Diffusion, ComfyUI, A1111/Forge). Completely offline by design. Supports ONNX models for local auto-tagging of your collection (WD14, JoyTag...).
Features
- Tag-based gallery with folder tree, favorites, saved searches, collections, related-image suggestions, and rating tags (general / sensitive / questionable / explicit) with a SFW ceiling
- Stable Diffusion metadata from A1111/Forge and ComfyUI: prompts, models, seeds, full workflows
- Local ONNX auto-tagging (WD14 SwinV2, JoyTag, Camie v2, or any compatible model) on CPU or GPU
- Images, video, animated GIFs, plus CBZ/ZIP archives browsed as a single object with a built-in manga reader; animated hover previews on the grid
- Search with wildcards, OR, exclusions, plus filters on folder, date, size, dimensions, category, generation recipe, and more
- Tag management: merge duplicates, create aliases, implications, custom categories
- Image relations: declared duplicates, alternates, version chains, derivatives; plus near-duplicate detection
- Batch operations on a selection or a whole search: delete, move, add/remove tags, auto-tag
- File watcher that catches new, moved, and deleted files within seconds; multi-file browser upload; SHA-256 dedup so the same file under two paths is one image
- Inbox workflow : new images land in the inbox for review
- Multiple galleries in one instance, each with its own filesystem and database; per-gallery export/import; import data from supported booru applications
- REST API for third-party integrations
- Companion downloader (monloader) imports images and tags from supported boorus and galleries to monbooru.
- Optional password login
Quick start (Docker)
Edit the volume paths in docker/docker-compose.yml, then docker compose up -d. The app is available at http://localhost:8080.
See docs/README.md for installing, configuration, auto-tagger setup, environment variables, REST API, building from source, and other operational notes. Check the in-app help to see how to use the application (search syntax, tag input, keyboard shortcuts, ...).
Warning
Intended for local network use. This project is not designed for direct exposure to the public internet.
Acknowledgements
Thanks to @gary-host-laptop for ongoing feature requests and feedback.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
monbooru
command
|
|
|
internal
|
|
|
api
Package api implements the /api/v1/ REST handlers for monbooru.
|
Package api implements the /api/v1/ REST handlers for monbooru. |
|
gallery
Monbooru is a Linux-only deployment; path handling assumes forward slashes.
|
Monbooru is a Linux-only deployment; path handling assumes forward slashes. |
|
logx
Package logx is a thin level gate over the stdlib log package.
|
Package logx is a thin level gate over the stdlib log package. |
|
relations
Package relations manages the operator-declared graph between images: duplicate groups, alternate groups, directed version chains, directed derivative trees, and the "not related" rejection set.
|
Package relations manages the operator-declared graph between images: duplicate groups, alternate groups, directed version chains, directed derivative trees, and the "not related" rejection set. |
|
search
Package search implements the Monbooru query language parser and SQL executor.
|
Package search implements the Monbooru query language parser and SQL executor. |
|
searchkw
Package searchkw declares the search query language's filter-keyword vocabulary as a leaf data package.
|
Package searchkw declares the search query language's filter-keyword vocabulary as a leaf data package. |
|
web/compatibility
Package compatibility translates foreign gallery exports (zipped Hydrus exports, ...) into the same in-memory shape the monbooru-native light import consumes.
|
Package compatibility translates foreign gallery exports (zipped Hydrus exports, ...) into the same in-memory shape the monbooru-native light import consumes. |