Skip to content

Commit da5f519

Browse files
committed
docs: sync b07b103b13c3
1 parent 0d8be29 commit da5f519

27 files changed

Lines changed: 355 additions & 55 deletions

File tree

.github/workflows/pages.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,12 @@ jobs:
2121
name: github-pages
2222
url: ${{ steps.deployment.outputs.page_url }}
2323
steps:
24+
# Full history: hugo's enableGitInfo dates each page from the last
25+
# commit that touched it. A shallow clone would date every page from
26+
# the newest sync commit instead.
2427
- uses: actions/checkout@v4
28+
with:
29+
fetch-depth: 0
2530
- run: ./build.sh
2631
- uses: actions/upload-pages-artifact@v3
2732
with:

build.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,12 @@ else
4343
HUGO=$BIN_DIR/hugo
4444
fi
4545

46+
# enableGitInfo dates each page from its last commit, so it needs a git
47+
# checkout; a source tarball has none, and hugo makes that a hard error.
48+
if ! git rev-parse --git-dir >/dev/null 2>&1; then
49+
echo "no git checkout, building without per-page dates"
50+
export HUGO_ENABLEGITINFO=false
51+
fi
52+
4653
"$HUGO" --gc --cleanDestinationDir
4754
echo "built into public/"

content/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ optional [addons](addons/_index.md).
2929
- Tag-based gallery with a folder tree, favorites, saved searches,
3030
collections and rating tags with an SFW ceiling. See
3131
[Searching](guides/searching/index.md) and [Tags](guides/tags/index.md).
32-
- A file watcher picks up new, moved and deleted files within seconds,
33-
and new images land in an [inbox](guides/inbox/index.md) for review.
32+
- A file watcher picks up new, moved and deleted files within
33+
seconds, and new images land in an [inbox](guides/inbox/index.md) for review.
3434
- Reads Stable Diffusion metadata (A1111/Forge and ComfyUI): prompts,
3535
models, seeds, full workflows. See [AI metadata](guides/ai-metadata.md).
3636
- Local [auto-tagging](guides/auto-tagger/index.md) with ONNX models (WD14

content/addons/_index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ browser, once monloader is in place. You are looking at a page; you
2626
press the toolbar button; the page lands in monloader's queue and,
2727
once downloaded and mapped, appears in monbooru with its tags.
2828

29+
**[Plugins](plugins.md)** are the open version of the same idea:
30+
anything you or someone else writes, showing up as a few buttons in monbooru.
31+
2932
The apps connect by [pairing](pairing.md): each link is approved once
3033
in the receiving app's settings, and the apps exchange scoped API
3134
tokens on their own. The [quick start](quick-start.md) walks through

content/addons/monloader/configuration.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,9 @@ fetch_sleep = 1.0
6060
min_free_gb = 70
6161
commit_sleep = 1.0 # seconds between contribution uploads
6262

63-
[lookup] # the lookup chain's similarity stage
64-
min_similarity = 80 # percent; candidates below are ignored
63+
[lookup] # the chain's similarity stage, and what the nightly run may spend
64+
min_similarity = 80 # percent; candidates below are ignored
65+
scheduled_daily_budget = 25 # images a day monbooru's scheduled lookups may cover; 0 refuses them
6566

6667
[lookup.iqdb]
6768
order = 2 # chain position; uses the danbooru site credentials

content/addons/monloader/development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ monsender extension can branch on them:
7676
| `canceled` | the job was canceled while the item was in flight |
7777

7878
The job's `summary` aggregates its items:
79-
`{ created, duplicate, enriched, replaced, skipped, failed, canceled, total }`.
79+
`{ created, duplicate, enriched, matched, replaced, skipped, failed, canceled, total }`.
8080
The outcomes themselves are described in
8181
[downloading](guides/downloading/index.md#per-item-outcomes).
8282

content/addons/monloader/getting-started/pairing/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,10 @@ instead.
6262

6363
## Re-pairing
6464

65-
A peer that is already paired is refused until its pairing is removed.
66-
Removing a pairing (on either side) drops the local token and asks the peer
67-
to drop its own; if the peer was unreachable at that moment, a notice
68-
reminds you to remove it there too. monloader keeps the configured monbooru
69-
api url, so a re-pair reuses it.
65+
Removing a pairing (on either side) drops the local
66+
token and asks the peer to drop its own; if the peer was unreachable at that
67+
moment, a notice reminds you to remove it there too. monloader keeps the
68+
configured monbooru api url, so a re-pair reuses it.
7069

7170
## Manual setup
7271

content/addons/monloader/guides/downloading/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,14 @@ anything.
2828

2929
## Per-item outcomes
3030

31-
Every item ends with one of seven outcomes:
31+
Every item ends with one of eight outcomes:
3232

3333
| Outcome | Meaning |
3434
|---|---|
3535
| `created` | new image accepted by monbooru |
3636
| `duplicate` | monbooru already had this exact file; any new tags merge in |
3737
| `enriched` | a metadata-only refetch or a hash lookup merged tags into an image monbooru already holds |
38+
| `matched` | a batch PTR lookup answered with an image's tags; monloader wrote nothing, monbooru applies them |
3839
| `replaced` | the post's file was pushed over an existing image's, keeping its tags and history - this is monbooru's **[upgrade]** action doing its work through monloader (see [Lookup and sources](../../../../guides/lookup/index.md)) |
3940
| `skipped_archive` | this post was already fetched before; not downloaded again |
4041
| `skipped_unsupported` | monbooru cannot ingest this file type; not pushed |

content/addons/monloader/guides/lookup/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,3 +99,16 @@ With the [Hydrus PTR index](../ptr/index.md) enabled, monloader can also answer
9999
its local sha256-keyed copy of the PTR (offline, and covering files that
100100
were deleted from the boorus or never posted there). monbooru drives it
101101
per image (the PTR panel's **Pull tags**) or in batch.
102+
103+
## Scheduled lookups from monbooru
104+
105+
monbooru's nightly maintenance run can send lookups for the images that
106+
have no source, and monloader is what bounds them: the daily budget in
107+
**settings -> lookup**. Those lookups queue behind everything else, so a whole library sweeping
108+
overnight never delays a URL you paste while it runs.
109+
110+
The budget is how many images a night they may cover, 25 out of the
111+
box. Once the budget is spent monloader refuses the rest and monbooru stops for the day,
112+
picking up where it left off tomorrow.
113+
Lookups you trigger by hand from monbooru - the detail-page button, the
114+
batch action, are never counted against it and never refused.
110 KB
Loading

0 commit comments

Comments
 (0)