docs: sync 0fb5e01b263d

Author: leqwin

.gitignore

@@ -2,3 +2,7 @@ public/
 resources/
 bin/
 .hugo_build.lock
+
+.frontmatter/
+.vscode/
+frontmatter.json

README.md

@@ -6,7 +6,7 @@ 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 [here](https://leqwin.github.io/mondocs/index.html).
+Start reading [here](https://monbooru.github.io/mondocs/index.html).
 
 ## License
 

REPOSITORY.md

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

content/_index.md

@@ -42,19 +42,19 @@ optional [addons](addons/_index.md).
   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.
+  [migration](guides/migrating.md) from other similar applications.
 - Reverse [lookup](guides/lookup/index.md) of your images against boorus,
-  IQDB/SauceNAO and the Hydrus PTR, through a paired monloader.
+  IQDB/SauceNAO and the Hydrus PTR, through a paired monloader, and
+  [contributing tags back](guides/ptr-contributions/index.md) to the PTR.
 - 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
+- [Install](getting-started/install.md) gets it running with Docker; [First steps](getting-started/first-steps/index.md) to walk
   the UI.
-- The [guides](guides/_index.md) cover each feature in day-to-day terms.
-- [Configuration](configuration.md) has the environment variables,
+- The [guides](guides/_index.md) cover the main features.
+- [Configuration](configuration.md) has shows the environment variables,
   theming and advanced tagger setup.
 
 ## Addons
@@ -66,7 +66,7 @@ being present. Two optional companions extend 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
+- **[monsender](addons/monsender/_index.md)** adds a shortcut between monbooru and monloader in your browser: it's an
   extension that sends the page you are viewing, or images picked from
   it, straight to monloader's download queue. It needs monloader.
 

content/addons/monloader/add.png

@@ -23,6 +23,7 @@ api_token       = ""                     # set by pairing, or by hand for a manu
 web_url         = ""                     # browser-facing monbooru base for links; blank =
                                          # api_url for image links, monbooru link hidden
 default_gallery = ""                     # blank = monbooru's active gallery
+paused          = false                  # set by the footer light; holds the link without unpairing
 
 [downloader]
 concurrency            = 1               # worker goroutines; applies on restart
@@ -53,7 +54,7 @@ data_path   = "/ptr"
 address     = "https://ptr.hydrus.network:45871"
 access_key  = ""                         # empty = the PTR's public read-only key
 fetch_sleep = 1.0
-min_free_gb = 80
+min_free_gb = 70
 
 [lookup]                                 # the lookup chain's similarity stage
 min_similarity = 80                      # percent; candidates below are ignored
@@ -124,7 +125,7 @@ key:
 
 | Variable | Effect |
 |---|---|
-| `TZ` | Timezone name (e.g. `Europe/Paris`) for displayed timestamps. Defaults to `UTC`. Any IANA name works without extra packages. |
+| `TZ` | Timezone name (default `UTC`) for displayed timestamps. Any IANA name works. |
 
 ## Raw gallery-dl passthrough
 
@@ -138,7 +139,7 @@ the escape hatch for gallery-dl options monloader does not manage itself.
 Set `custom_css` in `[server]` to a file path and monloader serves it at
 `/custom.css`, linked after the bundled stylesheet, so a `:root` block there
 wins the cascade. One custom stylesheet can theme monbooru and monloader
-together: the tag-category color tokens are identical.
+together.
 
 ## Logo and title
 

content/addons/monloader/add.webp

@@ -67,14 +67,17 @@ monsender extension can branch on them:
 | `file_too_large` | monbooru rejected the upload for size |
 | `monbooru_unreachable` | the push got no HTTP response (connect / timeout) |
 | `monbooru_rejected` | monbooru returned a 4xx/5xx other than the duplicate 200 |
-| `hash_mismatch` | a metadata refetch found the source no longer serves the file monbooru stored, so nothing was merged |
+| `hash_mismatch` | a metadata refetch returned a file that does not match the one monbooru stored, so nothing was merged; on a replace job, the downloaded file did not match the md5 the site claims, so nothing was pushed |
 | `hash_not_found` | a hash lookup found no site (or the PTR index) holding the hash |
 | `ptr_unavailable` | a PTR lookup was requested while the PTR backend is off; normally refused as a 409 when the lookup is enqueued |
+| `ptr_syncing` | a PTR lookup was requested while the index is still building; normally refused as a 409 when the lookup is enqueued |
+| `already_exists` | a replace job's downloaded file already exists in the gallery as another image; monbooru refuses the swap and records the two as a potential-duplicate pair instead |
+| `wrong_type` | a replace job aimed at an image whose row is an archive or video, which cannot be swapped this way |
 | `canceled` | the job was canceled while the item was in flight |
 
 The job's `summary` aggregates its items:
-`{ created, duplicate, enriched, skipped, failed, canceled, total }`. The
-outcomes themselves are described in
+`{ created, duplicate, enriched, replaced, skipped, failed, canceled, total }`.
+The outcomes themselves are described in
 [downloading](guides/downloading/index.md#per-item-outcomes).
 
 ## Building from source
@@ -136,5 +139,5 @@ A profile's fields:
 | `category_overrides` | per-suffix tag-category remaps baked into the profile |
 | `rating_overrides` | per-value rating remaps baked into the profile |
 | `default_rating` | rating used only when the source gives none |
-| `needs_tags` | a generic-family site that needs gallery-dl's `tags: true` to emit per-category tags (one extra request per post, e.g. sankaku) |
-| `has_notes` | a generic-family site whose extractor emits note boxes with gallery-dl's `notes: true` (e.g. sankaku); the note-carrying booru families get it by family |
+| `needs_tags` | a generic-family site that needs gallery-dl's `tags: true` to emit per-category tags (one extra request per post |
+| `has_notes` | a generic-family site whose extractor emits note boxes with gallery-dl's `notes: true`; the note-carrying booru families get it by family |

content/addons/monloader/configuration.md

@@ -40,13 +40,8 @@ override any TOML key, is in [configuration](../configuration.md).
 | Mount | Purpose |
 |---|---|
 | `/config` | Persistent: `monloader.toml`, the managed `gallery-dl.json`, the gallery-dl download archive, and cookies files. |
-| `/ptr` | Optional: the local Hydrus PTR tag index, only if you enable the PTR lookup. Expect more than 70 GB. See [Hydrus PTR](../guides/ptr/index.md). |
+| `/ptr` | Optional: the local Hydrus PTR tag index, only if you enable the PTR lookup. Expect tens of GB. See [Hydrus PTR](../guides/ptr/index.md). |
 
 monloader also uses an internal `/work` directory as scratch space for
 downloads; files are deleted from it after each successful push (it doesn't need to be mounted). If you want
 it RAM-backed, give it a `tmpfs` mount instead.
-
-## Podman
-
-A Quadlet unit ships at `docker/monloader.container` in the monloader
-repository, with the same volumes and hardening as the compose service.

content/addons/monloader/development.md

@@ -44,6 +44,17 @@ touches gallery files.
    Approving mints a scoped `monsender (paired)` token that the extension
    stores.
 
+## Pausing the link
+
+The dot in monloader's footer says whether monbooru answered; clicking it
+while it is green holds the link: monloader stops calling monbooru and no new
+download is accepted until you click the dot again. That covers
+both ways in: the add bar refuses a pasted URL, and so does the browser
+extension, which sends over the API. The pairing itself is untouched, so
+resuming needs no re-pair. monbooru's footer carries the same switch for the
+other direction. Requests coming the other way - monbooru asking for tags or a
+refetch - still work, and downloads already queued are not affected.
+
 ## Paired tokens
 
 Paired tokens appear in **Settings -> Authentication** next to any tokens