docs: sync 7ba58c83bd56

Author: leqwin

.github/workflows/pages.yml

@@ -0,0 +1,30 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v4
+      - run: ./build.sh
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: public
+      - id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,4 @@
+public/
+resources/
+bin/
+.hugo_build.lock

README.md

@@ -0,0 +1,15 @@
+# mondocs
+
+User documentation for **monbooru**, a self-hosted booru for your
+local image collection, and its two optional addons:
+
+- **monloader** - a companion downloader and reverse-lookup service
+- **monsender** - a browser extension that sends pages to monloader
+
+Start reading at [content/_index.md](content/_index.md), or jump
+straight to an addon: [monloader](content/addons/monloader/_index.md),
+[monsender](content/addons/monsender/_index.md).
+
+## License
+
+Documentation for AGPL-3.0-or-later projects; same license applies.

REPOSITORY.md

@@ -0,0 +1 @@
+https://github.com/leqwin/mondocs

build.sh

@@ -0,0 +1,47 @@
+#!/bin/sh
+set -eu
+
+cd "$(dirname "$0")"
+
+HUGO_VERSION=0.148.2
+MIN_MINOR=146
+BIN_DIR=bin
+
+hugo_ok() {
+    minor=$("$1" version 2>/dev/null | sed -n 's/^hugo v0\.\([0-9]*\).*/\1/p')
+    [ -n "$minor" ] && [ "$minor" -ge "$MIN_MINOR" ]
+}
+
+download_hugo() {
+    case "$(uname -s)" in
+        Linux)  os=linux ;;
+        Darwin) os=darwin ;;
+        *) echo "build.sh: unsupported OS $(uname -s), install Hugo 0.$MIN_MINOR+ yourself" >&2; exit 1 ;;
+    esac
+    case "$(uname -m)" in
+        x86_64)        arch=amd64 ;;
+        aarch64|arm64) arch=arm64 ;;
+        *) echo "build.sh: unsupported arch $(uname -m), install Hugo 0.$MIN_MINOR+ yourself" >&2; exit 1 ;;
+    esac
+    [ "$os" = darwin ] && arch=universal
+    url="https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_${HUGO_VERSION}_${os}-${arch}.tar.gz"
+    echo "downloading hugo $HUGO_VERSION ($os-$arch) into $BIN_DIR/"
+    mkdir -p "$BIN_DIR"
+    if command -v curl >/dev/null 2>&1; then
+        curl -fsSL "$url" | tar -xz -C "$BIN_DIR" hugo
+    else
+        wget -qO- "$url" | tar -xz -C "$BIN_DIR" hugo
+    fi
+}
+
+if [ -x "$BIN_DIR/hugo" ] && hugo_ok "$BIN_DIR/hugo"; then
+    HUGO=$BIN_DIR/hugo
+elif command -v hugo >/dev/null 2>&1 && hugo_ok hugo; then
+    HUGO=hugo
+else
+    download_hugo
+    HUGO=$BIN_DIR/hugo
+fi
+
+"$HUGO" --gc --cleanDestinationDir
+echo "built into public/"

content/_index.md

@@ -0,0 +1,75 @@
+---
+title: monbooru
+---
+
+monbooru is a private booru you run on your own machine. A booru is a
+tag-based image gallery: instead of sorting pictures into folders you
+attach tags to them (`red_hair`, `character:hakurei_reimu`, `rating:general`)
+and find things back by combining tags in a search.
+
+![The gallery grid](gallery.png)
+
+It is built for organizing a local media collection: your own photos
+and videos, downloaded art, manga archives, and AI-generated images.
+Everything runs from a single small binary with one SQLite database
+per gallery. Your files stay ordinary files on disk; removing monbooru
+leaves them exactly where they were.
+
+monbooru itself never touches the internet. Online features
+(downloading from boorus, reverse image lookup) are handled by the
+optional [addons](addons/_index.md).
+
+> **Local network only.** monbooru is designed for a trusted home
+> network or private VPN. It is not hardened for direct exposure to
+> the public internet. If you expose it anyway, the extra hardening
+> (TLS, access control...) is on you.
+
+## What it does
+
+- Tag-based gallery with a folder tree, favorites, saved searches,
+  collections and rating tags with an SFW ceiling. See
+  [Searching](guides/searching/index.md) and [Tags](guides/tags/index.md).
+- A file watcher picks up new, moved and deleted files within seconds,
+  and new images land in an [inbox](guides/inbox/index.md) for review.
+- Reads Stable Diffusion metadata (A1111/Forge and ComfyUI): prompts,
+  models, seeds, full workflows. See [AI metadata](guides/ai-metadata.md).
+- Local [auto-tagging](guides/auto-tagger.md) with ONNX models (WD14
+  SwinV2, JoyTag, Camie v2) on CPU or GPU.
+- Images, video, animated GIFs, plus CBZ/ZIP archives browsed as one
+  object with a built-in manga reader.
+- [Relations](guides/relations/index.md) between images: duplicates,
+  alternates, version chains, derivatives, with near-duplicate
+  detection and a side-by-side review session.
+- [Multiple galleries](guides/galleries/index.md) in one instance, each with
+  its own files and database, plus export, import and
+  [migration](guides/migrating.md) from Hydrus or Blombooru.
+- Reverse [lookup](guides/lookup/index.md) of your images against boorus,
+  IQDB/SauceNAO and the Hydrus PTR, through a paired monloader.
+- A REST API with scoped tokens, covered in
+  [Development](development.md).
+
+## Where to go
+
+- [Install](getting-started/install.md) gets it running with Docker in
+  a few minutes; [First steps](getting-started/first-steps/index.md) walks
+  the UI.
+- The [guides](guides/_index.md) cover each feature in day-to-day terms.
+- [Configuration](configuration.md) has the environment variables,
+  theming and advanced tagger setup.
+
+## Addons
+
+monbooru works on its own, and nothing in it depends on the other apps
+being present. Two optional companions extend it:
+
+- **[monloader](addons/monloader/_index.md)** adds the online half: it
+  downloads posts from booru sites into your collection with their
+  tags, and runs reverse lookups on images you already have to
+  backfill tags and sources. monbooru stays offline; monloader connects to the internet.
+- **[monsender](addons/monsender/_index.md)** adds the browser shortcut: an
+  extension that sends the page you are viewing, or images picked from
+  it, straight to monloader's download queue. It needs monloader.
+
+The [addons overview](addons/_index.md) explains how the pieces fit,
+and the [quick start](addons/quick-start.md) adds both to a running
+monbooru.

content/addons/_index.md

@@ -0,0 +1,34 @@
+---
+title: Addons
+weight: 95
+---
+
+monbooru is the main application: it owns your images and their tags, on your
+disk, in one SQLite file per gallery. By design it makes no network
+requests of its own, so your collection and your browsing stay
+entirely local. You can run it alone forever: nothing in monbooru
+depends on the other apps being present.
+
+The addons exist so monbooru can stay offline while you still get
+online features. You add them when you want them:
+
+**[monloader](monloader/_index.md)** connects to the internet on monbooru's behalf. When you want
+something from the web - download a post from a booru site, look up
+where an image came from, pull tags for a file you already have -
+monbooru asks monloader, and monloader does the online part. It
+downloads with gallery-dl, translates each site's metadata into
+monbooru's tags and ratings, and pushes the result into a gallery.
+Features in monbooru that need it (lookups, refreshing sources) stay
+hidden until a monloader is connected.
+
+**[monsender](monsender/_index.md)** adds a send button to your
+browser, once monloader is in place. You are looking at a page; you
+press the toolbar button; the page lands in monloader's queue and,
+once downloaded and mapped, appears in monbooru with its tags.
+
+In one line: monbooru holds, monloader loads, monsender sends.
+
+The apps connect by [pairing](pairing.md): each link is approved once
+in the receiving app's settings, and the apps exchange scoped API
+tokens on their own. The [quick start](quick-start.md) walks through
+adding both addons to a running monbooru.

content/addons/monloader/_index.md

@@ -0,0 +1,40 @@
+---
+title: monloader
+weight: 30
+---
+
+monloader is the downloader that feeds [monbooru](../../_index.md).
+Paste the URL of a booru post, a pool, a tag search, an artist page, or a
+direct image link; monloader fetches the files and their per-post metadata,
+maps that metadata onto monbooru's data model, and pushes each file into a
+monbooru gallery over its API.
+
+![The monloader add page](add.png)
+
+The actual scraping is done by
+[gallery-dl](https://github.com/mikf/gallery-dl), so any site gallery-dl
+supports works. monloader adds the download queue, the metadata mapping, and
+the push into monbooru, with curated profiles that sharpen the result for
+50-plus known sites.
+
+It also runs in reverse: for a file monbooru already holds, monloader can
+find tags by file hash and by image similarity (IQDB, SauceNAO) across the
+boorus, and optionally from a local copy of the Hydrus Public Tag
+Repository, then fold them back into the image. See
+[reverse lookup](guides/lookup/index.md).
+
+The two apps stay separate on purpose: monbooru holds your files and needs
+no internet access, while monloader has internet access but never touches
+the gallery files - everything flows through monbooru's API. monloader is
+intended for your local network; its UI is not designed to be exposed to the
+public internet.
+
+- [Install](getting-started/install.md) - run it in Docker or Podman next to monbooru.
+- [Pairing](getting-started/pairing/index.md) - connect it to monbooru and to the monsender extension.
+- [Downloading](guides/downloading/index.md) - the queue, outcomes, retries, pools and manga.
+- [Sites and credentials](guides/sites/index.md) - site profiles, logins, cookies files.
+- [Metadata mapping](guides/mapping.md) - how tags, ratings, and sources land in monbooru.
+- [Reverse lookup](guides/lookup/index.md) - find tags for files you already have.
+- [Hydrus PTR](guides/ptr/index.md) - the optional offline tag database.
+- [Configuration](configuration.md) - the TOML file, environment variables, theming.
+- [API and development](development.md) - tokens, error codes, building from source.