README
¶
Monbooru
Your own self-hosted and lightweight booru.
Designed for organizing your local media collection, including AI-generated images (Stable Diffusion, ComfyUI, A1111/Forge). Works fully offline and with no telemetry. Supports ONNX models for local auto-tagging of your collection (WD14, JoyTag...).
Features
- Tag-based gallery with folder tree, favorites, saved searches, related-image suggestions
- Videos and animated GIFs alongside images, with animated hover previews on the grid
- Watcher that picks up new, moved, and deleted files within a few seconds; multi-file browser upload; SHA-256 dedup so the same file under two paths is recognised as one image
- Stable Diffusion metadata extraction from A1111/Forge and ComfyUI (prompts, models, seeds, full workflow)
- Optional auto-tagging with local ONNX models (WD14, JoyTag, or any compatible model), CPU or GPU (CUDA)
- Search with wildcards, OR, exclusions, plus filters on folder, date, size, dimensions, category, generation recipe...
- Built-in rating tags (general / sensitive / questionable / explicit) with a SFW ceiling toggle in the footer that hides anything above the chosen level
- Tag merging into a canonical name (the alias keeps resolving on later adds and searches), custom tag categories with their own colors
- Batch operations on a selection or on a whole search: delete, move, add/remove tags, auto-tag
- Multiple galleries, each with its own filesystem and database; switch between them at runtime
- Per-gallery export and import for backup or migration. The importer also reads Hydrus network and Blombooru exports - see docs/MIGRATING.md
- REST API for third-party integrations (e.g. adding images to the gallery from an external app)
- Optional password login (off by default)
- Fully offline, no inbound or outbound internet connection
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/HELP.md for search syntax, auto-tagger setup, environment variables, keyboard shortcuts, REST API, building from source, and other operational notes.
Warning
Intended for local network use. This project is not designed for direct exposure to the public internet.
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. |
|
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. |
Click to show internal directories.
Click to hide internal directories.